AvoidUsingCmdletAliases

úroveň závažnosti : Upozornění

Popis

Toto pravidlo detekuje použití aliasů cmdlet a vynechání Get- předpony v implicitních scénářích alias. Alias je alternativní název nebo přezdívka pro cmdlet nebo příkazový prvek, například funkci, skript, soubor nebo spustitelný soubor. I když můžete použít aliasy místo plného názvu příkazu, snižuje to čitelnost a údržbu kódu.

PowerShell také podporuje implicitní aliasy. Když se název cmdletu nenajde, PowerShell přidá Get- příkaz jako záložní řešení. Například typování verb vykoná Get-Verb.

Přezdívky vytvářejí nekonzistenci napříč kódem, protože různí autoři se učí a používají různé aliasy. Aliasy mohou potenciálně ztížit čtení a pochopení kódu v kolaborativním prostředí. Může to také způsobovat problémy s přenosností a dostupností skriptů.

Používání plných názvů cmdletů zlepšuje přehlednost kódu, usnadňuje údržbu skriptů a umožňuje správné zvýraznění syntaxe v editorech kódu a na platformách jako GitHub a Visual Studio Code. Vždy používejte plný název cmdletu místo aliasů.

Příklad

Nesplňující

gps | Where-Object {$_.WorkingSet -gt 20000000}

Kompatibilní

Get-Process | Where-Object {$_.WorkingSet -gt 20000000}

Konfigurovat pravidlo

Aby PSScriptAnalyzer se zabránilo označování preferovaných aliasů, vytvořte seznam povolených aliasů ve svém souboru nastavení a použijte PSScriptAnalyzer soubor nastavení. Pokud chcete například zakázat PSScriptAnalyzer označení cd, což je alias Set-Location, nastavte obsah souboru nastavení na následující.

@{
    'Rules' = @{
        'PSAvoidUsingCmdletAliases' = @{
            'allowlist' = @('cd')
        }
    }
}