Invoke-Formatter

Ссылка

Модуль:: PSScriptAnalyzer

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

Синтаксис

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[]
Position:	3
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ScriptDefinition

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

Тип:	String
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Settings

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

Тип:	Object
Position:	2
Default value:	CodeFormatting
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

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

String

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

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