Aracılığıyla paylaş

Get-ScriptAnalyzerRule

Modül:
PSScriptAnalyzer Module

Yerel bilgisayarda betik çözümleyicisi kurallarını alır.

Sözdizimi

Default EnterprisePublishing 

Get-ScriptAnalyzerRule
    [[-Name] <string[]>]
    [-CustomRulePath <string[]>]
    [-RecurseCustomRulePath]
    [-Severity <string[]>]
    [<CommonParameters>]

Description

Yerel bilgisayarda betik çözümleyicisi kurallarını alır. Kuralları Ad, Önem Derecesi, Kaynak veya SourceType'a göre, hatta kural açıklamasında belirli sözcüklere göre seçebilirsiniz.

Invoke-ScriptAnalyzer cmdlet'ini çalıştırırken dahil etmek ve dışlamak üzere kural koleksiyonları oluşturmak için bu cmdlet'i kullanın.

Kurallar hakkında bilgi almak için her kuralın Description özelliğinin değerine bakın.

PSScriptAnalyzer modülü, powershell kodunu bir betik, modül veya DSC kaynağında test eder ve en iyi uygulama standartlarını karşılar.

Örnekler

ÖRNEK 1 - Yerel bilgisayardaki tüm Betik Çözümleyicisi kurallarını alma

Get-ScriptAnalyzerRule

ÖRNEK 2 - Yalnızca Hata önem derecesine sahip kuralları alır

Get-ScriptAnalyzerRule -Severity Error

ÖRNEK 3 - Yalnızca Hata önem derecesine sahip DSC kurallarını çalıştırın

Bu örnek yalnızca MyDSCModule modülündeki dosyalarda Hata önem derecesine sahip DSC kurallarını çalıştırır.

$DSCError = Get-ScriptAnalyzerRule -Severity Error | Where-Object SourceName -eq PSDSC
$Path = "$home\Documents\WindowsPowerShell\Modules\MyDSCModule\*"
Invoke-ScriptAnalyzerRule -Path $Path -IncludeRule $DSCError -Recurse

Invoke-ScriptAnalyzerRule parametresini kullanmak, yalnızca tüm modül dosyalarını analiz etmek için tüm kurallar kullanıldıktan sonra uygulanan Önem Derecesi parametresini kullanmaktan daha verimlidir.

ÖRNEK 4 - Ada ve önem derecelerine göre kuralları alma

Bu örnek, adında Hata veya Uyarı oluşturan "Parametre" veya "Diğer Ad" içeren kuralları alır. Betiğinizin veya modülünüzün parametrelerini test etmek için bu kural kümesini kullanabilirsiniz.

$TestParameters = Get-ScriptAnalyzerRule -Severity Error, Warning -Name *Parameter*, *Alias*

ÖRNEK 5 - Özel kurallar alma

Bu örnek, VeryStrictRules ve ExtremelyStrictRules modüllerindeki standart kuralları ve kuralları alır. Komut, eşleşen yolları n alt dizinlerinde tanımlanan kuralları almak için RecurseCustomRulePath parametresini kullanır.

Get-ScriptAnalyzerRule -CustomRulePath $home\Documents\WindowsPowerShell\Modules\*StrictRules -RecurseCustomRulePath

Parametreler

-CustomRulePath

Varsayılan olarak, PSScriptAnalyzer yalnızca modüldeki Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll dosyasında belirtilen standart kuralları alır. Belirtilen yolda özel Betik Çözümleyicisi kurallarını ve standart Betik Çözümleyicisi kurallarını almak için bu parametreyi kullanın.

Betik Çözümleyicisi kurallarını içeren bir .NET derlemesinin veya modülünün yolunu girin. Yalnızca bir değer girebilirsiniz, ancak joker karakterler desteklenir. Yolun alt dizinlerindeki kuralları almak için RecurseCustomRulePath parametresini kullanın.

GitHub deposundaki Community Analyzer Kuralları gibi bir .NET derlemesi veya PowerShell modülü kullanarak özel kurallar oluşturabilirsiniz.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False
Diğer adlar:ÖzelleştirilmişKural Yolu

Parametre kümeleri

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

-Name

Yalnızca belirtilen adlara veya ad desenlerine sahip kuralları alır. Joker karakterler desteklenmektedir. Birden çok adı veya deseni listelerseniz, ad desenlerinden herhangi biriyle eşleşen tüm kuralları alır.

Parametre özellikleri

Tür:

String[]

Default value:All rules
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

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

-RecurseCustomRulePath

Yolun alt dizinlerindeki dosyalarda tanımlanan kuralları eklemek için CustomRulePath konumunu özyinelemeli olarak arar. Varsayılan olarak, Get-ScriptAnalyzerRule belirtilen yola yalnızca özel kuralları ekler.

Parametre özellikleri

Tür:SwitchParameter
Default value:False
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

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

-Severity

Yalnızca belirtilen önem derecesi değerlerine sahip kuralları alır. Geçerli değerler şunlardır:

  • Bilgi
  • Uyarı
  • Hata

Parametre özellikleri

Tür:

String[]

Default value:All rules
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
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.

Girişler

None

Bu cmdlet'e giriş kanalı yapamazsınız.

Çıkışlar

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.RuleInfo

RuleInfo nesnesi, Betik Çözümleyicisi için özel olarak oluşturulmuş özel bir nesnedir.