It's frustrating that there's no automatic relationship between the rules in the output of Get-ScriptAnalzyerRule -CustomRulePath and Invoke-ScriptAnalyzer ...
Specifically, the -ExcludeRule of Invoke-ScriptAnalyzer has to match the custom rule function name (without the module on the front).
But the name you have to put in SuppressMessageAttribute has to match the RuleName which is set on the output of the function, so if you use RuleName = $PSCmdlet.MyInvocation.InvocationName then you must use the module-qualified rule name, and if you use RuleName = $PSCmdlet.MyInvocation.MyCommand.Name then you must not ...
But the coup-de-grace, if you Invoke-ScriptAnalyzer with -IncludeDefaultRules then you can't use names in SuppressMessageAttribute which are not module-qualified except for the default rules.
There is just no way to make it work
There's no combination where I can consistently use the same name for -ExcludeRule and SuppressMessageAttribute
This is a problem. It makes sense for these to be module-qualified, and calculated by PSScriptAnalyzer, not the rule author. I think ScriptAnalyzer should require the rule function names to use the Measure verb, and then use the noun as the rule name -- and ignore/overwrite the output value.
That way you can guarantee that the rule name will always be what you expect it to be. Then, the -ExcludeRule parameter and Get-ScriptAnalyzerRule need to be updated to return the same value too.
Severity is wrong too
Currently all Custom rules are shown as "Warning" severity in the output of Get-ScriptAnalyzerRule but (can) have different severity when the rule is actually triggered (actually, they can assign a severity based on logic in the rule).
We should add an attribute to allow authors to specify the (default?) severity of the rule that would be reported by Get-ScriptAnalyzerRule (and we should use that severity by default, allowing rule authors to skip setting the RuleName, Severity, and RuleSuppressionId and have them correctly populated in the output).
It's frustrating that there's no automatic relationship between the rules in the output of
Get-ScriptAnalzyerRule -CustomRulePathandInvoke-ScriptAnalyzer ...Specifically, the
-ExcludeRuleofInvoke-ScriptAnalyzerhas to match the custom rule function name (without the module on the front).But the name you have to put in
SuppressMessageAttributehas to match theRuleNamewhich is set on the output of the function, so if you useRuleName = $PSCmdlet.MyInvocation.InvocationNamethen you must use the module-qualified rule name, and if you useRuleName = $PSCmdlet.MyInvocation.MyCommand.Namethen you must not ...But the coup-de-grace, if you
Invoke-ScriptAnalyzerwith-IncludeDefaultRulesthen you can't use names in SuppressMessageAttribute which are not module-qualified except for the default rules.There is just no way to make it work
There's no combination where I can consistently use the same name for
-ExcludeRuleandSuppressMessageAttributeThis is a problem. It makes sense for these to be module-qualified, and calculated by PSScriptAnalyzer, not the rule author. I think ScriptAnalyzer should require the rule function names to use the
Measureverb, and then use the noun as the rule name -- and ignore/overwrite the output value.That way you can guarantee that the rule name will always be what you expect it to be. Then, the
-ExcludeRuleparameter andGet-ScriptAnalyzerRuleneed to be updated to return the same value too.Severity is wrong too
Currently all Custom rules are shown as "Warning" severity in the output of
Get-ScriptAnalyzerRulebut (can) have different severity when the rule is actually triggered (actually, they can assign a severity based on logic in the rule).We should add an attribute to allow authors to specify the (default?) severity of the rule that would be reported by
Get-ScriptAnalyzerRule(and we should use that severity by default, allowing rule authors to skip setting the RuleName, Severity, and RuleSuppressionId and have them correctly populated in the output).