Test-PSScriptFileInfo

测试 .ps1 文件中基于注释的元数据,以确保它对发布有效。

语法

Default (默认值)

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

说明

此 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 写入警告消息并返回 $falseGet-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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

None

输出

Boolean

备注

New-PSScriptFileInfoUpdate-PSScriptFileInfo cmdlet 在帮助文件的 #requires 和基于注释的帮助块之间放置所需模块的 <#PSScriptInfo 语句。 Get-PSScriptFileInfo 要求将 #requires 语句放在基于注释的帮助块的某个位置。 #requiresGet-PSScriptFileInfo忽略在基于注释的帮助块之后放置的任何 Publish-PSResource 语句。