feat(eslint-plugin): [require-localize-metadata] add requireCustomId option #2430
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…dation Added two more options to report errors if: - Custom ID is not present - Custom ID is present but it doesn't follow the allowed pattern - Default value is not provided Change in details: - Added new configuration options and error messages for reporting. - Create and use a `validate` function that receives the input string and a type to validate optionally it can receive a pattern to validate custom id. - The core of the `validate` function is a regular expression with named group, I have followed how Angular manages metadata when using `$localize` - Added new valid and invalid tests cases to cover the changes. New config after changes: - Added `requireCustomId` - `boolean` - default is `false` - Added `requireDefaultValue` - `boolean` - default is `false` - Added `boundTextAllowedPattern` - `string` - No default value. It expects to get a string that can be converted to regular expression to test custom id. I have used the same name that already exists in `@angular-eslint/template-parser`.
163679a to
a1dce40
Compare
|
View your CI Pipeline Execution ↗ for commit acb1795.
☁️ Nx Cloud last updated this comment at |
2ca088b to
da06715
Compare
packages/eslint-plugin/tests/rules/require-localize-metadata/cases.ts
Outdated
Show resolved
Hide resolved
da06715 to
e570d0f
Compare
|
@tcorral how do you feel about this approach as an alternative? |
|
@igord CI not passing yet |
@JamesHenry It looks good to me. |
JamesHenry
approved these changes
Jun 1, 2025
JamesHenry
requested changes
Jun 1, 2025
ee9f8b9 to
a1dce40
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2430 +/- ##
==========================================
+ Coverage 92.85% 92.86% +0.01%
==========================================
Files 200 200
Lines 4169 4203 +34
Branches 973 984 +11
==========================================
+ Hits 3871 3903 +32
- Misses 229 231 +2
Partials 69 69
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to #2186, this PR adds one new rule
requireCustomIdthat can be enabled:trueorcustom_idvalidationIt also refactors
$localizemetadata parsing to be closer to the way that@angular/localizedoes it