Profile example in Readme.md no longer works

[rkeithhill]

This example doesn't work because -Profile now expects a path to a profile file:

$myProfile = @{
    Severity='Warning'
    IncludeRules=@('PSAvoidUsingCmdletAliases',
                    'PSAvoidUsingPositionalParameters',
                    'PSAvoidUsingInternalURLs'
                    'PSAvoidUninitializedVariable')
    ExcludeRules=@('PSAvoidUsingCmdletAliases'
                   'PSAvoidUninitializedVariable')
}

Invoke-ScriptAnalyzer -path MyScript.ps1 -Profile $myProfile

BTW it would be nice if the team could offer a recommend standard name for these files. Or at least use it in the revised sample above. Perhaps something like PSScriptAnalyzerProfile.psd1 or maybe just ScriptAnalyzerProfile.psd1? I like using the PSD1 extension so that I get syntax coloring in my PowerShell editor (VSCode) when I'm editing this file.

Here's an updated sample:

@'
@{
    Severity='Warning'
    IncludeRules=@('PSAvoidUsingCmdletAliases',
                    'PSAvoidUsingPositionalParameters',
                    'PSAvoidUsingInternalURLs'
                    'PSAvoidUninitializedVariable')
    ExcludeRules=@('PSAvoidUsingCmdletAliases'
                   'PSAvoidUninitializedVariable')
}
'@ > ScriptAnalyzerProfile.psd1

Invoke-ScriptAnalyzer -path MyScript.ps1 -Profile ScriptAnalyzerProfile.psd1

Update: I notice that 1.4.0 will not complain if I pass a hashtable directly to -Profile but it also does not seem to honor the settings in the hashtable. Also the fact that the -Profile parameter is of type [string] leads me to believe this support just a path and not a hashtable. Perhaps the parameter should be renamed -ProfilePath or -SettingsPath (with an alias of 'Profile' to avoid compat breaks)?

[daviwil]

We're discussing the usage of Script Analyzer profile files over on the vscode-powershell repo: PowerShell/vscode-powershell#122