Bagikan melalui

Get-ScriptAnalyzerRule

Modul:
PSScriptAnalyzer Module

Mendapatkan aturan penganalisis skrip di komputer lokal.

Sintaks

Default (Default) 

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

Deskripsi

Mendapatkan aturan penganalisis skrip di komputer lokal. Anda dapat memilih aturan menurut Nama, Tingkat Keparahan, Sumber, atau SourceType, atau bahkan kata-kata tertentu dalam deskripsi aturan.

Gunakan cmdlet ini untuk membuat kumpulan aturan untuk disertakan dan dikecualikan saat menjalankan cmdlet Invoke-ScriptAnalyzer.

Untuk mendapatkan informasi tentang aturan, lihat nilai properti Deskripsi dari setiap aturan.

Modul PSScriptAnalyzer menguji kode PowerShell dalam skrip, modul, atau sumber daya DSC untuk menentukan apakah memenuhi standar praktik terbaik.

Contoh

CONTOH 1 - Mendapatkan semua aturan Script Analyzer di komputer lokal

Get-ScriptAnalyzerRule

CONTOH 2 - Hanya mendapatkan aturan dengan tingkat keparahan Kesalahan

Get-ScriptAnalyzerRule -Severity Error

CONTOH 3 - Jalankan hanya aturan DSC dengan tingkat keparahan Kesalahan

Contoh ini hanya menjalankan aturan DSC dengan tingkat keparahan Kesalahan pada file dalam modul MyDSCModule.

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

Menggunakan parameter IncludeRule lebih efisien daripada menggunakan parameter Tingkat Keparahan , yang diterapkan hanya setelah menggunakan semua aturan untuk menganalisis semua file modul.

CONTOH 4 - Dapatkan aturan berdasarkan nama dan tingkat keparahan

Contoh ini mendapatkan aturan dengan "Parameter" atau "Alias" dalam nama yang menghasilkan Kesalahan atau Peringatan. Anda dapat menggunakan sekumpulan aturan ini untuk menguji parameter skrip atau modul Anda.

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

CONTOH 5 - Mendapatkan aturan kustom

Contoh ini mendapatkan aturan standar dan aturan dalam modul VeryStrictRules dan ExtremelyStrictRules. Perintah menggunakan parameter RecurseCustomRulePath untuk mendapatkan aturan yang ditentukan dalam subdirektori jalur yang cocok.

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

Parameter

-CustomRulePath

Secara default, PSScriptAnalyzer hanya mendapatkan aturan standar yang ditentukan dalam file Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll dalam modul. Gunakan parameter ini untuk mendapatkan aturan Script Analyzer kustom di jalur yang ditentukan dan aturan Script Analyzer standar.

Masukkan jalur ke rakitan .NET atau modul yang berisi aturan Penganalisis Skrip. Anda hanya dapat memasukkan satu nilai, tetapi kartubebas didukung. Untuk mendapatkan aturan dalam subdirektori jalur, gunakan parameter RecurseCustomRulePath.

Anda dapat membuat aturan kustom menggunakan rakitan .NET atau modul PowerShell, seperti Aturan Penganalisis Komunitas di repositori GitHub.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False
Alias:CustomizedRulePath

Kumpulan parameter

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

-Name

Hanya mendapatkan aturan dengan nama atau pola nama yang ditentukan. Penggunaan wildcard didukung. Jika Anda mencantumkan beberapa nama atau pola, itu mendapatkan semua aturan yang cocok dengan salah satu pola nama.

Properti parameter

Jenis:

String[]

Nilai default:All rules
Mendukung wildcard:True
DontShow:False

Kumpulan parameter

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

-RecurseCustomRulePath

Mencari lokasi CustomRulePath secara rekursif untuk menambahkan aturan yang ditentukan dalam file dalam subdirektori jalur. Secara default, Get-ScriptAnalyzerRule hanya menambahkan aturan kustom di jalur yang ditentukan.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

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

-Severity

Hanya mendapatkan aturan dengan nilai tingkat keparahan yang ditentukan. Nilai yang valid adalah:

  • Informasi
  • Peringatan
  • Kesalahan

Properti parameter

Jenis:

String[]

Nilai default:All rules
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
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.

Input

None

Anda tidak dapat menyalurkan input ke cmdlet ini.

Output

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.RuleInfo

Objek RuleInfo adalah objek kustom yang dibuat khusus untuk Script Analyzer.