Test-ScriptFileInfo

参考

模块:: PowerShellGet

验证脚本的注释块。

语法

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

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

说明

该 Test-ScriptFileInfo cmdlet 在脚本的开头验证注释块，该脚本将使用 Publish-Script cmdlet 发布。如果注释块有错误，此 cmdlet 将返回有关错误所在位置或如何更正错误的信息。

示例

示例 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 cmdlet 来设置结果的格式。

示例 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

指定通向一个或多个位置的路径。与 Path 参数不同， LiteralPath 参数的值与输入时完全相同。不会将任何字符解释为通配符。如果路径包含转义字符，请将它们括在单引号中。单引号告知 PowerShell 不要将任何字符解释为转义序列。

类型:	String
别名:	PSPath
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Path

指定通向一个或多个位置的路径。允许使用通配符。默认位置为当前目录（.）。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	True

输入

String

输出

Object

通过