Test-PSScriptFileInfo
测试文件中基于注释的元数据 .ps1
,以确保它对于发布有效。
语法
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:测试缺少 Author) (无效脚本
此示例针对脚本文件运行 Test-PSScriptFile
cmdlet。 脚本缺少所需的 作者 元数据。 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
输出
备注
New-PSScriptFileInfo
和 Update-PSScriptFileInfo
cmdlet 将所需模块的#requires
语句放在帮助文件的 和基于注释的帮助块之间<#PSScriptInfo
。
语句 Get-PSScriptFileInfo
预期 #requires
位于基于注释的帮助阻止之前。 和 Publish-PSResource
将Get-PSScriptFileInfo
忽略放置在基于注释的帮助块之后的任何#requires
语句。