Bagikan melalui

Invoke-Formatter

Modul:
PSScriptAnalyzer Module

Memformat teks skrip berdasarkan pengaturan input atau pengaturan default.

Sintaks

Default (Default) 

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

Deskripsi

cmdlet mengambil input string dan memformatnya sesuai dengan pengaturan yang ditentukan. Jika tidak ada parameter Pengaturan yang disediakan, cmdlet mengasumsikan pengaturan pemformatan kode default seperti yang didefinisikan dalam .

Contoh

CONTOH 1 - Memformat teks skrip input menggunakan pengaturan default

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

CONTOH 2 - Memformat skrip input menggunakan pengaturan yang ditentukan dalam hashtable

$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"
}

CONTOH 3 - Format teks skrip input menggunakan pengaturan yang ditentukan dalam file '.psd1'

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

Parameter

-Range

Rentang tempat pemformatan harus berlangsung. Nilai parameter ini harus berupa array empat bilangan bulat. Angka-angka ini harus lebih besar dari 0. Empat bilangan bulat mewakili empat nilai berikut dalam urutan ini:

  • nomor baris awal
  • nomor kolom awal
  • nomor baris akhir
  • nomor kolom akhir

Properti parameter

Jenis:

Int32[]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:3
Wajib:False
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ScriptDefinition

Teks skrip yang akan diformat direpresentasikan sebagai string. Ini bukan objek ScriptBlock.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:1
Wajib:True
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Settings

Pengaturan hashtable atau jalur ke file data PowerShell () yang berisi pengaturan.

Properti parameter

Jenis:Object
Nilai default:CodeFormatting
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:2
Wajib:False
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Output

String

Hasil string yang diformat.