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

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

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.

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.

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.

		$testCases_ReadOnlyAutomaticVariables = $testCases_AutomaticVariables \| Where-Object { $_.IsReadonly }

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

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 :)


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

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.

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

Choose a reason for hiding this comment

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

fflaten deleted the autovariable-ruleid branch

September 17, 2023 18:40

This was referenced

Mar 16, 2024