PSScriptAnalyzer

[zigford]

I use powershell in Vim a lot and have not written any significant vimscript before, and I saw there was an open issue #1264 for a new linter.

[zigford]

Ps, I’m not sure why this is failing at the moment. Could someone with more knowledge of the tests give me a hint?

[w0rp]

You should just write '' as the second argument here.

[w0rp]

Get rid of these {{{ and }}} comments. You can use the indentation levels for folding instead.

[w0rp]

If you aren't using the code, you should remove it.

[w0rp]

Use ale#command#CreateFile or ale#Command#ManageFile instead. CreateTempFile isn't intended for use outside of some very specific parts of code.

[zigford]

Thanks for your feedback, implemented your suggestions in commit a839a9e

[w0rp]

I'll merge this and fix the linter errors.

[coolaj86]

@zigford Do you know how / where I specify the PSScriptAnalyzerSettings.psd1 for my project on Mac / Linux?

I've looked through the source here (though I don't read VimScript very well) and a few PowerShell docs on Microsoft Learn, but I can't figure out how to do it.

This is what I have in the root of my project directory (where I'm running vim from), but the warnings are not being ignored as I expected:

./PSScriptAnalyzerSettings.psd1:

@{
    IncludeRules = @()
    ExcludeRules = @(
        'PSAvoidUsingCmdletAliases',
        'PSUseDeclaredVarsMoreThanAssignments'
    )
}

When I run vim ./bat/install.ps1 I still see all the errors.

[zigford]

@zigford Do you know how / where I specify the PSScriptAnalyzerSettings.psd1 for my project on Mac / Linux?

I've looked through the source here (though I don't read VimScript very well) and a few PowerShell docs on Microsoft Learn, but I can't figure out how to do it.

This is what I have in the root of my project directory (where I'm running vim from), but the warnings are not being ignored as I expected:

./PSScriptAnalyzerSettings.psd1:

@{
    IncludeRules = @()
    ExcludeRules = @(
        'PSAvoidUsingCmdletAliases',
        'PSUseDeclaredVarsMoreThanAssignments'
    )
}

When I run vim ./bat/install.ps1 I still see all the errors.

I think it’s in the :help but put something like this in your vimrc
" Suppress Write-Host and Global vars warnings
let g:ale_powershell_psscriptanalyzer_exclusions = 'PSAvoidUsingWriteHost,PSAvoidGlobalVars'

[coolaj86]

I am using g:ale_powershell_psscriptanalyzer_exclusions right now, however, my understanding is that I should be able to place a PSScriptAnalyzerSettings.psd1 in the project root with any and all supported options and have that pass through as -Settings <project-root>/PSScriptAnalyzerSettings.psd1 just like VS Code and other editors that support PowerShell.

I suppose that wasn't available at the time or otherwise didn't get implemented?