Test-PSScriptFileInfo

  • Referensi
Modul:
Microsoft.PowerShell.PSResourceGet

Menguji metadata berbasis komentar dalam .ps1 file untuk memastikan metadata tersebut valid untuk publikasi.

Sintaks

Test-PSScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]

Deskripsi

Cmdlet ini menguji metadata berbasis komentar dalam .ps1 file untuk memastikan metadata tersebut valid untuk publikasi ke repositori.

Contoh

Contoh 1: Menguji skrip yang valid

Contoh ini membuat file skrip baru lalu berjalan Test-PSScriptFile untuk memvalidasi metadata dalam skrip.

New-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1" -Description "this is a test script"
Test-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1"
True

Contoh 2: Menguji skrip yang tidak valid (tidak ada Penulis)

Contoh ini menjalankan Test-PSScriptFile cmdlet terhadap file skrip. Skrip tidak memiliki metadata Penulis yang diperlukan. Cmdlet menulis pesan peringatan dan mengembalikan $false. Get-Content digunakan untuk melihat konten file skrip.

Test-PSScriptFileInfo -Path "C:\MyScripts\invalid_test_script.ps1"
Get-Content "C:\MyScripts\invalid_test_script.ps1"

WARNING: The .ps1 script file passed in wasn't valid due to: PSScript file is missing the required
Author property
False
<#PSScriptInfo

.VERSION 1.0.0.0

.GUID 7ec4832e-a4e1-562b-8a8c-241e535ad7d7

.AUTHOR

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
this is a test script

#>

Parameter

-Path

Jalur ke .ps1 file skrip.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Input

None

Output

Boolean

Catatan

New-PSScriptFileInfo cmdlet dan Update-PSScriptFileInfo menempatkan #requires pernyataan untuk modul yang diperlukan antara <#PSScriptInfo blok bantuan berbasis komentar dan file bantuan. Mengharapkan Get-PSScriptFileInfo#requires pernyataan ditempatkan di suatu tempat sebelum blok bantuan berbasis komentar. Setiap #requires pernyataan yang ditempatkan setelah blok bantuan berbasis komentar diabaikan oleh Get-PSScriptFileInfo dan Publish-PSResource.