次の方法で共有

Test-PSScriptFileInfo

  • リファレンス
モジュール:
Microsoft.PowerShell.PSResourceGet

ファイル内のコメント ベースのメタデータを .ps1 テストして、公開に対して有効であることを確認します。

構文

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

説明

このコマンドレットは、ファイル内のコメントベースのメタデータを .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 対して コマンドレットを実行します。 スクリプトに必要な Author メタデータがありません。 コマンドレットは警告メッセージを書き込み、 を返します $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 パス。

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

入力

None

出力

Boolean

メモ

および コマンドレットはNew-PSScriptFileInfo、ヘルプ ファイルの #requires コメントベースのヘルプ ブロックと コメントベースのヘルプ ブロックの間に<#PSScriptInfo、必要なモジュールの ステートメントを配置Update-PSScriptFileInfoします。 は Get-PSScriptFileInfo 、コメントベースの #requires ヘルプ ブロックの前のどこかにステートメントが配置されることを想定しています。 #requiresコメントベースのヘルプ ブロックの後に配置されたステートメントは、 および Publish-PSResourceによってGet-PSScriptFileInfo無視されます。