共用方式為

Test-PSScriptFileInfo

  • 參考
模組:
Microsoft.PowerShell.PSResourceGet

測試 .ps1 檔案中的批注型元數據，以確保其適用於發行集。

語法

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

Description

此 Cmdlet 會測試 .ps1 檔案中的批注型元數據，以確保發行至存放庫是有效的。

範例

範例 1：測試有效的腳本

此範例會建立新的腳本檔案，然後執行 Test-PSScriptFile 來驗證腳本中的元數據。

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

範例 2：測試無效的腳本（遺漏作者）

此範例會針對腳本檔案執行 Test-PSScriptFile Cmdlet。 腳本遺漏必要的 Author 元數據。 Cmdlet 會寫入警告訊息，並傳回 $false。 Get-Content 可用來檢視腳本檔案的內容。

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

#>

參數

-Path

.ps1 腳本檔案的路徑。

類型:String
Position:0
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

輸入

None

輸出

備註

New-PSScriptFileInfo 和 Update-PSScriptFileInfo Cmdlet 會將 #requires 語句放在說明檔 <#PSScriptInfo 和批注型說明區塊之間所需的模組。 Get-PSScriptFileInfo 預期 #requires 語句放在批注型說明區塊之前的位置。 #requires 和 Get-PSScriptFileInfo會忽略在批注型說明區塊之後放置的任何 Publish-PSResource 語句。