Missing Documentation about Rules

[TBobsin]

Prerequisites

• Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
• Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new Get-Foo cmdlet" instead of "New cmdlet."

Module

PSScriptAnalyzer

Summary

Missing Description of PSUseDeclaredVarsMoreThanAssignments rules in PSScriptAnalyzerSettings.ps1.

I have tried to exclude one VarName from being marked.

Details

You could define Settings in PSScriptAnalyzerSettings.ps1

i tried to set an rule to exclude one Var but mark all other Var
but that is not working. And i found no description about PSUseDeclaredVarsMoreThanAssignments
This is what i have tried:

Rules = @{
    PSUseDeclaredVarsMoreThanAssignments = @(
        Whitelist = @('CMK_VERSION')
    )
}

Content Type

How-to

Proposed Title

PSUseDeclaredVarsMoreThanAssignments Rules

Related Articles

No response

[michaeltlombardi]

Thanks for filing this issue, @TBobsin!

If you're looking for the documentation for the rule, that's UseDeclaredVarsMoreThanAssignments. The documentation for suppressing rules is in the "Suppressing Rules" section of the Using PSScriptAnalyzer article.

Unfortunately, there's no way to suppress the UseDeclaredVarsMoreThanAssignments rule for a single variable. You can suppress the rule for a scriptblock or function with the snippet:

[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
    <#Rule ID#>  'PSUseDeclaredVarsMoreThanAssignments',
    <#Check ID#> $null,
    Justification = 'Reason for suppressing'
)]

Although the constructor for SuppressMessageAttribute includes a check ID, it's not used by the UseDeclaredVarsMoreThanAssignments rule in PSSA.

The following issues in the PSSA repository relate to this limitation:

• PSScriptAnalyzer doesn't seem to be using the SuppressMessageAttribute ctor fields as intended. PowerShell/PSScriptAnalyzer#276
• Improved rule suppression PowerShell/PSScriptAnalyzer#1483
• [Meta issue] PSUseDeclaredVarsMoreThanAssignments presents false positives PowerShell/PSScriptAnalyzer#1641