feat(eslint-plugin-template): add rule prefer-contextual-for-variables #2311
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
|
View your CI Pipeline Execution ↗ for commit 7ec5652.
☁️ Nx Cloud last updated this comment at |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2311 +/- ##
==========================================
+ Coverage 92.36% 92.53% +0.17%
==========================================
Files 181 184 +3
Lines 3377 3724 +347
Branches 689 835 +146
==========================================
+ Hits 3119 3446 +327
- Misses 200 215 +15
- Partials 58 63 +5
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
This was referenced Mar 10, 2025
JamesHenry
previously approved these changes
Mar 22, 2025
|
I pulled in latest main but looks like it still needs a docs update |
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.
Closes #2203
When using the
@forcontrol flow statement, some contextual variables can be accessed within the block without aliasing them.See Contextual variables in @for blocks for details.
This new rule will report any contextual variables in
@forstatements that are aliased. An option can be provided for each contextual variable to allow specific aliases to be allowed. For example,{ allowedAliases: { $index: ['i'] } }would allowito be used as an alias for$index. The fixer will remove the alias and also rename any references to the aliased variables.The only scenario where aliases are kept is when there are nested
@forblocks. This allows, for example, the outer$indexand inner$indexto be aliased to provide more meaningful names.The rule will also detect expressions where a different contextual variable can be used. For example
$index === 0can be replaced with$first,$index === $count - 1can be replaced with$last, etc. This also has a fixer.This depends on: