Поделиться через

Invoke-Formatter

Модуль:
PSScriptAnalyzer Module

Форматирует текст скрипта на основе входных параметров или параметров по умолчанию.

Синтаксис

Default (По умолчанию) 

Invoke-Formatter
    [-ScriptDefinition] <string>
    [[-Settings] <Object>]
    [[-Range] <int[]>]
    [<CommonParameters>]

Описание

Командлет Invoke-Formatter принимает строковые входные данные и форматирует его в соответствии с определенными параметрами. Если параметр параметров не указан, командлет предполагает параметры форматирования кода по умолчанию, как определено в Settings/CodeFormatting.psd1.

Примеры

ПРИМЕР 1. Форматирование текста входного скрипта с помощью параметров по умолчанию

$scriptDefinition = @'
function foo {
"hello"
  }
'@

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

ПРИМЕР 2. Форматирование входного скрипта с помощью параметров, определенных в хэш-таблицы

$scriptDefinition = @'
function foo {
"hello"
}
'@

$settings = @{
    IncludeRules = @("PSPlaceOpenBrace", "PSUseConsistentIndentation")
    Rules = @{
        PSPlaceOpenBrace = @{
            Enable = $true
            OnSameLine = $false
        }
        PSUseConsistentIndentation = @{
            Enable = $true
        }
    }
}

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings

function foo
{
    "hello"
}

ПРИМЕР 3. Форматирование текста входного скрипта с помощью параметров, определенных файлом "PSD1".

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings /path/to/settings.psd1

Параметры

-Range

Диапазон, в котором должно проходить форматирование. Значение этого параметра должно быть массивом из четырех целых чисел. Эти числа должны быть больше 0. Четыре целых числа представляют следующие четыре значения в следующем порядке:

  • начальный номер строки
  • начальный номер столбца
  • конечный номер строки
  • конечный номер столбца

Свойства параметров

Тип:

Int32[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:3
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-ScriptDefinition

Текст скрипта, отформатированный как строка. Это не объект ScriptBlock.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Settings

Хэш-файл параметров или путь к файлу данных PowerShell (.psd1), который содержит параметры.

Свойства параметров

Тип:Object
Default value:CodeFormatting
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:2
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Выходные данные

String

Отформатированный результат строки.