2018年11月28日 (水) 10:21にHsaitoによる

2018-11-28T10:21:01Z

Hsaito: ページの作成:「== .NETバイナリモジュール == .NETのバイナリモジュールを作成する場合は、クラスライブラリを作成し、それを`Cmdlet`よ...」

2018-11-22T03:01:49Z

ページの作成:「== .NETバイナリモジュール == .NETのバイナリモジュールを作成する場合は、クラスライブラリを作成し、それを<code>Cmdlet</code>よ...」

新規ページ

== .NETバイナリモジュール ==
.NETのバイナリモジュールを作成する場合は、クラスライブラリを作成し、それを<code>Cmdlet</code>より継承する。尚、PowerShellのRunspaceを使用する必要がある場合は、<code>PSCmdlet</code>から継承する。<code>PSCmdlet</code>を使用するとPowerShellのランタイムに依存するため、これが好ましくない場合は<code>Cmdlet</code>を使用する。ただし、この場合、Runspaceに依存するいくつかの機能が使用できなくなる。

== モジュールを構成する場合の注意 ==
モジュールを構成後、モジュールをモジュールパス(<code>$Env:PSModulePath</code>)のサブディレクトリに配置することにより、読み込めるようになるが、この場合いくつか注意する必要がある。

=== PSD1ファイルの作成 ===
モジュールはサブディレクトリと同じ名前のPSD1ファイルを持つ必要がある。これがなくとも<code>Import-Module</code> Cmdletを使用して、読み込むことはできるけど不便。このファイルがあることにより、Cmdletが実行された際に自動読み込みを行うことができる。尚、[https://www.powershellgallery.com/ PowerShell Gallery]などに公開する場合は、PSD1ファイルはメタデータ提供手段として必須。

以下は[https://github.com/hsaito/MyNumberPS MyNumberPS]における例。このファイル自体は<code>New-ModuleManifest</code> Cmdletを使用して動的に生成することができる。
<code>FunctionsToExport</code>に指定している関数はCmdletとして使用できるようになる。こちらはワイルドカード'*'も使用できるらしいが、うまく動作しない。

<pre>
@{
RootModule = 'MyNumberPS.dll'
ModuleVersion = '1.2.0.0'
FunctionsToExport = @(
'Get-MyNumber'
'Test-MyNumber'
'Get-MyNumberRange'
)
CmdletsToExport = '*'
VariablesToExport = '*'
AliasesToExport = '*'
GUID = 'de6fc708-4172-4685-abf4-2cd5930e6ba9'
Author = 'Hideki Saito'
Description = 'MyNumber Module for PowerShell'
PowerShellVersion = '6.0'
CompatiblePSEditions = 'Core'
Copyright = '(c) 2018 Hideki Saito. All rights reserved.'
PrivateData = @{
PSData = @{
ProjectUri = 'https://github.com/hsaito/MyNumberPS/'
LicenseUri = 'https://github.com/hsaito/MyNumberPS/blob/master/LICENSE'
ReleaseNotes = ''
}
}
}

</pre>

この後、<code>Get-Module -ListAvailable</code>でモジュールが表示されていればモジュールのインストールは成功している。

<pre>
Binary 1.2.0.0 MyNumberPS Core {Get-MyNumber, Test-MyNumber, Get-MyNumberRange}
</pre>

=== ヘルプファイル ===
PowerShellのヘルプファイルは書くのが面倒くさいので、[https://github.com/PowerShell/platyPS platyPS]を使用してマークダウン書式で書くのが一番楽。
platyPSはDeskエディション(つまりCoreではなく、Windows PowerShell)のモジュールなので、WindowsCompatibibilityモジュールのインストールが必要になる。

モジュールを読み込んだあとに、<code>New-MarkdownHelp</code> Cmdletを使用すると、モジュールに基づいたファイルが生成されるので、それを編集する。編集後、<code>New-ExternalHelp</code> Cmdletを使用すると、XMLファイルが生成されるので、それをモジュールが入っているディレクトリにコピーする。これで、モジュールの読み込み時にヘルプも読み込まれるようになる。

尚、モジュールに変更が加わった場合は<code>Update-MarkdownHelpModule</code> Cmdletを使用すると、マークダウンファイルが更新される。

[[Category:技術]]
[[Category:.NET]]
[[Category:PowerShell]]
[[Category:PowerShell Core]]

@@ 6行目: / 6行目: @@
 === PSD1ファイルの作成 ===
-モジュールはサブディレクトリと同じ名前のPSD1ファイルを持つ必要がある。これがなくとも<code>Import-Module</code> Cmdletを使用して、読み込むことはできるけど不便。このファイルがあることにより、Cmdletが実行された際に自動読み込みを行うことができる。尚、[https://www.powershellgallery.com/ PowerShell Gallery]などに公開する場合は、PSD1ファイルはメタデータ提供手段として必須。
+モジュールはサブディレクトリと同じ名前のPSD1ファイルを持つ必要がある。これがなくとも<code>Import-Module</code> Cmdletを使用して、読み込むことはできるけど不便。このファイルがあることにより、Cmdletが実行された際に動的に自動読み込みを行うことができる。尚、[https://www.powershellgallery.com/ PowerShell Gallery]などに公開する場合は、PSD1ファイルはメタデータ提供手段として必須。
 以下は[https://github.com/hsaito/MyNumberPS MyNumberPS]における例。このファイル自体は<code>New-ModuleManifest</code> Cmdletを使用して動的に生成することができる。
@@ 45行目: / 45行目: @@
 Binary     1.2.0.0    MyNumberPS                          Core      {Get-MyNumber, Test-MyNumber, Get-MyNumberRange}
 </pre>
 === ヘルプファイル ===

PowerShellモジュールの作成方法 - 版の履歴

2018年11月28日 (水) 10:21にHsaitoによる

Hsaito: ページの作成:「== .NETバイナリモジュール == .NETのバイナリモジュールを作成する場合は、クラスライブラリを作成し、それをCmdletよ...」

Hsaito: ページの作成:「== .NETバイナリモジュール == .NETのバイナリモジュールを作成する場合は、クラスライブラリを作成し、それを`Cmdlet`よ...」