spec-runner 1.1.7 → 1.1.9

package/bin/spec-runner.js

@@ -1,270 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-/**
- * spec-runner インストーラー（templates/.spec-runner ベース）
- *
- * ゴール:
- * - `npx spec-runner` または `npm exec spec-runner` を実行すると、
- *   プロジェクト直下に `./.spec-runner/` フォルダを作成する。
- * - Claude Code から `/spec-runner` を実行すれば、
- *   「現在フェーズ」と「やるべきステップ .md」が 1 本だけ返ってくる。
- * - メッセージ・ファイルはすべて日本語のみ。
- *
- * 重要:
- * - すでに `.spec-runner/` が存在する場合はデフォルトでは上書きしない。
- *   上書きしたい場合は、環境変数 `SPEC_RUNNER_FORCE=1` を付けて実行する。
- *
- * 必須テンプレ（パッケージ内）:
- * - templates/.spec-runner/project.json.example
- * - templates/.spec-runner/templates/phase-locks.json
- *
- * MkDocs（任意・プロジェクトルート）:
- * - templates/mkdocs-scaffold/ の mkdocs.yml / requirements-docs.txt / docs/index.md を
- *   未有効時のみコピー（憲章・設計書は既存の docs/01..06 をそのまま閲覧）
- */
-
-const fs = require("fs");
-const path = require("path");
-
-const CWD = process.cwd();
-const PKG_DIR = path.resolve(__dirname, "..");
-const TEMPLATE_SPEC_RUNNER_DIR = path.join(PKG_DIR, "templates", ".spec-runner");
-const DEST_DIR = path.join(CWD, ".spec-runner");
-const TEMPLATES_DIR = path.join(TEMPLATE_SPEC_RUNNER_DIR, "templates");
-const PHASE_LOCKS_TEMPLATE = path.join(TEMPLATES_DIR, "phase-locks.json");
-const MKDOCS_SCAFFOLD_DIR = path.join(PKG_DIR, "templates", "mkdocs-scaffold");
-const SKILLS_TEMPLATE_DIR = path.join(PKG_DIR, "templates", "skills");
-
-/** コピー時はスキップし、FORCE 時は消さない（ユーザー状態を保持） */
-const USER_STATE_BASENAMES = new Set([
-  "project.json",
-  "phase-locks.json",
-]);
-
-function log(msg) {
-  console.log(msg);
-}
-
-function info(msg) {
-  console.log(`ℹ ${msg}`);
-}
-
-function ok(msg) {
-  console.log(`✓ ${msg}`);
-}
-
-function error(msg) {
-  console.error(`ERROR: ${msg}`);
-}
-
-function exists(p) {
-  try {
-    fs.accessSync(p);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-function ensureTemplateDirOrExit() {
-  if (!exists(TEMPLATE_SPEC_RUNNER_DIR)) {
-    error("パッケージ内に templates/.spec-runner テンプレートが見つかりません。");
-    process.exit(1);
-  }
-  if (!exists(path.join(TEMPLATE_SPEC_RUNNER_DIR, "project.json.example"))) {
-    error("必須テンプレ project.json.example が見つかりません。");
-    process.exit(1);
-  }
-  if (!exists(PHASE_LOCKS_TEMPLATE)) {
-    error("必須テンプレ templates/phase-locks.json が見つかりません。");
-    process.exit(1);
-  }
-}
-
-function assertDestInstallableOrExit() {
-  const force = process.env.SPEC_RUNNER_FORCE === "1";
-  if (!exists(DEST_DIR)) return;
-  if (force) {
-    info("既存の .spec-runner/ を上書きします（SPEC_RUNNER_FORCE=1）。");
-    return;
-  }
-  error(".spec-runner/ フォルダがすでに存在します。");
-  info("上書きする場合は、環境変数 SPEC_RUNNER_FORCE=1 を付けて実行してください。");
-  info("例: SPEC_RUNNER_FORCE=1 npx spec-runner");
-  process.exit(1);
-}
-
-/** FORCE 時: テンプレから消えたファイルも反映できるよう、保持対象以外を削除 */
-function wipeDestExceptUserState() {
-  if (!exists(DEST_DIR) || process.env.SPEC_RUNNER_FORCE !== "1") return;
-  for (const entry of fs.readdirSync(DEST_DIR, { withFileTypes: true })) {
-    if (USER_STATE_BASENAMES.has(entry.name)) continue;
-    fs.rmSync(path.join(DEST_DIR, entry.name), { recursive: true, force: true });
-  }
-}
-
-function copyDirRecursively(src, dest, options = {}) {
-  const { skipNames = new Set() } = options;
-  if (!exists(src)) return;
-  const stat = fs.statSync(src);
-  if (!stat.isDirectory()) {
-    throw new Error(`ディレクトリではありません: ${src}`);
-  }
-
-  fs.mkdirSync(dest, { recursive: true });
-
-  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
-    if (skipNames.has(entry.name)) continue;
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-
-    if (entry.isDirectory()) {
-      copyDirRecursively(srcPath, destPath, { skipNames });
-    } else {
-      fs.mkdirSync(path.dirname(destPath), { recursive: true });
-      fs.copyFileSync(srcPath, destPath);
-      ok(path.relative(CWD, destPath));
-    }
-  }
-}
-
-function expandTemplateTree() {
-  copyDirRecursively(TEMPLATE_SPEC_RUNNER_DIR, DEST_DIR, {
-    skipNames: USER_STATE_BASENAMES,
-  });
-}
-
-function bootstrapProjectJson() {
-  const examplePath = path.join(TEMPLATE_SPEC_RUNNER_DIR, "project.json.example");
-  const projectJsonDest = path.join(DEST_DIR, "project.json");
-  fs.writeFileSync(projectJsonDest, fs.readFileSync(examplePath, "utf8"), "utf8");
-  ok(path.relative(CWD, projectJsonDest));
-}
-
-/**
- * フェーズ用 JSON は templates/.spec-runner/templates/*.json を正とする。
- * .spec-runner/ 直下に無いときだけコピー（既存のロックは上書きしない）。
- */
-function writeInitialLocks() {
-  const locksDest = path.join(DEST_DIR, "phase-locks.json");
-  if (!exists(locksDest)) {
-    fs.copyFileSync(PHASE_LOCKS_TEMPLATE, locksDest);
-    ok(path.relative(CWD, locksDest));
-  }
-}
-
-function installClaudeCommandIfPresent() {
-  const commandTmpl = path.join(PKG_DIR, "templates", "spec-runner-command.md");
-  if (!exists(commandTmpl)) return;
-  const claudeCmd = path.join(CWD, ".claude", "commands", "spec-runner.md");
-  fs.mkdirSync(path.dirname(claudeCmd), { recursive: true });
-  fs.writeFileSync(claudeCmd, fs.readFileSync(commandTmpl, "utf8"), "utf8");
-  ok(path.relative(CWD, claudeCmd));
-}
-
-function installClaudeSkillsTemplatesIfPresent() {
-  if (!exists(SKILLS_TEMPLATE_DIR)) return;
-  const destRoot = path.join(CWD, ".claude", "skills");
-  info("Skills テンプレート（不足分のみ）を .claude/skills に配置します...");
-
-  function walk(srcDir, rel = "") {
-    for (const entry of fs.readdirSync(srcDir, { withFileTypes: true })) {
-      const srcPath = path.join(srcDir, entry.name);
-      const relPath = path.join(rel, entry.name);
-      const destPath = path.join(destRoot, relPath);
-      if (entry.isDirectory()) {
-        walk(srcPath, relPath);
-      } else {
-        if (exists(destPath)) continue;
-        fs.mkdirSync(path.dirname(destPath), { recursive: true });
-        fs.copyFileSync(srcPath, destPath);
-        ok(path.relative(CWD, destPath));
-      }
-    }
-  }
-
-  walk(SKILLS_TEMPLATE_DIR);
-}
-
-/**
- * MkDocs + Material 用のファイルをプロジェクトルートに配置（未存在時のみ）。
- * 設計書本体は steps.json どおり docs/01..06 に置かれ、mkdocs の docs_dir でそのまま掲載する。
- */
-function copyFileIfMissing(src, dest) {
-  if (!exists(src) || exists(dest)) return false;
-  fs.mkdirSync(path.dirname(dest), { recursive: true });
-  fs.copyFileSync(src, dest);
-  ok(path.relative(CWD, dest));
-  return true;
-}
-
-function appendGitignoreVenvDocsIfNeeded() {
-  const gitignorePath = path.join(CWD, ".gitignore");
-  const marker = ".venv-docs/";
-  if (!exists(gitignorePath)) return;
-  const raw = fs.readFileSync(gitignorePath, "utf8");
-  const lines = raw.split(/\r?\n/);
-  if (lines.some((line) => /^\.venv-docs\/?$/.test(line.trim()))) return;
-  fs.appendFileSync(
-    gitignorePath,
-    `\n# spec-runner: MkDocs 用 Python 仮想環境\n${marker}\n`,
-    "utf8",
-  );
-  ok(`${path.relative(CWD, gitignorePath)}（${marker} を追記）`);
-}
-
-function installMkdocsScaffold() {
-  if (!exists(MKDOCS_SCAFFOLD_DIR)) {
-    info("MkDocs テンプレート（templates/mkdocs-scaffold）が見つかりません。スキップします。");
-    return;
-  }
-  info("MkDocs 用ファイル（不足分のみ）をプロジェクトルートに配置します...");
-  copyFileIfMissing(
-    path.join(MKDOCS_SCAFFOLD_DIR, "mkdocs.yml"),
-    path.join(CWD, "mkdocs.yml"),
-  );
-  copyFileIfMissing(
-    path.join(MKDOCS_SCAFFOLD_DIR, "requirements-docs.txt"),
-    path.join(CWD, "requirements-docs.txt"),
-  );
-  copyFileIfMissing(
-    path.join(MKDOCS_SCAFFOLD_DIR, "docs", "index.md"),
-    path.join(CWD, "docs", "index.md"),
-  );
-  appendGitignoreVenvDocsIfNeeded();
-}
-
-function printBanner() {
-  log("");
-  log("╔════════════════════════════════════════╗");
-  log("║        spec-runner インストーラ        ║");
-  log("║     フェーズ駆動 / 次のステップ方式     ║");
-  log("╚════════════════════════════════════════╝");
-  log("");
-}
-
-function printFooter() {
-  log("");
-  log("次のステップ（Claude Code 専用）:");
-  log("  /spec-runner を実行して");
-  log("");
-}
-
-function main() {
-  printBanner();
-  ensureTemplateDirOrExit();
-  installMkdocsScaffold();
-  assertDestInstallableOrExit();
-
-  info(".spec-runner/ を展開しています...");
-  wipeDestExceptUserState();
-  expandTemplateTree();
-  bootstrapProjectJson();
-  writeInitialLocks();
-  installClaudeCommandIfPresent();
-  installClaudeSkillsTemplatesIfPresent();
-  printFooter();
-}
-
-main();

package/docs/flow.md

@@ -1,72 +0,0 @@
-# spec-runner フロー（シンプル版）
-
-このドキュメントは、`templates/.spec-runner/scripts/spec-runner-core.sh` と `templates/.spec-runner/steps/steps.json` に合わせた最新フローを説明する。
-
-## 入口コマンド
-
-| 用途 | コマンド |
-|---|---|
-| 次のステップ | `./.spec-runner/spec-runner.sh 次のステップ --json` |
-| lock 状態表示 | `./.spec-runner/spec-runner.sh 次のステップ --lock` |
-
-## 設計方針
-
-- `spec-runner` は **薄いオーケストレータ**（次の一手を返す）
-- 正本は `docs/work.md`
-- 主線は 6 ステップ（実行フェーズは5本 + 憲章）、横断は 2 ステップ
-- ブランチ運用やグレード判定は強制しない
-
-## 主線 6 ステップ
-
-1. `charter`（憲章）
-2. `uc_spec`（仕様策定）
-3. `domain`（ドメイン設計）
-4. `architecture_plan`（実装計画）
-5. `test_design`（テスト設計）
-6. `implement`（実装）
-
-※ 運用上は「実行フェーズ5本（仕様→ドメイン→計画→テスト→実装）+ 憲章」で扱う。
-
-## 横断 2 ステップ
-
-- `clarify`（曖昧さ解消）
-- `analyze`（分析）
-
-これらは任意タイミングで使う補助ステップ。主線フェーズを増やさない。
-
-## 次ステップ判定（概要）
-
-`spec-runner-core.sh` は lock と成果物から次を返す。
-
-1. `charter.completed` が false  
-   - 憲章が未整備なら `charter`
-   - 憲章があるなら `clarify` / `analyze` を先に返すことがある
-2. `uc_discovery.completed` が false  
-   - 未レビュー UC があれば `clarify` / `analyze`（UC 整合性チェック）
-   - すべてレビュー済みなら `uc_spec`（次 UC 作成）
-3. `domain.completed` が false  
-   - 未レビュー UC が 1 件でも残っていれば先に `clarify` / `analyze`
-   - 全 UC レビュー済みなら `domain`（必要に応じ `clarify` / `analyze`）
-4. `architecture.completed` が false  
-   - `architecture_plan`（必要に応じ `clarify` / `analyze`）
-   - lock が true でも、設計成果物（`docs/03` / `docs/04` の `.md`）が無い場合は該当設計フェーズに戻る
-5. 最新 UC がレビュー済みかつテスト準備済み  
-   - `implement`  
-   それ以外は `test_design`
-
-## 正本（Single Source）
-
-- フロー定義: `.spec-runner/steps/steps.json`
-- 進行状態: `.spec-runner/phase-locks.json`
-- 作業正本: `docs/work.md`
-- 仕様本文: `docs/01..06`, `docs/02_ユースケース仕様/**`
-- 実装検証: `tests/**`, `test_command.run`
-
-## 運用ルール（最小）
-
-1. 実装前に `docs/work.md` の受入条件を埋める
-2. 作業中は `docs/work.md` のタスクを更新する
-3. コミット前に `docs/work.md` の `- [ ]` を確認する
-4. 完了時に `docs/work.md` の検証結果を更新する
-5. UC を十分に作ってレビュー完了したら `uc_discovery.completed` を `true` にする
-6. カテゴリは箱として扱い、1カテゴリに UC を複数（目安 2〜3 件以上）用意してからドメインへ進む

package/templates/.spec-runner/project.json.example

@@ -1,27 +0,0 @@
-{
-  "_comment": "AI が編集して作成。other_work_prefixes は UC 以外の作業用ブランチ（例: feature/cicd/xxx）。",
-  "_comment_required_docs": "required_docs は steps.json を単一ソースにするため、\"steps:<common.docsキー>[/suffix]\" を指定できる（例: steps:openapi, steps:domain_root/集約.md）。",
-  "naming": {
-    "branch_prefix": "feature",
-    "uc_id_pattern": "UC-[0-9]+",
-    "uc_spec_basename": "{uc_id}-{slug}.md",
-    "adr_basename": "MMDD-{title}.md",
-    "docs_05_categories": true,
-    "other_work_prefixes": ["work", "infra", "cicd"]
-  },
-  "required_docs": {
-    "charter": ["steps:charter"],
-    "domain": ["steps:domain_root/ユビキタス言語辞書.md", "steps:domain_root/ドメインモデル.md", "steps:domain_root/集約.md"],
-    "architecture": ["steps:architecture_root/パターン選定.md", "steps:architecture_root/インフラ方針.md", "steps:architecture_root/設計判断記録"],
-    "grade_a": ["steps:infra_root/schema.dbml"],
-    "gate3_openapi": ["steps:openapi"]
-  },
-  "test_design": {
-    "dir": "tests",
-    "pattern": "*.spec.*",
-    "require_uc_prefixed_tests": false
-  },
-  "test_command": {
-    "run": "npm test"
-  }
-}