Test-PSScriptFileInfo

Modul:
Microsoft.PowerShell.PSResourceGet Module

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

Sintaks

Default (Default) 

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

Deskripsi

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

Contoh

Contoh 1: Menguji skrip yang valid

Contoh ini membuat file skrip baru lalu menjalankan 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 cmdlet Test-PSScriptFile 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 file skrip .ps1.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:0
Wajib:True
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

Output

Boolean

Catatan

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