VS Code - PSScriptAnalyzer Highlighting

[Mcgurk125]

Hi all,

I am in the process of writing up custom rules to invoke my company style guide. To begin with I have written a simple function that appears to work correctly when running Invoke-ScriptAnalyzer, returning a Diagnostic Record[].

Does anyone have a guide on implementing custom rules in VSCode? Ideally it will automatically highlight code that does not conform to both the built in script analyzer rules and the custom ones defined.

I have attempted to update the PSScriptAnalyzerSettings.psd1 (and ensured powershell.scriptAnalysis.settingsPath points to that file) with the following:

@{
    # I have changed the path below for privacy 
    CustomRulePath="\\mydomain\blah\blah\blah\blah\blah\PowershellScriptAnalyzer"
    IncludeDefaultRules=$true
    RecurseCustomRulePath = $true
    ExcludeRules = @(
        'PSAvoidUsingWriteHost',
        'PSUseShouldProcessForStateChangingFunctions',
        'PSUseOutputTypeCorrectly'
    )
}

Any ideas?

Thanks!

[bergmeister]

@Mcgurk125 I think your approach is correct, that's what I would have done as well. It's probably more an issue for the vscode-powershell (which manages the settings) or the PowerShellEditorServices (which calls PSSA and is probably the culprit) repo but I will take a look at it this evening before we open an issue in one of those repos.

[bergmeister]

@Mcgurk125 Settings are sometimes a bit tricky and I plan to write a blog post about it. In the meantime, I created you an example project here that you can take as a simple example, I guess it is maybe just a detail that you are missing in your custom setup.
https://github.com/bergmeister/PSScriptAnalyzer-VSCodeIntegration

[Mcgurk125]

Thanks!

[Mcgurk125]

Just to confirm this is now working ,thanks for your example. I needed to add a * at the end of my rule path to ensure it collected all of rules defined in my folder e.g. c:\blah\blah\rules* and then used RecurseCustomRulePath = $true

Feel free to close.

[bergmeister]

Awesome to see that you were successful at the end. I agree, those things can be tricky. One tip maybe for the next time: Running Invoke-ScriptAnalyzer with the -Verbose switch can give you some info so that you know that the tool is doing.

[Mcgurk125]

Yes I use that every time now. Onwards and upwards with the extremely lengthy process of implementing our style guide

…

On Tue, 19 Jun 2018, 14:20 Christoph Bergmeister, ***@***.***> wrote: Awesome to see that you were successful at the end. I agree, those things can be tricky. One tip maybe for the next time: Running Invoke-ScriptAnalyzer with the -Verbose switch can give you some info so that you know that the tool is doing. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1005 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AfA5uxw9RthWm5Yk1rurSwH598JkPlhuks5t-Pq2gaJpZM4UUoSG> .