platyPS というものがある。 PowerShell モジュールのヘルプ生成ツールだ。 詳細は PlatyPS を使用して XML ベースのヘルプを作成する - PowerShell | Microsoft Learn を参照。
v2 ブランチ
現在のリリース版は v0.14.2 (https://www.powershellgallery.com/packages/platyPS/) だが、いろいろ不満があったので修正を試みようと clone してたら v2 ブランチ が作られていることに気付いた。
v2 ブランチに切り替えてビルドしてみると、今までとは全然違うものになっていた。
違い
- 全て C# によるバイナリのコマンドになった
- 今まではPowerShellスクリプトで作られた関数群だった
- パフォーマンスが改善されている
- Markdown ファイルのパースに Markdig を使用するようになった
- Markdig は PowerShell 7 にも同梱されているもの
- 今までは独自にパースするコードが入っていた
- コマンド体系が変わった
- コマンド名からして別物になっている
コマンド体系
今までの流れは、以下のような感じだった。
- Markdown のドキュメントを生成する
- 生成された Markdown ドキュメントを編集
- ヘルプファイルを作成
v2 でも大きな方針は変わらない。
が、物事の中心にあるは、CommandHelp というオブジェクトになっている。
整理のために入出力の関係図のようなものを作ってみたが、中心になっているのが CommandHelp オブジェクトであることが良く分かる。
input --> |command| outputの図
