Use a customized rule (PowerShell script) with PSScriptAnalyzer ?

[LaurentDardenne]

Is it possible to use a customized rule (PowerShell script) with PSScriptAnalyzer and VsCode ?
Or is it preferable to use rules written in C# ?

[rkeithhill]

At this point in time, the extension doesn't allow you to specify a path for -CustomRulePath which is how you'd supply your custom rules to Invoke-ScriptAnalyzer. Ditto for -RecurseCustomRulePath. It would be nice if this could be specified in the settings file but right now that only accepts the keys: ExcludeRules, IncludeRules and Severity.

[daviwil]

@kapilmb is working on a new way for PSScriptAnalyzer to load settings which should support all of the parameters Invoke-ScriptAnalyzer can take. Hopefully we'll have that in for 0.8.0!

[daviwil]

Hey @kapilmb, is it possible to include a custom script-based rule using the new settings file work you did? Do you have an example of that somewhere?

[kapilmb]

As of now, PSSA settings file does not support have the CustomRulePath field. However, after its inclusion in PSSA settings file, VSCode should be able to run custom rules. I will create a issuse PSSA repo to track this issue.

[kapilmb]

here is the issue PowerShell/PSScriptAnalyzer#675

[bergmeister]

@LaurentDardenne You can specify CustomRules in the settings file and in my comment here I explain how it integrates with other parameters. Currently everything seems to be working, it just isn't very intuitive or well documented.

[LaurentDardenne]

@bergmeister Thank you :-)
I try this with VSCode.

[LaurentDardenne]

It works with this prototype :

In the file ''C:\Users\Laurent\AppData\Roaming\Code\User\settings.json'' I changed the entry "powershell.scriptAnalysis.settingsPath":".//ScriptAnalyzerSettings.psd1"
I still have a doubt about the location of this parameter file with regard to the files opened in VSCode.

I test again before closing.

[LaurentDardenne]

We can use the global or local configuration file (settings.json) of the project (Workspace) but once declared the global file, the local file is not taken into account.
This seems exclusive.