Aracılığıyla paylaş

Invoke-Formatter

Modül:
PSScriptAnalyzer Module

Bir betik metnini giriş ayarlarına veya varsayılan ayarlara göre biçimlendirin.

Syntax

Default (Varsayılan) 

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

Description

cmdlet'i bir dize girişi alır ve tanımlanan ayarlara göre biçimlendirır. Ayarları parametresi sağlanmadıysa, cmdlet'i 'de tanımlanan varsayılan kod biçimlendirme ayarlarını varsayar.

Örnekler

ÖRNEK 1 - Varsayılan ayarları kullanarak giriş betiği metnini biçimlendirme

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

ÖRNEK 2 - Bir karma tablo içinde tanımlanan ayarları kullanarak giriş betiğini biçimlendirme

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

ÖRNEK 3 - Giriş betik metnini '.psd1' dosyasında tanımlanan ayarlarla biçimlendirin

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

Parametreler

-Range

Biçimlendirmenin gerçekleşmesi gereken aralık. Bu parametrenin değeri dört tamsayıdan oluşan bir dizi olmalıdır. Bu sayılar 0'dan büyük olmalıdır. Dört tamsayı aşağıdaki dört değeri şu sırada temsil eder:

  • başlangıç satırı numarası
  • başlangıç sütun numarası
  • bitiş satırı numarası
  • bitiş sütun numarası

Parametre özellikleri

Tür:

Int32[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:3
Zorunlu:False
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:True
Kalan bağımsız değişkenlerden elde edilen değer:False

-ScriptDefinition

Biçimlendirilecek betiğin metni dize olarak temsil edilir. Bu bir ScriptBlock nesnesi değildir.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:1
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:True
Kalan bağımsız değişkenlerden elde edilen değer:False

-Settings

Ayarları içeren bir ayarlar karma tablosu veya PowerShell veri dosyasının () yolu.

Parametre özellikleri

Tür:Object
Default value:CodeFormatting
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:2
Zorunlu:False
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:True
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Çıkışlar

String

Biçimlendirilmiş dize sonucu.