Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.01 KB

UseCompatibleCmdlets.md

File metadata and controls

19 lines (14 loc) · 1.01 KB

UseCompatibleCmdlets

Severity Level: Warning

Description

This rule flags cmdlets that are not available in a given Edition/Version of PowerShell on a given Operating System. It works by comparing a cmdlet against a set of whitelists which ship with PSScriptAnalyzer. They can be found at /path/to/PSScriptAnalyzerModule/Settings. These files are of the form, PSEDITION-PSVERSION-OS.json where PSEDITION can be either Core or Desktop, OS can be either Windows, Linux or MacOS, and Version is the PowerShell version. To enable the rule to check if your script is compatible on PowerShell Core on windows, put the following your settings file:

@{
    'Rules' = @{
        'PSUseCompatibleCmdlets' = @{
            'compatibility' = @("core-6.0.2-windows")
        }
    }
}

The parameter compatibility is a list that contain any of the following {desktop-3.0-windows, desktop-4.0-windows, desktop-5.1.14393.206-windows, core-6.0.2-windows, core-6.0.2-linux, core-6.0.2-macos}.