GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals variables by John-Leitch · Pull Request #2013 · PowerShell/PSScriptAnalyzer

Conversation

@John-Leitch

@John-Leitch John Douglas Leitch (John-Leitch) commented Jul 11, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

liamjpeters reacted with hooray emoji
All reactions
  • 🎉 1 reaction
John Douglas Leitch (John-Leitch) added 2 commits July 10, 2024 22:47
@John-Leitch
Fixed erroneous PSUseDeclaredVarsMoreThanAssignments for some globals.
bdabcb0
@John-Leitch
Added unit tests to cover global bug in UseDeclaredVarsMoreThanAssign…
7d0530a
…ments.
@liamjpeters

Liam Peters (liamjpeters) commented Jul 11, 2024

Copy link
Copy Markdown
Contributor

Really clear explanation, thanks for getting to the root of the issue! 🙂 LGTM!

John-Leitch reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bergmeister
Merge branch 'main' into master
bd78fc2
@bergmeister
Christoph Bergmeister (bergmeister) requested review from Andy Jordan (andyleejordan) and Christoph Bergmeister (bergmeister) as code owners February 17, 2025 20:53
bergmeister
Christoph Bergmeister (bergmeister) approved these changes Feb 17, 2025
View reviewed changes

@bergmeister Christoph Bergmeister (bergmeister) left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Uh oh!

There was an error while loading. Please reload this page.

John-Leitch reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@andyleejordan
Andy Jordan (andyleejordan) enabled auto-merge (squash) February 18, 2025 19:00
@andyleejordan

Andy Jordan (andyleejordan) commented Feb 18, 2025

Copy link
Copy Markdown
Member

Nice fix!

John-Leitch reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

andyleejordan
Andy Jordan (andyleejordan) approved these changes Feb 18, 2025
View reviewed changes
@John-Leitch
Merge branch 'main' into master
a0aad64
@andyleejordan
Andy Jordan (andyleejordan) disabled auto-merge February 20, 2025 22:27
@andyleejordan
Andy Jordan (andyleejordan) merged commit 3a91195 into PowerShell:main Feb 20, 2025
Rob Holt (rjmholt) added a commit to rjmholt/PSScriptAnalyzer that referenced this pull request Feb 23, 2026
@rjmholt @cursoragent
Port remaining upstream bug fixes for two rules
edd5247
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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister Christoph Bergmeister (bergmeister) bergmeister approved these changes
+1 more reviewer
@andyleejordan Andy Jordan (andyleejordan) andyleejordan approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@John-Leitch @liamjpeters @andyleejordan @bergmeister
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.