Warn against assignment to read-only automatic variables #864
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
bergmeister
changed the title
bergmeister
changed the title
JamesWTruher
suggested changes
Feb 6, 2018
|
|
||
| ## Description | ||
|
|
||
| `PowerShell` exposes some of its build in variables that are known as automatic variables. Many of them are read-only and PowerShell would throw an error when trying to assign an value on those. The remaining automatic variables should only be assigned to in certain special cases to achieve a certain effect as a special technique. |
There was a problem hiding this comment.
built-in rather than "build in"
"the remaining" would probably be better as other
| It "Variable '<VariableName>' produces warning of severity error" -TestCases $testCases_ReadOnlyVariables { | ||
| param ($VariableName) | ||
|
|
||
| $warnings = Invoke-ScriptAnalyzer -ScriptDefinition "`$$($VariableName) = 'foo'" | Where-Object { $_.RuleName -eq $ruleName } |
There was a problem hiding this comment.
the $(...) isn't needed
"`$${VariableName} = 'foo'"
will work just fine
| It "Using Variable '<VariableName>' as parameter name in param block produces warning of severity error" -TestCases $testCases_ReadOnlyVariables { | ||
| param ($VariableName) | ||
|
|
||
| [System.Array] $warnings = Invoke-ScriptAnalyzer -ScriptDefinition "function foo{Param(`$$VariableName)}" | Where-Object {$_.RuleName -eq $ruleName } |
There was a problem hiding this comment.
this looks to be the same as line 36
|
One remark about the texte of the erreur message : |
…nalyzer into WarnAgainstAssignmentToAutomaticVariables # Conflicts: # Rules/Strings.resx
|
Thanks for the feedback, I addressed your comments. |
JamesWTruher
approved these changes
Feb 7, 2018
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.
This is the first of a series of PRs to address issues #858 and #712
Because the analysis of automatic variables is quite complex and in certain cases assignment to automatic variables can be by design, the list of 'naughty' variable assignments is going to be opinionated.
Therefore I decided to start with the read-only variables first where PowerShell will throw an error if assignment or usage as function parameter is attempted.
Note that I still have to look into the other tests that started failing.