Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals variables #2013
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.
PR Summary
This PR fixes the following longstanding issue: #1300 (Global variables are erroneously reported as "never used")
The issue exists because
Helper.IsVariableGlobalOrEnvironment
uses anAst
to key intoVariableAnalysisDictionary
, callingVariableAnalysis.IsGlobalOrEnvironment
on the value returned to determine whether or not the variable is a global. However, in some cases, the key does not exist in the dictionary, resulting in the method returningfalse
. Fortunately,VariableAnalysis.IsGlobalOrEnvironment
depends on no instance members, instead relying solely on the properties ofVariableExpressionAst
, which is passed in. As such,VariableAnalysis.IsGlobalOrEnvironment
can be madestatic
with no consequence, allowingHelper.IsVariableGlobalOrEnvironment
to call the method without the dictionary operations.Also of note, the current implementation is somewhat redundant, with
UseDeclaredVarsMoreThanAssignments.AnalyzeScriptBlockAst
checkingVariablePath.DriveName
separately, which is why the issue does not affect environment variables despiteVariableAnalysis.IsGlobalOrEnvironment
erroneously returningfalse
in some cases.PR Checklist
.cs
,.ps1
and.psm1
files have the correct copyright headerWIP:
to the beginning of the title and remove the prefix when the PR is ready.