次の方法で共有

Invoke-Formatter

モジュール:
PSScriptAnalyzer Module

入力設定または既定の設定に基づいてスクリプト テキストを書式設定します。

構文

Default (既定) 

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

説明

コマンドレットは、文字列入力を受け取り、定義された設定に従って書式設定します。 Settings パラメーターが指定されていない場合、コマンドレットは、で定義されている既定のコード書式設定を想定します。

例

例 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[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:3
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ScriptDefinition

書式設定するスクリプトのテキストを文字列として表します。 これは、ScriptBlock オブジェクトではありません。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Settings

設定ハッシュテーブル、または設定を含む PowerShell データ ファイル () へのパス。

パラメーターのプロパティ

型:Object
規定値:CodeFormatting
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:2
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

出力

String

書式設定された文字列の結果。