Skip to content
frontmatter
キー値
specdojo.idprj-0001:pjr-0142-vs-code-specdojo
specdojo.typeproject
specdojo.statusready
specdojo.rulebookspecdojo:pjr-rulebook
specdojo.part_ofprj-0001:pjr-index
specdojo.item_typetodo
specdojo.item_statusdone
specdojo.prioritylow
specdojo.ownerARC
specdojo.due_on2026-10-31
specdojo.completed_at2026-09-14T23:11:41Z
specdojo.conclusiondocs-editing-guide に「VS Code 拡張を準備する」を新設し、必要な拡張 4 件(remark、markdownlint、Markdown All in One、SpecDojo)の ID・役割・扱い、SpecDojo 拡張の VSIX からの導入手順と公開後の差し替え、提供機能 3 件(リンク表示・遷移、ID で開く、表整形)を記載した。guide-authoring-standard のタスク参照は拡張のコマンドへ追従済み。.vscode/extensions.json への追加は未公開 ID を推奨に入れないため公開後(PJR-0143 作業 6)とする。

PJR-0142 ドキュメント編集ガイドにVS Code拡張とSpecDojo拡張の説明を追加 ​

1. 概要 ​

specdojo:docs-editing-guide に、文書編集で用いる VS Code 拡張と SpecDojo 拡張の説明を追加する。

prj-0001:pjr-gx9d-vscode-extension-consolidation で定めた集約方針の 4 番目にあたる。 当初は prj-0001:pjr-0143-vs-code-marketplace の公開後に記述する順序だったが、公開に依存するのは 導入手順の 1 箇所だけであり、他は現時点で記述できる(2026-09-15 の判断)。導入手順は Marketplace 公開前の現行経路(vsix)で記述し、公開後の差し替えは PJR-0143 の作業とする。

2. 現状 ​

.vscode/extensions.json は次を推奨するが、ガイドに説明がない。

json
{ "recommendations": ["unifiedjs.vscode-remark", "davidanson.vscode-markdownlint"] }

SpecDojo 拡張そのものも推奨に含まれておらず、利用者は存在を知る手段がない。ガイドは Format Markdown Table タスクを名指しで参照しており、拡張へ集約した後は記述の追従が要る。

3. 完了条件 ​

  • ガイドに、文書編集へ必要な VS Code 拡張とその役割が記載されている。
  • SpecDojo 拡張の導入手順が記載されている。Marketplace 公開前は packages/vscode-specdojo で npm run package して code --install-extension する vsix の手順とし、公開後に Marketplace からの 導入へ差し替える旨を明記する。
  • 拡張が提供する機能([[id]] のリンク表示、ID による文書を開く、表整形)が説明されている。
  • Format Markdown Table タスクを参照する既存の記述が、拡張のコマンドへ追従している。 対象は specdojo:docs-editing-guide と specdojo:guide-authoring-standard。
  • .vscode/extensions.json の推奨へ SpecDojo 拡張を追加する時期を判断し、結果が反映されている。 Marketplace 未公開の拡張 ID を推奨に入れると VS Code が見つからないと表示するため、公開後に 追加する判断であれば、その旨を PJR-0143 の作業として記録する。
  • npm run -s lint:md と npm run docs:build が通る。

4. 検討事項 ​

  • 拡張を必須とするか推奨に留めるかを決める。必須にすると VS Code 以外の利用者を排除する。 表整形は CLI からも実行できるため、拡張なしでも作業は成立する。
  • タスクの撤去時期を判断する。集約方針では移行期間として当面残すとしている。ガイドの記述を 拡張へ寄せた時点で、タスクを非推奨として明示するかを決める。

5. 作業内容 ​

No作業担当状態メモ
1必要な VS Code 拡張と役割を記載するARCdoneremark、markdownlint、Markdown All in One、SpecDojo の役割を記載
2SpecDojo 拡張の導入手順を記載するARCdone公開前の VSIX 作成・導入手順と公開後の差し替えを記載
3提供機能を説明するARCdoneリンク表示・遷移、ID 指定による文書表示、表整形を記載
4タスク参照の記述を追従させるARCdoneガイドと standard が拡張のコマンドを参照することを確認・明確化
5extensions.json の推奨を判断するARCdone未公開 ID は追加せず、公開後の追加を PJR-0143 の作業として継続する

6. 対応結果 ​

  • specdojo:docs-editing-guide に、文書編集で使う VS Code 拡張の役割、SpecDojo 拡張の VSIX 導入手順、提供機能、文書インデックスの更新方法を追加した。
  • specdojo:guide-authoring-standard の表整形手順が SpecDojo VS Code 拡張のコマンドを 参照することを明確にした。
  • SpecDojo 拡張は Marketplace 未公開のため .vscode/extensions.json には追加しなかった。 Marketplace 公開後のガイド差し替えと推奨拡張への追加は prj-0001:pjr-0143-vs-code-marketplace の作業項目 6 で継続する。
  • 既存の .vscode/tasks.json の Format Markdown Table タスクは拡張コマンドへ委譲済みであり、 移行期間中の互換経路として残した。

7. 関連ドキュメント ​