Add PSAvoidAssignmentToAutomaticVariable to the default set of PSSA rules #1101
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
TylerLeonhardt
approved these changes
Nov 12, 2019
|
This is a good rule to have enabled by default. Thanks. |
|
Kudos to @mklement0 for proposing it originally. I had the intent of doing it when I did the rule but forgot it in the long process of the PSSA release and the extension using a new release... |
|
Thanks, @bergmeister; also worth mentioning that enhancements to this rule are coming, so as to also cover automatic variables that are technically writeable but shouldn't be; in case someone wants to help review the proposed change: see PowerShell/PSScriptAnalyzer#712 (comment) |
|
@bergmeister the bar is super high with backporting since the Preview will be stable in Jan. However, can you backport it? |
bergmeister
pushed a commit
to bergmeister/PowerShellEditorServices
that referenced
this pull request
Nov 13, 2019
… to the default set of PSSA rules
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.
See docs below for info. The rule warns only on read-only, automatic variables where assignment would cause an error to be thrown at runtime, therefore there is no scope for false positives.
https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidAssignmentToAutomaticVariable.md
Example of what would happen at runtime in the console if one ignored such a violation:
We should back-port this change