AvoidOverwritingBuiltInCmdlets

Severity Level: Warning

Description

This rule flags cmdlets that are available in a given edition/version of PowerShell on a given operating system which are overwritten by a function declaration. It works by comparing function declarations against a set of allowlists that ship with PSScriptAnalyzer. These allowlist files are used by other PSScriptAnalyzer rules. More information can be found in the documentation for the UseCompatibleCmdlets rule.

Configuration

To enable the rule to check if your script is compatible on PowerShell Core on Windows, put the following your settings file.

@{
    'Rules' = @{
        'PSAvoidOverwritingBuiltInCmdlets' = @{
            'PowerShellVersion' = @('core-6.1.0-windows')
        }
    }
}

Parameters

PowerShellVersion

The parameter PowerShellVersion is a list of allowlists that ship with PSScriptAnalyzer.

Note

The default value for PowerShellVersion is core-6.1.0-windows if PowerShell 6 or later is installed, and desktop-5.1.14393.206-windows if it's not.

Usually, patched versions of PowerShell have the same cmdlet data, therefore only settings of major and minor versions of PowerShell are supplied. One can also create a custom settings file as well with the New-CommandDataFile.ps1 script and use it by placing the created JSON into the Settings folder of the PSScriptAnalyzer module installation folder, then the PowerShellVersion parameter is just its filename (that can also be changed if desired). Note that the core-6.0.2-* files were removed in PSScriptAnalyzer 1.18 since PowerShell 6.0 reached end of life.