Repository navigation
PSAvoidAssignmentToAutomaticVariable Errors on validateset #1970
Description
I have been getting errors on validateset because PSScriptAnalyzer is confusing the validateset as assignment.
An example of this happening is
[validateset($True, $False)]
[bool]$UnfurlLinks,
[validateset($True, $False)]
[bool]$UnfurlMedia,
from https://github.com/RamblingCookieMonster/PSSlack/blob/master/PSSlack/Public/New-SlackMessage.ps1
Activity
liamjpeters commentedon Mar 27, 2024
This is a strange one.
Ultimately
ValidateSetonly accepts a string array of valid values, so I guess it's going to cast$Trueand$Falsetostringand be left with'True'and'False'.That's why, in the terminal, when I use the parameter completion that
ValidateSetfacilitates, I get the string options (not$trueor$false):But accepting the suggestions, the function errors:
Which makes me think the function needs some work if it's using
ValidateSetto ensure that a declaredBooleanvalue is either true or false 🤔.That all said, you're correct and it's not assignment. The rule is probably checking all parameters for any variable expressions and alerting if a reserved name is used.
I'll take a look at this.
JamesWTruher commentedon Mar 27, 2024
it's not that
$trueand$falseare being converted to a string. It's that they are constants from powershell's perspective, so they don't cause a parsing error. For example, if you use$HOME, you wouldn't get past the parsing stage since$HOMEis not a constant from PowerShell's perspective. There are a very small set of variables which PowerShell considers constant.This attribute is really looking for a set of constant strings
liamjpeters commentedon Mar 28, 2024
Thanks for the explanation James Truher (@JamesWTruher). Makes sense!
bergmeister commentedon Apr 9, 2024
Thanks for raising this and opening PR, will review