Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals variables#2013
Merged
andyleejordan merged 4 commits intoPowerShell:mainfrom Feb 20, 2025
Merged
Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals variables#2013andyleejordan merged 4 commits intoPowerShell:mainfrom
andyleejordan merged 4 commits intoPowerShell:mainfrom
Conversation
Contributor
|
Really clear explanation, thanks for getting to the root of the issue! 🙂 LGTM! |
bergmeister
approved these changes
Feb 17, 2025
Collaborator
There was a problem hiding this comment.
Looks good. Sorry for late review. Updated branch from main since CI is now on GitHub Actions. If it passed, happy to merge if @andyleejordan is ok as well?
Member
|
Nice fix! |
andyleejordan
approved these changes
Feb 18, 2025
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
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.
PR Summary
This PR fixes the following longstanding issue: #1300 (Global variables are erroneously reported as "never used")
The issue exists because
Helper.IsVariableGlobalOrEnvironmentuses anAstto key intoVariableAnalysisDictionary, callingVariableAnalysis.IsGlobalOrEnvironmenton 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.IsGlobalOrEnvironmentdepends on no instance members, instead relying solely on the properties ofVariableExpressionAst, which is passed in. As such,VariableAnalysis.IsGlobalOrEnvironmentcan be madestaticwith no consequence, allowingHelper.IsVariableGlobalOrEnvironmentto call the method without the dictionary operations.Also of note, the current implementation is somewhat redundant, with
UseDeclaredVarsMoreThanAssignments.AnalyzeScriptBlockAstcheckingVariablePath.DriveNameseparately, which is why the issue does not affect environment variables despiteVariableAnalysis.IsGlobalOrEnvironmenterroneously returningfalsein some cases.PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.