PSScriptAnalyzer rule documentation files should be named consistently with the rules

[andrewducker]

I'n using PSScriptAnalyzer from inside VSCode, and there doesn't seem to be any documentation of what each rule does, which makes it very hard to decide whether to enable one or not.

Is there a page somewhere which tells me what (for instance) PSAvoidShouldContinueWithoutForce means, so that I can make an informed decision whether to enable that rule?

[daviwil]

The rule documentation files are here, just look for the filename without the PS prefix:

https://github.com/PowerShell/PSScriptAnalyzer/tree/development/RuleDocumentation

[andrewducker]

Interesting. The documentation there doesn't cover PSAvoidShouldContinueWithoutForce or AvoidUsingCmdletAliases - both of which are in the VSCode addon (v0.10.1)

Is there some renaming going on between VSCode and PSScriptAnalyzer? Or is VSCode just running behind on the version of PSScriptAnalyzer it uses?

[daviwil]

I think the documentation could be a little out of date, the PowerShell extension is using 1.11.0 of PSScriptAnalyzer. The AvoidUsingCmdletAliases documentation is here:

https://github.com/PowerShell/PSScriptAnalyzer/blob/development/RuleDocumentation/AvoidAlias.md

The PSAvoidShouldContinueWithoutForce is here, but it's named without the PS:

https://github.com/PowerShell/PSScriptAnalyzer/blob/development/RuleDocumentation/AvoidShouldContinueWithoutForce.md

We definitely need to do a review to make sure the documentation naming is correct.

[juneb]

This is a dup of #729.

[kapilmb]

Fixed in #742