spec-runner 1.0.1 → 1.0.3

package/README.md

@@ -32,6 +32,14 @@ npx spec-runner
 対話では**どの開発環境か**だけ聞かれる（AI ツール・CI・ドキュメント言語）。  
 ここまでで、`.spec-runner/config.sh`（既定値）と `scripts/`・`docs/`・`.github/` などができる。
 
+### 3.5 プロジェクトの土台を書く（推奨・init の前）
+
+- **`docs/01_憲章.md`** … プロジェクト憲章（不変原則・品質ルール・フォルダ構成の考え方）。技術に依存しない。
+- **`docs/02_仕様.md`** … 何を作るか・なぜか・スコープ・想定ユーザー。
+
+チャットで `/sr-憲章` または `/sr-仕様` と入力すると編集を案内できる。  
+（[Spec Kit](https://github.com/tessl-labs/spec-kit) の constitution / specify に相当。）
+
 ### 4. init で詳細設定と最初のユースケースを開始する
 
 ```bash
@@ -46,7 +54,7 @@ npx spec-runner
 - Domain が import してはいけないパターン（正規表現）
 - DDD を使うか / TDD を必須にするか / CI / ドキュメントの言語
 
-設定後、`docs/requirements/会員登録.md` ができ、ブランチ `feature/uc-会員登録` が作られる。
+設定後、`docs/01_要件/会員登録.md` ができ、ブランチ `feature/uc-会員登録` が作られる。
 
 - 引数なしで `./scripts/spec-runner.sh init` だけ実行すると、**設定対話のみ**（ユースケースは作らない）。
 - すでに設定済みの場合は対話をスキップし、そのままユースケース作成に進む。
@@ -55,28 +63,28 @@ npx spec-runner
 
 ```
 ① 要件定義
-   docs/requirements/会員登録.md を書く
+   docs/01_要件/会員登録.md を書く
 
 ② 要件レビュー通過
-   ./scripts/spec-runner.sh review-pass docs/requirements/会員登録.md
+   ./scripts/spec-runner.sh review-pass docs/01_要件/会員登録.md
    ./scripts/spec-runner.sh set-gate glossary_checked
 
 ③ 概要設計
    ./scripts/spec-runner.sh design-high
-   docs/high-level/会員登録.md を書く → review-pass
+   docs/02_概要設計/会員登録.md を書く → review-pass
 
 ④ 詳細設計（この順）
-   ./scripts/spec-runner.sh design-detail domain   → domain.md を書く → review-pass
-   ./scripts/spec-runner.sh design-detail usecase  → usecase.md を書く → review-pass
-   ./scripts/spec-runner.sh design-detail table    → table.md を書く → review-pass
-   ./scripts/spec-runner.sh design-detail infra   → infra.md を書く → review-pass
+   ./scripts/spec-runner.sh design-detail domain   → ドメイン.md を書く → review-pass
+   ./scripts/spec-runner.sh design-detail usecase  → ユースケース.md を書く → review-pass
+   ./scripts/spec-runner.sh design-detail table    → テーブル.md を書く → review-pass
+   ./scripts/spec-runner.sh design-detail infra   → インフラ.md を書く → review-pass
 
 ⑤ テスト設計
    ./scripts/spec-runner.sh test-design
-   docs/test-design/会員登録.md を書く
+   docs/04_テスト設計/会員登録.md を書く
    テストコードを先に書く（Red）→ コミット
    ./scripts/spec-runner.sh set-gate test_code_committed
-   ./scripts/spec-runner.sh review-pass docs/test-design/会員登録.md
+   ./scripts/spec-runner.sh review-pass docs/04_テスト設計/会員登録.md
 
 ⑥ 実装
    ./scripts/spec-runner.sh implement
@@ -120,6 +128,22 @@ curl -sSL https://raw.githubusercontent.com/spec-runner/spec-runner/main/install
 
 ---
 
+## Spec Kit との対応
+
+[Spec Kit](https://github.com/tessl-labs/spec-kit) 風の「憲章 → 仕様 → 計画 → 実装」を取り入れている。
+
+| Spec Kit | spec-runner での対応 |
+|----------|----------------------|
+| ① constitution（憲章） | `docs/01_憲章.md`。不変原則・品質ルール。`/sr-憲章` |
+| ② specify（仕様） | `docs/02_仕様.md`（プロジェクト全体）+ `docs/01_要件/<UC>.md`（機能単位）。`/sr-仕様` |
+| ③ clarify（曖昧さ解消） | 各フェーズのレビュー・`docs/03_用語集.md` での用語統一 |
+| ④ plan（技術計画） | `design-high` → `design-detail`（domain / usecase / table / infra） |
+| ⑤ analyze（整合性） | `review-pass` と CI の phase-gate-check |
+| ⑥ tasks（タスク分割） | テスト設計・実装フェーズでのタスク単位の進め方 |
+| ⑦ implement | `implement` → `complete` |
+
+---
+
 ## 設定
 
 `.spec-runner/config.sh` でパスやコマンドを変えられる。CI とゲートはこの設定を参照する。
@@ -140,9 +164,23 @@ curl -sSL https://raw.githubusercontent.com/spec-runner/spec-runner/main/install
 ├── .github/
 │   ├── workflows/phase-gate-check.yml
 │   └── PULL_REQUEST_TEMPLATE.md
-├── docs/                # 要件・概要・詳細設計・テスト設計
+├── docs/                # 付番済み（01_〜04_、99_）要件・概要・詳細設計・テスト設計・設計判断記録
 ├── scripts/spec-runner.sh
-└── templates/requirement/template.md
+└── templates/           # すべてのテンプレート（DDD用語・付番は日本語）
+    ├── 01_要件定義/ひな形.md   # init で docs/01_要件/<UC>.md を生成
+    ├── 03_詳細設計/            # design-detail で docs/03_詳細設計/<UC>/*.md を生成
+    │   ├── ドメイン.md
+    │   ├── ユースケース.md
+    │   ├── テーブル.md
+    │   └── インフラ.md
+    ├── 99_設計判断記録/ひな形.md  # ADR ひな形（docs/99_設計判断記録/ にもコピー）
+    └── 初期ドキュメント/        # deploy 時に docs/ に展開
+        ├── 01_憲章.md
+        ├── 02_仕様.md
+        ├── 03_用語集.md
+        ├── テンプレート一覧.md
+        ├── 振り返り/負債.md
+        └── 99_設計判断記録/.gitkeep
 ```
 
 選択した AI ツールに応じて `.claude/` や `.cursorrules` や `.github/copilot-instructions.md` などが追加される。
@@ -161,21 +199,23 @@ npx spec-runner --update
 
 ## スラッシュコマンド
 
-**`/sr-status` を実行すると、現在のフェーズと「次にやるべきこと」（次に打つコマンド）が動的に表示される。** フェーズ移行（概要設計〜実装完了）はこの案内に従えばよい。
+**`/sr-状態` を実行すると、現在のフェーズと「次にやるべきこと」（次に打つコマンド）が動的に表示される。** フェーズ移行（概要設計〜実装完了）はこの案内に従えばよい。
 
 | コマンド | 説明 |
 |----------|------|
-| `/sr-configure` | 詳細設定の対話のみ |
-| `/sr-init` [ユースケース名] [集約名] | ユースケース開始（未設定時は対話から） |
-| `/sr-status` | フェーズ・ゲート＋**次にやるべきこと**を表示 |
-| `/sr-review` ファイル | レビュー通過 |
-| `/sr-set-gate` ゲート名 | ゲート手動通過 |
-| `/sr-fix` 内容 | 修正 |
-| `/sr-hotfix` 内容 | 緊急修正 |
-
-design-high / design-detail / test-design / implement / complete は、status の案内に表示されるので個別に指定不要。
-
-定義: Claude `.claude/commands/` / Cursor `.cursor/commands/` / Copilot `.github/prompts/*.prompt.md`
+| `/sr-設定` | 詳細設定の対話のみ |
+| `/sr-憲章` | プロジェクト憲章（`docs/01_憲章.md`）を編集（init 前推奨） |
+| `/sr-仕様` | プロジェクト仕様（`docs/02_仕様.md`）を編集（init 前推奨） |
+| `/sr-初期化` [ユースケース名] [集約名] | ユースケース開始（未設定時は対話から） |
+| `/sr-状態` | フェーズ・ゲート＋**次にやるべきこと**を表示 |
+| `/sr-レビュー` ファイル | レビュー通過 |
+| `/sr-ゲート設定` ゲート名 | ゲート手動通過 |
+| `/sr-修正` 内容 | 修正 |
+| `/sr-緊急修正` 内容 | 緊急修正 |
+
+概要設計・詳細設計・テスト設計・実装・完了は、`/sr-状態` の案内に表示されるので個別に指定不要。
+
+定義: Claude `.claude/commands/` / Cursor `.cursor/commands/` / Copilot `.github/prompts/*.prompt.md`（いずれもファイル名・コマンド名は日本語）
 
 ---
 

package/bin/spec-runner.js

@@ -31,6 +31,8 @@ try {
 
 // ── 定数 ──────────────────────────────────────────────────────────────────────
 const PKG_DIR    = path.resolve(__dirname, '..');
+const PKG_JSON   = (() => { try { return require(path.join(PKG_DIR, 'package.json')); } catch { return {}; } })();
+const VERSION    = PKG_JSON.version || '?.?.?';
 const CWD        = process.cwd();
 const CONFIG_DIR = path.join(CWD, '.spec-runner');
 const CONFIG_SH  = path.join(CONFIG_DIR, 'config.sh');
@@ -152,7 +154,8 @@ const DEFAULT_STRUCTURE = {
 async function main() {
   log('');
   log(chalk.bold('╔════════════════════════════════════════╗'));
-  log(chalk.bold('║     spec-runner  v1.0.0-alpha           ║'));
+  const verPad = Math.max(0, 17 - String(VERSION).length);
+  log(chalk.bold(`║     spec-runner  v${VERSION}${' '.repeat(verPad)}║`));
   log(chalk.bold('║  AI-driven DDD Phase Gate System       ║'));
   log(chalk.bold('╚════════════════════════════════════════╝'));
   log('');
@@ -276,8 +279,14 @@ async function main() {
   log(chalk.bold.green('✅ spec-runner のセットアップが完了しました！'));
   log('');
   log(chalk.bold('次のステップ:'));
+  log('  • まずプロジェクトの土台を書く（init の前に行う）:');
+  log(chalk.cyan('    docs/01_憲章.md  … 不変原則・品質ルール（プロジェクト憲章）'));
+  log(chalk.cyan('    docs/02_仕様.md  … 何を作るか・なぜか・スコープ（仕様）'));
+  log('    チャットで /sr-憲章 または /sr-仕様 と入力すると編集を案内できます。');
+  log('');
   log('  • パス・TDD 等の設定と最初のユースケース開始:');
   log(chalk.cyan('       ./scripts/spec-runner.sh init "ユースケース名" "集約名"'));
+  log('    またはチャットで: ' + chalk.cyan('/sr-初期化 ユースケース名 集約名'));
   log('');
   log('  init を実行すると対話で Domain/UseCase のパスやテスト設定を聞かれます。');
   log('  引数なしで init だけ実行すると設定対話のみ行えます。');
@@ -361,10 +370,22 @@ async function deployFiles(answers) {
   log('');
   log(chalk.bold('展開するファイル:'));
 
-  // 1. 共通（base）: scripts, docs, templates, .github/workflows, .github/PULL_REQUEST_TEMPLATE
+  // 1. 共通（base）: scripts, templates（生成用＋初期ドキュメント）, .github
   copyPathFrom(baseDir, 'scripts');
-  copyPathFrom(baseDir, 'docs');
   copyPathFrom(baseDir, 'templates');
+  // templates/初期ドキュメント/ の中身を docs/ に展開（憲章・仕様・用語集等）
+  const docsInitialSrc = path.join(CWD, 'templates', '初期ドキュメント');
+  const docsDest = path.join(CWD, 'docs');
+  if (fs.existsSync(docsInitialSrc)) {
+    copyDir(docsInitialSrc, docsDest, vars);
+  }
+  // 生成用テンプレートのうち設計判断記録ひな形は docs/99_設計判断記録/ にも置く（新規 ADR 作成時のコピー元）
+  const adrTemplateSrc = path.join(CWD, 'templates', '99_設計判断記録', 'ひな形.md');
+  const adrTemplateDest = path.join(CWD, 'docs', '99_設計判断記録', 'ひな形.md');
+  if (fs.existsSync(adrTemplateSrc)) {
+    fs.mkdirSync(path.dirname(adrTemplateDest), { recursive: true });
+    if (!isDryRun) fs.copyFileSync(adrTemplateSrc, adrTemplateDest);
+  }
   copyPathFrom(baseDir, '.github/workflows');
   copyPathFrom(baseDir, '.github/PULL_REQUEST_TEMPLATE.md');
 
@@ -685,10 +706,10 @@ async function runUpdate() {
     DATE:                      new Date().toISOString().slice(0, 10),
   };
 
-  // 要件テンプレートが無ければ追加（init で必須のため）
-  const requirementTemplateDest = path.join(CWD, 'templates', 'requirement', 'template.md');
+  // 要件定義テンプレートが無ければ追加（init で必須のため）
+  const requirementTemplateDest = path.join(CWD, 'templates', '01_要件定義', 'ひな形.md');
   if (!fs.existsSync(requirementTemplateDest)) {
-    const requirementTemplateSrc = path.join(templatesDir, 'base', 'templates', 'requirement', 'template.md');
+    const requirementTemplateSrc = path.join(templatesDir, 'base', 'templates', '01_要件定義', 'ひな形.md');
     if (fs.existsSync(requirementTemplateSrc)) {
       copyFile(requirementTemplateSrc, requirementTemplateDest, vars);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-runner",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "AI-driven DDD phase gate system — design-first enforcement for Claude Code, Cursor, and Copilot",
   "license": "MIT",
   "bin": {

package/templates/base/.github/PULL_REQUEST_TEMPLATE.md

@@ -16,21 +16,21 @@
 
 | ドキュメント | 更新済み | パス |
 |------------|---------|------|
-| ドメインモデル設計 | [ ] | docs/detailed/*/domain.md |
-| ユースケース設計 | [ ] | docs/detailed/*/usecase.md |
-| テーブル設計 | [ ] | docs/detailed/*/table.md |
-| インフラ設計 | [ ] | docs/detailed/*/infra.md |
-| テスト設計 | [ ] | docs/test-design/*.md |
-| glossary.md | [ ] | docs/glossary.md |
-| ADR | [ ] / N/A | docs/adr/XXX-*.md |
+| ドメインモデル設計 | [ ] | docs/03_詳細設計/*/ドメイン.md |
+| ユースケース設計 | [ ] | docs/03_詳細設計/*/ユースケース.md |
+| テーブル設計 | [ ] | docs/03_詳細設計/*/テーブル.md |
+| インフラ設計 | [ ] | docs/03_詳細設計/*/インフラ.md |
+| テスト設計 | [ ] | docs/04_テスト設計/*.md |
+| 用語集 | [ ] | docs/03_用語集.md |
+| ADR | [ ] / N/A | docs/99_設計判断記録/XXX-*.md |
 
 ---
 
 ## レビュアー向け読み順
 
-1. **設計ドキュメント** `docs/detailed/<UC名>/` — 何を作るか
-2. **ADR** `docs/adr/` — なぜその設計か（該当する場合）
-3. **テスト設計** `docs/test-design/<UC名>.md` — 何を検証するか
+1. **設計ドキュメント** `docs/03_詳細設計/<UC名>/` — 何を作るか
+2. **ADR** `docs/99_設計判断記録/` — なぜその設計か（該当する場合）
+3. **テスト設計** `docs/04_テスト設計/<UC名>.md` — 何を検証するか
 4. **テストコード** — 振る舞いの確認
 5. **実装コード** — 設計との整合性確認
 
@@ -40,4 +40,4 @@
 
 - 影響ユースケース:
 - 修正内容の要約:
-- debt.md への記録: [ ] 完了
+- 負債.md への記録: [ ] 完了（docs/振り返り/負債.md）

package/templates/base/.github/workflows/phase-gate-check.yml

@@ -72,45 +72,45 @@ jobs:
           echo "$CHANGED"
           echo ""
 
-          # DOMAIN_PATH が変更されたら docs/detailed/*/domain.md も更新が必要
+          # DOMAIN_PATH が変更されたら docs/03_詳細設計/*/ドメイン.md も更新が必要
           if [[ -n "$DOMAIN_PATH" ]]; then
             DOMAIN_CHANGED=$(echo "$CHANGED" | grep -E "^${DOMAIN_PATH}/" || true)
             if [[ -n "$DOMAIN_CHANGED" ]]; then
-              DETAIL_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/detailed/.*/domain\.md' || true)
+              DETAIL_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/03_詳細設計/.*/ドメイン\.md' || true)
               if [[ -z "$DETAIL_DOC_CHANGED" ]]; then
-                echo "✗ $DOMAIN_PATH/ が変更されましたが docs/detailed/*/domain.md が更新されていません"
+                echo "✗ $DOMAIN_PATH/ が変更されましたが docs/03_詳細設計/*/ドメイン.md が更新されていません"
                 echo "$DOMAIN_CHANGED" | sed 's/^/    /'
                 ERRORS=$((ERRORS + 1))
               else
-                echo "✓ $DOMAIN_PATH/ 変更 → domain.md 更新確認"
+                echo "✓ $DOMAIN_PATH/ 変更 → ドメイン.md 更新確認"
               fi
             fi
           fi
 
-          # USECASE_PATH が変更されたら docs/detailed/*/usecase.md も更新が必要
+          # USECASE_PATH が変更されたら docs/03_詳細設計/*/ユースケース.md も更新が必要
           if [[ -n "$USECASE_PATH" ]]; then
             USECASE_CHANGED=$(echo "$CHANGED" | grep -E "^${USECASE_PATH}/" || true)
             if [[ -n "$USECASE_CHANGED" ]]; then
-              USECASE_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/detailed/.*/usecase\.md' || true)
+              USECASE_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/03_詳細設計/.*/ユースケース\.md' || true)
               if [[ -z "$USECASE_DOC_CHANGED" ]]; then
-                echo "✗ $USECASE_PATH/ が変更されましたが docs/detailed/*/usecase.md が更新されていません"
+                echo "✗ $USECASE_PATH/ が変更されましたが docs/03_詳細設計/*/ユースケース.md が更新されていません"
                 ERRORS=$((ERRORS + 1))
               else
-                echo "✓ $USECASE_PATH/ 変更 → usecase.md 更新確認"
+                echo "✓ $USECASE_PATH/ 変更 → ユースケース.md 更新確認"
               fi
             fi
           fi
 
-          # MIGRATION_DIR が変更されたら docs/detailed/*/table.md も更新が必要
+          # MIGRATION_DIR が変更されたら docs/03_詳細設計/*/テーブル.md も更新が必要
           if [[ -n "$MIGRATION_DIR" ]]; then
             MIGRATION_CHANGED=$(echo "$CHANGED" | grep -E "^${MIGRATION_DIR}/" || true)
             if [[ -n "$MIGRATION_CHANGED" ]]; then
-              TABLE_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/detailed/.*/table\.md' || true)
+              TABLE_DOC_CHANGED=$(echo "$CHANGED" | grep -E 'docs/03_詳細設計/.*/テーブル\.md' || true)
               if [[ -z "$TABLE_DOC_CHANGED" ]]; then
-                echo "✗ $MIGRATION_DIR/ が変更されましたが docs/detailed/*/table.md が更新されていません"
+                echo "✗ $MIGRATION_DIR/ が変更されましたが docs/03_詳細設計/*/テーブル.md が更新されていません"
                 ERRORS=$((ERRORS + 1))
               else
-                echo "✓ $MIGRATION_DIR/ 変更 → table.md 更新確認"
+                echo "✓ $MIGRATION_DIR/ 変更 → テーブル.md 更新確認"
               fi
             fi
           fi
@@ -129,10 +129,10 @@ jobs:
         run: |
           BRANCH="${{ github.head_ref }}"
           if [[ "$BRANCH" =~ ^hotfix/ ]]; then
-            if git diff --name-only origin/${{ github.base_ref }}...HEAD | grep -q 'docs/review/debt.md'; then
-              echo "✓ hotfix: debt.md への記録確認"
+            if git diff --name-only origin/${{ github.base_ref }}...HEAD | grep -q 'docs/振り返り/負債.md'; then
+              echo "✓ hotfix: 負債.md への記録確認"
             else
-              echo "✗ hotfix PR では docs/review/debt.md への負債記録が必要です"
+              echo "✗ hotfix PR では docs/振り返り/負債.md への負債記録が必要です"
               echo "  ./scripts/spec-runner.sh hotfix を使用してください"
               exit 1
             fi
@@ -174,8 +174,8 @@ jobs:
       - name: ADR 対応コードリンクチェック
         run: |
           WARNINGS=0
-          if [[ -d "docs/adr" ]]; then
-            for adr in docs/adr/[0-9]*.md; do
+          if [[ -d "docs/99_設計判断記録" ]]; then
+            for adr in docs/99_設計判断記録/[0-9]*.md; do
               [[ -f "$adr" ]] || continue
               # 「## 対応コード」セクションからファイルパスを抽出
               code_refs=$(awk '/^## 対応コード/{found=1; next} /^## /{found=0} found && /`.*\.(php|ts|tsx)`/{print}' "$adr" | grep -oP '`[^`]+`' | tr -d '`' || true)
@@ -196,8 +196,8 @@ jobs:
             echo "✓ ADR対応コードリンク: OK"
           fi
 
-      # ─── 6. glossary.md の新エンティティチェック（config.sh の DOMAIN_PATH / SOURCE_EXTENSIONS）──
-      - name: 新規Domain classのglossary.md登録チェック
+      # ─── 6. 用語集.md の新エンティティチェック（config.sh の DOMAIN_PATH / SOURCE_EXTENSIONS）──
+      - name: 新規Domain classの用語集登録チェック
         env:
           DOMAIN_PATH: ${{ env.DOMAIN_PATH }}
           SOURCE_EXTENSIONS: ${{ env.SOURCE_EXTENSIONS }}
@@ -207,10 +207,10 @@ jobs:
           NEW_DOMAIN=$(echo "$CHANGED" | grep -E "^${DOMAIN_PATH}/.*\.(${EXT_PATTERN})$" | xargs git diff --diff-filter=A --name-only origin/${{ github.base_ref }}...HEAD 2>/dev/null || true)
 
           if [[ -n "$NEW_DOMAIN" && -n "$DOMAIN_PATH" ]]; then
-            if echo "$CHANGED" | grep -q 'docs/glossary.md'; then
-              echo "✓ 新規Domainクラス追加 → glossary.md 更新確認"
+            if echo "$CHANGED" | grep -q 'docs/03_用語集.md'; then
+              echo "✓ 新規Domainクラス追加 → 用語集.md 更新確認"
             else
-              echo "⚠ 新規Domainクラスが追加されましたが glossary.md が更新されていません"
+              echo "⚠ 新規Domainクラスが追加されましたが 用語集.md が更新されていません"
               echo "  新しいエンティティ/値オブジェクトにはユビキタス言語の追加が必要です"
             fi
           fi