Test-ScriptFileInfo

  • リファレンス
モジュール:
PowerShellGet

スクリプトのコメント ブロックを検証します。

構文

Test-ScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]
Test-ScriptFileInfo
    -LiteralPath <String>
    [<CommonParameters>]

説明

コマンドレットは Test-ScriptFileInfo 、Publish-Script コマンドレットで発行されるスクリプトの先頭にあるコメント ブロックを検証します。 コメント ブロックにエラーがある場合、このコマンドレットはエラーの場所または修正方法に関する情報を返します。

これは、Microsoft.PowerShell.PSResourceGet のコマンドレットのTest-PSScriptFileInfoプロキシ コマンドレットです。 詳細については、「 Test-PSScriptFileInfo」を参照してください。

例

例 1: スクリプト ファイルをテストする

Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"

このコマンドは、New-ScriptFile.ps1スクリプト ファイルをテストし、結果を表示します。 スクリプト ファイルには、有効なメタデータが含まれています。

例 2: すべてのメタデータ プロパティの値を持つスクリプト ファイルをテストする

Test-ScriptFileInfo -Path "D:\code\Test-Runbook.ps1" | Format-List *

Name                       : Test-Runbook
Path                       : D:\code\Test-Runbook.ps1
ScriptBase                 : D:\code
ReleaseNotes               : {contoso script now supports following features, Feature 1, Feature 2, Feature 3...}
Version                    : 1.0
Guid                       : eb246b19-17da-4392-8c89-7c280f69ad0e
Author                     : pattif
CompanyName                : Microsoft Corporation
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
Tags                       : {Tag1, Tag2, Tag3}
LicenseUri                 : https://contoso.com/License
ProjectUri                 : https://contoso.com/
IconUri                    : https://contoso.com/MyScriptIcon
ExternalModuleDependencies : ExternalModule1
RequiredScripts            : {Start-WFContosoServer, Stop-ContosoServerScript}
ExternalScriptDependencies : Stop-ContosoServerScript
Description                : Contoso Script example
RequiredModules            : {RequiredModule1, @{ ModuleName = 'RequiredModule2'; ModuleVersion = '1.0' }, @{ ModuleName = 'RequiredModule3'; RequiredVersion = '2.0' }, ExternalModule1}
ExportedCommands           : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-Workflow...}
ExportedFunctions          : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-AdvPSCmdlet}
ExportedWorkflows          : My-Workflow

このコマンドは、スクリプト ファイルTest-Runbook.ps1をテストし、パイプライン演算子を使用して結果を Format-List コマンドレットに渡して結果を書式設定します。

例 3: メタデータのないスクリプト ファイルをテストする

Test-ScriptFileInfo -Path "D:\code\Hello-World.ps1"

Test-ScriptFileInfo : Script 'D:\code\Hello-World.ps1' is missing required metadata properties. Verify that the script file has Version, Description
and Author properties. You can use the Update-ScriptFileInfo or New-ScriptFileInfo cmdlet to add or update the PSScriptInfo to the script file.
At line:1 char:1
+ Test-ScriptFileInfo D:\code\Hello-World.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidArgument: (D:\code\Hello-World.ps1:String) [Test-ScriptFileInfo], ArgumentException

+ FullyQualifiedErrorId : MissingRequiredPSScriptInfoProperties,Test-ScriptFile

このコマンドは、メタデータが関連付けられていないスクリプト ファイル Hello-World.ps1をテストします。

パラメーター

-LiteralPath

1 つ以上の場所へのパスを指定します。 Path パラメーターとは異なり、LiteralPath パラメーターの値は、入力されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、それらを単一引用符で囲みます。 単一引用符は、文字をエスケープ シーケンスとして解釈しないように PowerShell に指示します。

パラメーターは、 の Path パラメーター Test-PSScriptFileInfoにマップされます。

Type:String
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

1 つ以上の場所へのパスを指定します。 ワイルドカードを使用できます。 既定の場所は、現在のディレクトリ (.) です。

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

入力

String

出力

Object