次の方法で共有

Test-ModuleManifest

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

モジュール マニフェスト ファイルがモジュールの内容を正確に記述していることを確認します。

構文

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

説明

Test-ModuleManifest コマンドレットは、モジュール マニフェスト (.psd1) ファイルに一覧表示されているファイルが実際に指定されたパスにあることを確認します。

このコマンドレットは、モジュール作成者がマニフェスト ファイルをテストできるように設計されています。 モジュール ユーザーは、スクリプトとコマンドでこのコマンドレットを使用して、モジュールに依存するスクリプトを実行する前にエラーを検出することもできます。

Test-ModuleManifest は、モジュールを表すオブジェクトを返します。 これは、Get-Module が返すのと同じ種類のオブジェクトです。 マニフェストで指定された場所にファイルがない場合は、不足しているファイルごとにエラーも生成されます。

例

例 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似ていますが、ブール値を返します。 この関数は、マニフェストがテストに合格した場合は$Trueを返し、それ以外の場合は$False返します。

この関数は、Get-ChildItem コマンドレット alias = dir を使用して、$path変数で指定されたモジュール マニフェストを取得します。 このコマンドは、パイプライン演算子 (|) を使用して、Test-ModuleManifestファイル オブジェクトを渡します。

Test-ModuleManifest では、コマンドによって生成されるエラーの表示を抑制するために、値が SilentlyContinue の共通パラメーター ErrorAction を使用します。 また、test-ModuleManifest PSModuleInfo オブジェクトを $a 変数に保存します。 そのため、オブジェクトは表示されません。

次に、別のコマンドで、関数は $? の値を表示します。 自動変数。 前のコマンドでエラーが生成されない場合、コマンドは$Trueを表示し、それ以外の場合は$False。

この関数は、Import-Module コマンドまたはモジュールを使用するコマンドの前にあるような条件付きステートメントで使用できます。

パラメーター

-Path

マニフェスト ファイルのパスとファイル名を指定します。 .psd1 ファイル名拡張子を持つモジュール マニフェスト ファイルの省略可能なパスと名前を入力します。 既定の場所は現在のディレクトリです。 ワイルドカード文字はサポートされていますが、1 つのモジュール マニフェスト ファイルに解決する必要があります。 このパラメーターは必須です。 Test-ModuleManifestへのパス パイプすることもできます。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:True

入力

String

モジュール マニフェストへのパスをこのコマンドレットにパイプできます。

出力

PSModuleInfo

このコマンドレットは、モジュールを表す PSModuleInfo オブジェクトを返します。 マニフェストにエラーが発生した場合でも、このオブジェクトが返されます。