共用方式為

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：測試不正確腳本， (遺漏 Author)

此範例會針對腳本檔案執行 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

輸出

Boolean

備註

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