Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals variables - #2013
Merged
Andy Jordan (andyleejordan) merged 4 commits intoFeb 20, 2025
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
Really clear explanation, thanks for getting to the root of the issue! 🙂 LGTM! |
Sorry, something went wrong.
Christoph Bergmeister (bergmeister)
requested review from
Andy Jordan (andyleejordan) and
Christoph Bergmeister (bergmeister)
as code owners
February 17, 2025 20:53
Christoph Bergmeister (bergmeister)
approved these changes
Feb 17, 2025
Copy link
Copy Markdown
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 Andy Jordan (@andyleejordan) is ok as well?
Sorry, something went wrong.
Andy Jordan (andyleejordan)
enabled auto-merge (squash)
February 18, 2025 19:00
Copy link
Copy Markdown
Member
|
Nice fix! |
Sorry, something went wrong.
Andy Jordan (andyleejordan)
approved these changes
Feb 18, 2025
Andy Jordan (andyleejordan)
disabled auto-merge
February 20, 2025 22:27
Rob Holt (rjmholt)
added a commit
to rjmholt/PSScriptAnalyzer
that referenced
this pull request
Feb 23, 2026
UseDeclaredVarsMoreThanAssignments (PowerShell#2013): skip scope-qualified variable references ($global:, $script:, drive-qualified) when checking for uses of local variables, preventing false negatives. AvoidPositionalParameters (PowerShell#1850): skip commands that have no parameters in the database (e.g. native CLI tools like az). Co-authored-by: Cursor <cursoragent@cursor.com>
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
Reviewers
4 participants
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 an Ast to key into VariableAnalysisDictionary, calling VariableAnalysis.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 returning false. Fortunately, VariableAnalysis.IsGlobalOrEnvironment depends on no instance members, instead relying solely on the properties of VariableExpressionAst, which is passed in. As such, VariableAnalysis.IsGlobalOrEnvironment can be made static with no consequence, allowing Helper.IsVariableGlobalOrEnvironment to call the method without the dictionary operations.
Also of note, the current implementation is somewhat redundant, with UseDeclaredVarsMoreThanAssignments.AnalyzeScriptBlockAst checking VariablePath.DriveName separately, which is why the issue does not affect environment variables despite VariableAnalysis.IsGlobalOrEnvironment erroneously returning false in some cases.
PR Checklist