Invoke-Formatter

Referensi

Modul:: PSScriptAnalyzer

Memformat teks skrip berdasarkan pengaturan input atau pengaturan default.

Sintaks

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

Deskripsi

Invoke-Formatter 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 Settings/CodeFormatting.psd1.

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 - Memformat teks skrip input menggunakan pengaturan yang ditentukan 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

Jenis:	Int32[]
Position:	3
Nilai default:	None
Diperlukan:	False
Terima input alur:	True
Terima karakter wildcard:	False

-ScriptDefinition

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

Jenis:	String
Position:	1
Nilai default:	None
Diperlukan:	True
Terima input alur:	True
Terima karakter wildcard:	False

-Settings

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

Jenis:	Object
Position:	2
Nilai default:	CodeFormatting
Diperlukan:	False
Terima input alur:	True
Terima karakter wildcard:	False

Output

String

Hasil string yang diformat.

Bagikan melalui