mujun for VS Code

設計書（Markdown + Mermaid）の中の矛盾を見つける Linter mujun を、VS Code で使うための拡張です。設計書を保存するたびに検査し、指摘を「問題」パネルと波線に出します。

入れ方

VS Code の拡張機能で「mujun」と検索して入れます。Marketplace のページからも入れられます。

必要なもの

• プロジェクトに mujun 0.2.0 以上が入っていて、mujun.config.ts（または .mjs / .js）がある

  npm i -D mujun
  

• Node 24 以上。PATH の node が古いときは、設定 mujun.nodePath で Node のパスを指定します

この拡張は mujun を同梱していません。プロジェクトに入っている mujun を、プロジェクトの Node で走らせます。そのため、CLI や CI と同じ版で、同じ結果になります。

いつ検査するか

• ワークスペースを開いたとき
• Markdown か mujun.config.* を保存したとき
• ワークスペース内のファイル・フォルダーを Explorer で削除・改名したとき。ターミナルや git（rm・git checkout など）で消したファイルの指摘は、次にどれかを保存するか「mujun: 検査する」を実行するまで残ります
• コマンド「mujun: 検査する」を実行したとき。独自ルール（tools/*.ts など）を直したあとは、これで検査し直します

保存前の、書いている途中の内容は検査しません。

ワークスペースの中に mujun.config.* が複数あれば、全部を走らせます。ルートと packages/x/ の両方に設定があり、検査するファイルが重なると、同じ指摘が2つずつ出ます。どちらかの files / ignores で、重ならないようにしてください。

ワークスペースの信頼

mujun.config.ts と独自ルールは、プロジェクトのコードとして実行されます。そのため、この拡張は信頼したワークスペースでだけ動きます。

設定

うまく動かないとき

ステータスバーに ⚠ mujun が出ているときは、クリックすると理由が「出力」パネル（mujun）に出ます。

• node_modules に mujun が無い：npm i -D mujun を実行してください
• mujun 0.2.0 以上が要る：npm i -D mujun@latest で更新してください
• 波線が出ず、⚠ mujun も出ない：拡張は、開いた時点で mujun.config.* があるワークスペースで動き出します。開いたあとで設定ファイルを作ったときは、コマンド「mujun: 検査する」を実行するか、ウィンドウを再読み込み（「開発者: ウィンドウの再読み込み」）してください
• mujun が失敗した（2）：設定ファイルが読めていません。ターミナルで npx mujun を実行すると、同じ理由が出ます