Invoke-Formatter
入力設定または既定の設定に基づいてスクリプト テキストを書式設定します。
構文
Invoke-Formatter
[-ScriptDefinition] <string>
[[-Settings] <Object>]
[[-Range] <int[]>]
[<CommonParameters>]
説明
コマンドレットは Invoke-Formatter
文字列入力を受け取り、定義された設定に従って書式設定します。
Settings パラメーターが指定されていない場合、コマンドレットは で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
書式設定を行う範囲内の範囲。 このパラメーターの値は、4 つの整数の配列である必要があります。 これらの数値は 0 より大きくする必要があります。 4 つの整数は、次の 4 つの値を次の順序で表します。
- 開始行番号
- 開始列番号
- 終了行番号
- 終了列番号
型: | Int32[] |
配置: | 3 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ScriptDefinition
書式設定するスクリプトのテキストを文字列として表します。 これは ScriptBlock オブジェクトではありません。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Settings
設定ハッシュテーブル、または設定を含む PowerShell データ ファイル (.psd1
) へのパス。
型: | Object |
配置: | 2 |
規定値: | CodeFormatting |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
出力
書式設定された文字列の結果。
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
PowerShell