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 — Enable suppression of PSAvoidAssignmentToAutomaticVariable for specific variable or parameter by fflaten · Pull Request #1896 · PowerShell/PSScriptAnalyzer

Conversation

@fflaten

@fflaten Frode Flaten (fflaten) commented Feb 27, 2023 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

PR Summary

Enables suppression for specific variable/parameter with rule PSAvoidAssignmentToAutomaticVariable.
Fix #1589

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.
All reactions
@fflaten
add ruleId to PSAvoidAssignmentToAutomaticVariable
31926f0 
Enables suppression for specific variable/parameter.
Fix PowerShell#1589
@fflaten Frode Flaten (fflaten) mentioned this pull request Feb 27, 2023
Rename TestCases parameter to ForEach pester/Pester#2311
Merged
4 of 5 tasks
bergmeister
Christoph Bergmeister (bergmeister) reviewed Feb 28, 2023
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.

Awesome, thanks for improving it, change looks good to me, can you please add one test case for it though?
If possible a test case for each line that was changed, that can return a diagnostic record, but I can understand if that is too much for you, therefore consider this optional.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@fflaten

Frode Flaten (fflaten) commented Feb 28, 2023

Copy link
Copy Markdown
Contributor Author

Intentionally skipped it because suppression was only tested in a general test and not per rule.

Can try to add some later today if you want.
bergmeister and ALiwoto reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@fflaten
add tests
7612ed5
fflaten
Frode Flaten (fflaten) commented Feb 28, 2023
View reviewed changes
Comment thread Tests/Rules/AvoidAssignmentToAutomaticVariable.tests.ps1
$testCases_ReadOnlyAutomaticVariables = $testCases_AutomaticVariables | Where-Object { $_.IsReadonly }

It "Variable <VariableName> produces warning of Severity <ExpectedSeverity>" -TestCases $testCases_AutomaticVariables {
param ($VariableName, $ExpectedSeverity)

@fflaten Frode Flaten (fflaten) Feb 28, 2023 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor Author

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.

Tip: Param-blocks are no longer needed in Pester v5. Some keep them to make the testcase-contract visible so didn't remove them :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
fflaten
Frode Flaten (fflaten) commented Feb 28, 2023
View reviewed changes
Comment thread Tests/Rules/AvoidAssignmentToAutomaticVariable.tests.ps1

Describe "AvoidAssignmentToAutomaticVariables" {
Context "ReadOnly Variables" {
BeforeDiscovery {

@fflaten Frode Flaten (fflaten) Feb 28, 2023

Copy link
Copy Markdown
Contributor Author

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.

Added per best practice in Pester v5. Only cosmetic and more explicit in this case.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@fflaten

Frode Flaten (fflaten) commented Mar 16, 2023 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor Author

In case it didn't show up - ready for review again 🙂
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@fflaten
Frode Flaten (fflaten) requested a review from Christoph Bergmeister (bergmeister) May 27, 2023 17:08
@fflaten Frode Flaten (fflaten) mentioned this pull request Aug 11, 2023
Allow suppression of PSUseSingularNouns for specific function #1903
Merged
6 tasks done
JamesWTruher
James Truher (JamesWTruher) approved these changes Aug 21, 2023
View reviewed changes

@JamesWTruher James Truher (JamesWTruher) left a comment

Copy link
Copy Markdown
Contributor

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.

This is great - thank you.
Christoph Bergmeister (@bergmeister)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
fflaten reacted with hooray emoji
All reactions
  • 🎉 1 reaction
bergmeister
Christoph Bergmeister (bergmeister) approved these changes Sep 17, 2023
View reviewed changes
@bergmeister Christoph Bergmeister (bergmeister) added the Area - Rules label Sep 17, 2023
@bergmeister
Christoph Bergmeister (bergmeister) merged commit 40be593 into PowerShell:master Sep 17, 2023
@fflaten
Frode Flaten (fflaten) deleted the autovariable-ruleid branch September 17, 2023 18:40
This was referenced Mar 16, 2024
Update PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#1
Closed
Update PSScriptAnalyzer to v1.22.0 intellij-powershell/intellij-powershell#244
Merged
Update PowerShellEditorServices to v3.18.1 and PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#2
Closed
@coderabbitai coderabbitai Bot mentioned this pull request Apr 26, 2026
Added Nuke Build Project VolkmarR/Nuke-Cake#2
Merged
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
@JamesWTruher James Truher (JamesWTruher) JamesWTruher 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

Area - Rules

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Cannot Suppress Messages About a Specific Automatic Variable

Uh oh!

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

3 participants

@fflaten @bergmeister @JamesWTruher
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.