Test-ModuleManifest

模块:: Microsoft.PowerShell.Core Module

验证模块清单文件是否准确描述了模块的内容。

语法

Default （默认值）

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

说明

Test-ModuleManifest cmdlet 验证模块清单（.psd1）文件中列出的文件实际上在指定的路径中。

此 cmdlet 旨在帮助模块作者测试其清单文件。模块用户还可以在脚本和命令中使用此 cmdlet 来检测错误，然后再运行依赖于模块的脚本。

Test-ModuleManifest 返回表示模块的对象。这是 Get-Module 返回的相同类型的对象。如果清单中指定的位置中没有任何文件，该 cmdlet 还会为每个缺失的文件生成错误。

示例

示例 1：测试清单

test-ModuleManifest -Path "$pshome\Modules\TestModule.psd1"

此命令测试 TestModule.psd1 模块清单。

示例 2：使用管道测试清单

"$pshome\Modules\TestModule.psd1" | test-modulemanifest

Test-ModuleManifest : The specified type data file 'C:\Windows\System32\Wi
ndowsPowerShell\v1.0\Modules\TestModule\TestTypes.ps1xml' could not be processed because the file was not found. Please correct the path and try again.
At line:1 char:34
+ "$pshome\Modules\TestModule.psd1" | test-modulemanifest <<<<
+ CategoryInfo          : ResourceUnavailable: (C:\Windows\System32\WindowsPowerShell\v1.0\Modules\TestModule\TestTypes.ps1xml:String) [Test-ModuleManifest], FileNotFoundException
+ FullyQualifiedErrorId : Modules_TypeDataFileNotFound,Microsoft.PowerShell.Commands.TestModuleManifestCommandName

Name              : TestModule
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\TestModule\TestModule.psd1
Description       :
Guid              : 6f0f1387-cd25-4902-b7b4-22cff6aefa7b
Version           : 1.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\TestModule
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {}

此命令使用管道运算符（|）将路径字符串发送到 Test-ModuleManifest。

命令输出显示测试失败，因为找不到清单中列出的 TestTypes.ps1xml 文件。

示例 3：编写函数以测试模块清单

function Test-ManifestBool ($path)

{$a = dir $path | Test-ModuleManifest -ErrorAction SilentlyContinue; $?}

此函数类似于 Test-ModuleManifest，但它返回布尔值。如果清单通过测试并$False，则函数返回$True。

该函数使用 Get-ChildItem cmdlet 别名 = dir 来获取由$path变量指定的模块清单。该命令使用管道运算符（|）将文件对象传递给 Test-ModuleManifest。

Test-ModuleManifest 使用具有 SilentlyContinue 值的 ErrorAction 公共参数来禁止显示命令生成的任何错误。它还保存 Test-ModuleManifest 在$a变量中返回的 PSModuleInfo 对象。因此，不显示对象。

然后，在单独的命令中，该函数显示 $的值？自动变量。如果上一个命令没有生成错误，该命令将显示$True，否则$False。

可以在条件语句中使用此函数，例如可能位于 Import-Module 命令之前或使用该模块的命令。

参数

-Path

指定清单文件的路径和文件名。输入扩展名为 .psd1 的模块清单文件的可选路径和名称。默认位置为当前目录。允许使用通配符，但它们必须解析为单个模块清单文件。此参数是必需的。还可以通过管道将路径传递给 Test-ModuleManifest。

参数属性

类型:	String
默认值:	None
支持通配符:	True
不显示:	False

参数集

(All)

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

CommonParameters

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

输入

String

还可以通过管道将模块清单的路径传递给此 cmdlet。

输出

PSModuleInfo

此 cmdlet 返回表示模块的 PSModuleInfo 对象。即使清单有错误，它也会返回此对象。

通过