New Universal.CodeAnalysis.ForeachUniqueAssignment sniff
#110
Conversation
This file contains 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
Inspired by a tweet from dseguy, this new sniff will detect foreach control structures which use the same variable for both the _key_ as well as the _value_ assignment as this will lead to unexpected - and most likely unintended - behaviour. The sniff includes a fixer which will remove the key assignment when the issue is detected as the value is required and the key optional. The fixer maintains the existing behaviour for the code, though that behaviour may not be the desired behaviour, so any autogenerated fixes should be carefully reviewed (as always). Refs: * https://twitter.com/exakat/status/1509103728934203397 * https://3v4l.org/DdddX Includes fixer. Includes unit tests. Includes documentation.
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.
Inspired by a tweet from @dseguy, this new sniff will detect
foreachcontrol structures which use the same variable for both the key as well as the value assignment as this will lead to unexpected - and most likely unintended - behaviour.The sniff includes a fixer which will remove the key assignment when the issue is detected as the value is required and the key optional.
The fixer maintains the existing behaviour for the code, though that behaviour may not be the desired behaviour, so any autogenerated fixes should be carefully reviewed (as always).
Refs:
Includes fixer.
Includes unit tests.
Includes documentation.