UseSingularNouns

Уровень серьезности: предупреждение

Описание

Командлеты состояний с рекомендациями команды PowerShell должны использовать существительные в единственном числе, а не во множественном числе. Подавление позволяет подавлять правило для определенных имен функций. Пример:

function Get-Elements {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', 'Get-Elements')]
    Param()
}

Конфигурация

Rules = @{
    PSUseSingularNouns = @{
        Enable           = $true
        NounAllowList    = 'Data', 'Windows', 'Foos'
    }
}

Параметры

• Enable: bool (значение по умолчанию — $true)

  Включите или отключите правило во время вызова ScriptAnalyzer.

• NounAllowList: string[] (значение по умолчанию — {'Data', 'Windows'})

  Команды, которые должны быть исключены из этого правила. Data и Windows являются общими ложноположительными результатами и по умолчанию исключаются.

Как

Измените число во множественном числе на единственное число.

Пример

Неправильно

function Get-Files
{
    ...
}

Правильно

function Get-File
{
    ...
}