PowerShellヘルプの保守を楽に ～MicrosoftがMarkdownから変換できるツールを一般提供

同社のアナウンス

　米Microsoftは7月24日、「Microsoft.PowerShell.PlatyPS」v1.0.0の一般提供（GA）を発表した。「PowerShell」ヘルプファイルの更新と保守が容易になるという。

　「PowerShell」のヘルプファイルにはXML形式をベースとした「Microsoft Assistance Markup Language」（MAML）が用いられるが、これを開発者が自分の手で書くのはあまり現実的ではない。そこで、ReadMeファイルなどで一般的に用いられているMarkdownからMAMLに変換できるようにと開発されたのが、同社がオープンソースで提供している「PlatyPS」コマンドレットだ（ライセンスは「MIT」）。これがあれば、ヘルプファイルのオーサリングプロセスが大幅に簡素化される。

　「Microsoft.PowerShell.PlatyPS」v1.0.0では、Markdown文書を解析する処理が「Markdig」（C#）で書き直された。これは公式ドキュメントサイト「Microsoft Learn」でも用いられているライブラリで、他の改善も相まって1,000個のMarkdownファイルを数秒で処理できるパフォーマンスを発揮するという。また、メンテナンス性の向上も期待できる。

　そのほかにも、「PowerShell」コマンドレットとそのパラメーターに関する説明も正確になり、以前は提供されていなかった情報にもアクセスできるようになった。

　「Microsoft.PowerShell.PlatyPS」は、以下の環境で利用可能。

• 「Windows PowerShell 5.1」
• Windows、Linux、およびmacOS上の「PowerShell 7」以降

　以下のコマンドで「PSGallery」からモジュールをインストールできる。

Install-PSResource -Name Microsoft.PowerShell.PlatyPS

　なお、旧版となった「platyPS」v0.14.2はサポート対象外となったので注意。