UseCorrectCasing

Nível de gravidade: Informação

Descrição

Esta regra deteta casos inconsistentes em nomes de cmdlet, parâmetros, nomes de tipos, palavras-chave e operadores. O PowerShell é insensível a maiúsculas e minúsculas sempre que possível, por isso a inclusão dos nomes dos cmdlets, parâmetros, palavras-chave e operadores não afeta a funcionalidade.

No entanto, esta regra garante uma capa consistente para maior clareza e legibilidade. Usar palavras-chave minúsculas ajuda a distingui-las de comandos, enquanto usar operadores minúsculas ajuda a distingui-las de parâmetros.

Para seguir esta regra:

• Use invólucros exatos para nomes de tipos.
• Use a carcaça exata para cmdlet e nomes de parâmetros.
• Use minúsculas para palavras-chave e operadores de idioma.

Example

Não conforme

ForEach ($file in Get-childitem -Recurse) {
    $file.Extension -EQ '.txt'
}

invoke-command { 'foo' } -runasadministrator

Compliant

foreach ($file in Get-ChildItem -Recurse) {
    $file.Extension -eq '.txt'
}

Invoke-Command { 'foo' } -RunAsAdministrator

Configuração

Rules = @{
    PSUseCorrectCasing = @{
        Enable        = $true
        CheckCommands = $true
        CheckKeyword  = $true
        CheckOperator = $true
    }
}

Parâmetros

Enable

Este parâmetro controla se o ScriptAnalyzer verifica o código em relação a esta regra. Aceita um valor booleano. Para permitir esta regra, defina este parâmetro para $true. O valor predefinido é $false.

CheckCommands

Este parâmetro controla se o ScriptAnalyzer verifica se a maiúscula de todos os nomes de comandos e parâmetros corresponde à sua carcaça canónica. Aceita um valor booleano. O valor predefinido é $true.

CheckKeyword

Este parâmetro controla se o ScriptAnalyzer verifica se todas as palavras-chave das línguas são minúsculas. Aceita um valor booleano. O valor predefinido é $true.

CheckOperator

Este parâmetro controla se o ScriptAnalyzer verifica se todos os operadores são minúsculos. Por exemplo, -eq, -ne, e -gt. Aceita um valor booleano. O valor predefinido é $true.