FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Enable suppression of PSAvoidAssignmentToAutomaticVariable for specific variable or parameter by fflaten · Pull Request #1896 · PowerShell/PSScriptAnalyzer · GitHub

/ PSScriptAnalyzer Public

Enable suppression of PSAvoidAssignmentToAutomaticVariable for specific variable or parameter - #1896

Merged
Christoph Bergmeister (bergmeister) merged 2 commits into
PowerShell:masterfrom
fflaten:autovariable-ruleid
Sep 17, 2023
ConversationCommits (2)ChecksFiles changed
Merged

Enable suppression of PSAvoidAssignmentToAutomaticVariable for specific variable or parameter#1896
Christoph Bergmeister (bergmeister) merged 2 commits into
PowerShell:masterfrom
fflaten:autovariable-ruleid

Conversation

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

Copy link
Copy Markdown
Contributor

PR Summary

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

PR Checklist

add ruleId to PSAvoidAssignmentToAutomaticVariable
31926f0 
Enables suppression for specific variable/parameter.
Fix PowerShell#1589
Frode Flaten (fflaten) mentioned this pull request Feb 27, 2023
Merged
5 tasks
Christoph Bergmeister (bergmeister) reviewed Feb 28, 2023
View reviewed changes

Christoph Bergmeister (bergmeister) left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

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.

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)

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Frode Flaten (fflaten) commented Feb 28, 2023
View reviewed changes
Comment thread Tests/Rules/AvoidAssignmentToAutomaticVariable.tests.ps1

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

Frode Flaten (fflaten) Feb 28, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

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

Copy link
Copy Markdown
Contributor Author

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

Frode Flaten (fflaten) mentioned this pull request Aug 11, 2023
Merged
6 tasks
James Truher (JamesWTruher) approved these changes Aug 21, 2023
View reviewed changes

James Truher (JamesWTruher) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Christoph Bergmeister (bergmeister) merged commit 40be593 into PowerShell:master Sep 17, 2023
Frode Flaten (fflaten) deleted the autovariable-ruleid branch September 17, 2023 18:40
This was referenced Mar 16, 2024
Closed
Merged
Closed
coderabbitai Bot mentioned this pull request Apr 26, 2026
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Christoph Bergmeister (bergmeister) bergmeister approved these changes
+1 more reviewer
James Truher (JamesWTruher) JamesWTruher approved these changes
Reviewers whose approvals may not affect merge requirements

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

3 participants

Back | FazBrowse Home | New Git URL