共用方式為

Invoke-Formatter

模組:
PSScriptAnalyzer Module

根據輸入設定或預設設定格式化腳本文字。

語法

Default (預設值) 

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

Description

Invoke-Formatter Cmdlet 會採用字串輸入，並根據定義的設定來格式化它。 如果未提供 Settings 參數，Cmdlet 會假設預設程式代碼格式設定如 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[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:3
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-ScriptDefinition

要格式化為字串之腳本的文字。 這不是 ScriptBlock 物件。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Settings

包含設定的 PowerShell 資料檔 （.psd1） 的設定哈希表或路徑。

參數屬性

類型:Object
預設值:CodeFormatting
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:2
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸出

String

格式化的字串結果。