UseCompatibleCmdlets

Nível de gravidade: aviso

Estado padrão: Sempre ativado

Descrição

Essa regra detecta cmdlets que não estão disponíveis para a edição, versão e sistema operacional do PowerShell que você escolhe. A regra compara cada cmdlet do seu script com uma lista de compatibilidade allow que vem com o PSScriptAnalyzer. Esses arquivos estão no seguinte local: /path/to/PSScriptAnalyzerModule/Settings.

Cada arquivo usa este formato de nomenclatura:

<psedition>-<psversion>-<os>.json

Onde:

  • <psedition> é Core ou Desktop
  • <psversion> é a versão PowerShell
  • <os> é Windows, Linux, Linux-Arm ou MacOS

Regra de configuração

Para verificar se seu script é compatível com o PowerShell Core 6.1 no Windows, adicione esta configuração:

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

O parâmetro de compatibilidade aceita uma lista de um ou mais identificadores de alvo, tais como:

  • desktop-2.0-windows
  • desktop-3.0-windows
  • desktop-4.0-windows (retirado do Windows Server 2012 R2)
  • desktop-5.1.14393.206-windows
  • Core-6.1.0-Windows (retirado do Windows 10, versão 1803)
  • core-6.1.0-linux (obtido do Ubuntu 18.04)
  • core-6.1.0-linux-arm (retirado do Raspbian)
  • core-6.1.0-macos

Versões patchadas do PowerShell geralmente têm os mesmos dados do cmdlet, então essa regra principalmente inclui perfis de versões maiores e secundárias.

Você também pode criar um perfil personalizado comNew-CommandDataFile.ps1. Coloque o arquivo JSON gerado na Settings pasta do PSScriptAnalyzer módulo. Depois, você pode referenciar esse arquivo pelo nome em compatibility.

Os core-6.0.2-* arquivos foram removidos no PSScriptAnalyzer 1.18 porque o PowerShell 6.0 chegou ao fim de sua vida útil.

Embora a regra seja configurável, ela está sempre ativada. Use um dos seguintes métodos para evitar usar essa regra:

  • Crie um arquivo de configuração de regras personalizado para incluir apenas as regras que você quer ou exclua as regras que você não quer.
  • Adicione os atributos apropriados de supressão de regras ao seu código para suprimir a regra para blocos de código específicos. Para mais informações, veja a seção Suprimindo regras do Uso do PSScriptAnalyzer.