@haiyangbg/buildbeat 2.0.2 → 3.0.0

package/src/cli.js

@@ -1,323 +0,0 @@
-import { createInterface } from "node:readline/promises";
-
-import { CLI_VERSION, OUTPUT_SCHEMA_VERSION } from "./constants.js";
-import { formatDoctor, runDoctor } from "./doctor.js";
-import { buildPlan, formatPlan } from "./planner.js";
-import { applyUpgrade, buildUpgradePlan, formatUpgradePlan } from "./upgrader.js";
-import { applyScaffold, WriteError } from "./writer.js";
-
-const HELP = `BuildBeat CLI v${CLI_VERSION} (Wave 2 source candidate)
-
-Usage:
-  buildbeat doctor [path] [--json]
-  buildbeat init [path] [--dry-run] [--layout default|compact] [--json] [--yes]
-  buildbeat adopt [path] [--dry-run] [--layout default|compact] [--json] [--yes]
-  buildbeat upgrade [path] [--dry-run] [--json] [--force] [--major]
-  buildbeat version
-
-init/adopt write only after a blocker-free plan and confirmation; --yes skips
-only that prompt. upgrade is schema-2-only and requires a clean target-root Git
-worktree. diff and uninstall remain unavailable.
-
-Legacy compatibility: the published npm package and solobaton executable alias
-remain available during the BuildBeat namespace migration.`;
-
-class UsageError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "UsageError";
-  }
-}
-
-function parse(args) {
-  if (args.length === 0) {
-    return {
-      command: "help",
-      target: ".",
-      json: false,
-      dryRun: false,
-      layout: null,
-      yes: false,
-      force: false,
-      major: false,
-      targetProvided: false,
-    };
-  }
-  const options = {
-    command: args[0],
-    target: ".",
-    json: false,
-    dryRun: false,
-    yes: false,
-    force: false,
-    major: false,
-    layout: null,
-    help: false,
-    targetProvided: false,
-  };
-  let targetSeen = false;
-  for (let index = 1; index < args.length; index += 1) {
-    const token = args[index];
-    if (token === "--json") {
-      options.json = true;
-    } else if (token === "--dry-run") {
-      options.dryRun = true;
-    } else if (token === "--yes") {
-      options.yes = true;
-    } else if (token === "--force") {
-      options.force = true;
-    } else if (token === "--major") {
-      options.major = true;
-    } else if (token === "--help" || token === "-h") {
-      options.help = true;
-    } else if (token === "--layout") {
-      index += 1;
-      if (index >= args.length) {
-        throw new UsageError("--layout requires default or compact.");
-      }
-      options.layout = args[index];
-    } else if (token.startsWith("--layout=")) {
-      options.layout = token.slice("--layout=".length);
-    } else if (token.startsWith("-")) {
-      throw new UsageError(`Unknown option: ${token}`);
-    } else if (!targetSeen) {
-      options.target = token;
-      targetSeen = true;
-      options.targetProvided = true;
-    } else {
-      throw new UsageError(`Unexpected argument: ${token}`);
-    }
-  }
-  if (options.layout && !["default", "compact"].includes(options.layout)) {
-    throw new UsageError("--layout must be default or compact.");
-  }
-  return options;
-}
-
-async function confirmPlan(io, plan) {
-  if (typeof io.confirm === "function") {
-    return Boolean(await io.confirm(plan));
-  }
-  if (!io.stdin?.isTTY || !io.stderr) {
-    return null;
-  }
-  const readline = createInterface({ input: io.stdin, output: io.stderr });
-  try {
-    const answer = await readline.question("Apply this BuildBeat plan? [y/N] ");
-    return /^(?:y|yes)$/i.test(answer.trim());
-  } finally {
-    readline.close();
-  }
-}
-
-function outputJson(io, value) {
-  io.stdout.write(`${JSON.stringify(value, null, 2)}\n`);
-}
-
-function commandLabel(value) {
-  if (typeof value !== "string" || value.length === 0) {
-    return null;
-  }
-  return value
-    .replace(/[\u0000-\u001f\u007f]+/g, " ")
-    .replace(/\s+/g, " ")
-    .trim()
-    .slice(0, 80) || null;
-}
-
-function writeError(io, message, { json = false, code = "usage", command = null } = {}) {
-  if (json) {
-    outputJson(io, {
-      schemaVersion: OUTPUT_SCHEMA_VERSION,
-      command: commandLabel(command),
-      cliVersion: CLI_VERSION,
-      ok: false,
-      error: { code, message },
-    });
-  } else {
-    io.stderr.write(`Error: ${message}\n`);
-  }
-}
-
-export async function run(
-  args,
-  io = { stdin: process.stdin, stdout: process.stdout, stderr: process.stderr },
-) {
-  let options;
-  try {
-    options = parse(args);
-  } catch (error) {
-    writeError(io, error.message, {
-      json: args.includes("--json"),
-      command: args[0] || null,
-    });
-    return 2;
-  }
-
-  if (options.help || options.command === "help" || options.command === "--help") {
-    io.stdout.write(`${HELP}\n`);
-    return 0;
-  }
-  if (options.command === "version" || options.command === "--version" || options.command === "-v") {
-    if (
-      options.targetProvided ||
-      options.json ||
-      options.dryRun ||
-      options.yes ||
-      options.force ||
-      options.major ||
-      options.layout
-    ) {
-      writeError(io, "version does not accept a path or options.", {
-        json: options.json,
-        command: options.command,
-      });
-      return 2;
-    }
-    io.stdout.write(`${CLI_VERSION}\n`);
-    return 0;
-  }
-
-  try {
-    if (options.command === "doctor") {
-      if (options.layout || options.dryRun || options.yes || options.force || options.major) {
-        throw new UsageError("doctor accepts only [path] and --json.");
-      }
-      const report = runDoctor(options.target);
-      if (options.json) {
-        outputJson(io, report);
-      } else {
-        io.stdout.write(`${formatDoctor(report)}\n`);
-      }
-      return report.ok ? 0 : 1;
-    }
-
-    if (options.command === "init" || options.command === "adopt") {
-      if (options.force || options.major) {
-        throw new UsageError(`${options.command} does not accept --force or --major.`);
-      }
-      if (options.dryRun && options.yes) {
-        throw new UsageError("--yes cannot be combined with --dry-run.");
-      }
-      const layout = options.layout || (options.command === "adopt" ? "compact" : "default");
-      const now = new Date();
-      const plan = buildPlan({
-        mode: options.command,
-        target: options.target,
-        layout,
-        preview: options.dryRun,
-        now,
-      });
-
-      if (options.dryRun || !plan.ready) {
-        if (options.json) {
-          outputJson(io, plan);
-        } else {
-          io.stdout.write(`${formatPlan(plan)}\n`);
-        }
-        return plan.ready ? 0 : 1;
-      }
-
-      if (!options.json) {
-        io.stdout.write(`${formatPlan(plan)}\n`);
-      } else if (options.yes || io.stdin?.isTTY) {
-        io.stderr.write(`${formatPlan(plan)}\n`);
-      }
-
-      if (!options.yes) {
-        const confirmed = await confirmPlan(io, plan);
-        if (confirmed === null) {
-          writeError(
-            io,
-            "Interactive confirmation is unavailable. Re-run with --yes only after reviewing --dry-run output.",
-            {
-              json: options.json,
-              code: "confirmation_required",
-              command: options.command,
-            },
-          );
-          return 2;
-        }
-        if (!confirmed) {
-          if (options.json) {
-            outputJson(io, { ...plan, cancelled: true });
-          } else {
-            io.stdout.write("\nCancelled. No files changed.\n");
-          }
-          return 0;
-        }
-      }
-
-      const result = applyScaffold(plan, { now });
-      if (options.json) {
-        outputJson(io, result);
-      } else {
-        io.stdout.write(`\n${formatPlan(result)}\n`);
-      }
-      return 0;
-    }
-
-    if (options.command === "upgrade") {
-      if (options.layout || options.yes) {
-        throw new UsageError("upgrade accepts only [path], --dry-run, --json, --force, and --major.");
-      }
-      const now = new Date();
-      const plan = buildUpgradePlan({
-        target: options.target,
-        preview: options.dryRun,
-        force: options.force,
-        major: options.major,
-        now,
-      });
-      if (options.dryRun || !plan.ready || plan.upToDate) {
-        if (options.json) {
-          outputJson(io, plan);
-        } else {
-          io.stdout.write(`${formatUpgradePlan(plan)}\n`);
-        }
-        return plan.ready ? 0 : 1;
-      }
-
-      if (options.json) {
-        io.stderr.write(`${formatUpgradePlan(plan)}\n`);
-      } else {
-        io.stdout.write(`${formatUpgradePlan(plan)}\n`);
-      }
-      const result = applyUpgrade(plan, { now });
-      if (options.json) {
-        outputJson(io, result);
-      } else {
-        io.stdout.write(`\n${formatUpgradePlan(result)}\n`);
-      }
-      return result.doctor?.ok === false ? 1 : 0;
-    }
-
-    if (["uninstall", "diff"].includes(options.command)) {
-      writeError(
-        io,
-        `${options.command} is reserved by the lifecycle contract but is not enabled in this CLI build.`,
-        {
-          json: options.json,
-          code: "command_not_available",
-          command: options.command,
-        },
-      );
-      return 2;
-    }
-
-    throw new UsageError(`Unknown command: ${options.command}`);
-  } catch (error) {
-    if (error instanceof UsageError) {
-      writeError(io, error.message, { json: options.json, command: options.command });
-      return 2;
-    }
-    writeError(io, error.message, {
-      json: options.json,
-      code: error instanceof WriteError ? error.code : "runtime_error",
-      command: options.command,
-    });
-    return 1;
-  }
-}
-
-export { HELP };

package/src/constants.js

@@ -1,202 +0,0 @@
-import { readFileSync } from "node:fs";
-
-const packageJson = JSON.parse(
-  readFileSync(new URL("../package.json", import.meta.url), "utf8"),
-);
-
-export const CLI_VERSION = packageJson.version;
-// The v1 scaffold surface is frozen at v1.21 while the package version moves
-// to v2 (kernel + runtime). scaffoldVersion tracks the scaffold content
-// bundle, not the CLI, so existing installs see no fictitious major upgrade.
-export const SCAFFOLD_VERSION = "v1.21";
-export const OUTPUT_SCHEMA_VERSION = 2;
-export const PRODUCT_NAME = "BuildBeat";
-export const LEGACY_PRODUCT_NAME = "Solobaton";
-export const MARKER_FILE = "BUILDBEAT.md";
-export const LEGACY_MARKER_FILE = "SOLOBATON.md";
-export const MANIFEST_PATH = ".buildbeat/manifest.json";
-export const LEGACY_MANIFEST_PATH = ".solobaton/manifest.json";
-export const MANIFEST_PATHS = [MANIFEST_PATH, LEGACY_MANIFEST_PATH];
-export const MANIFEST_SCHEMA_VERSION = 2;
-export const SUPPORTED_MANIFEST_SCHEMA_VERSIONS = [1, 2];
-
-export const GITIGNORE_BEGIN_MARKER = "# >>> buildbeat managed >>>";
-export const GITIGNORE_END_MARKER = "# <<< buildbeat managed <<<";
-export const LEGACY_GITIGNORE_BEGIN_MARKER = "# >>> solobaton managed >>>";
-export const LEGACY_GITIGNORE_END_MARKER = "# <<< solobaton managed <<<";
-export const GITIGNORE_MARKER_PAIRS = [
-  [GITIGNORE_BEGIN_MARKER, GITIGNORE_END_MARKER],
-  [LEGACY_GITIGNORE_BEGIN_MARKER, LEGACY_GITIGNORE_END_MARKER],
-];
-
-export const SCRIPT_NAMES = [
-  "bus-check.sh",
-  "design-preview.sh",
-  "drift-check.sh",
-  "pre-commit.sh",
-  "verify-status.sh",
-];
-
-export const COMMON_REQUIRED_FILES = [
-  ".claude/agents/reviewer.md",
-  "AGENTS.md",
-  "ARCHITECTURE.md",
-  "CLAUDE.md",
-  "contracts/PROTOCOL.md",
-  "pm/NOW.md",
-  "pm/changes/README.md",
-  "pm/decisions.md",
-  "pm/status/README.md",
-];
-
-// Optional, project-owned template libraries. They ship in the package so an
-// AI session can use them on demand, but they are never part of the default
-// init/adopt plan or the required scaffold surface.
-export const OPTIONAL_TEMPLATE_PREFIXES = ["standards/", "pm/adr/"];
-
-export const IGNORED_SCAN_DIRECTORIES = new Set([
-  ".claude",
-  ".codex",
-  ".git",
-  ".buildbeat",
-  ".solobaton",
-  ".next",
-  ".nuxt",
-  ".output",
-  "build",
-  "coverage",
-  "dist",
-  "node_modules",
-  "target",
-  "vendor",
-]);
-
-export const RENDER_REQUIRED_PLACEHOLDERS = {
-  ".claude/agents/reviewer.md": ["<项目名>"],
-  "AGENTS.md": [
-    "<项目名>",
-    "<N>",
-    "<代码仓1>",
-    "<代码仓2>",
-    "<被测仓>",
-    "<PreStop/drain 机制>",
-  ],
-  "ARCHITECTURE.md": [
-    "<项目名>",
-    "<项目是什么、给谁用、核心取舍>",
-    "<用户入口>",
-    "<前端/客户端>",
-    "<仓名>",
-    "<部署单元>",
-    "<网关/服务A>",
-    "<审计/可观测>",
-    "<服务B>",
-    "<服务C>",
-    "<项目根>",
-    "<代码仓1>",
-    "<代码仓2>",
-    "<说明>",
-    "<部署平台/区域>",
-    "<应用/服务清单:名称+ID+实例>",
-    "<入口/域名/LB>",
-    "<数据库/缓存>",
-    "<服务A 凭据>",
-    "<路径/获取命令>",
-    "<运行时 env 实查>",
-    "<平台 CLI 命令>",
-  ],
-  "BUILDBEAT.md": ["<X.Y>", "<yyyy-mm-dd>", "<默认|紧凑>"],
-  "contracts/PROTOCOL.md": [
-    "<项目名>",
-    "<vX.Y.Z>",
-    "<上线日期>",
-    "<代码子仓1>",
-    "<bus-baseline.json app 名或 n/a>",
-    "<边界A:服务X ↔ 服务Y>",
-    "<对齐点>",
-    "<怎么核的:实测命令/代码行/配置查询>",
-  ],
-  "gitignore.template": ["<代码仓1>", "<代码仓2>"],
-  "pm/NOW.md": ["<期名>", "<一句话状态>", "<快轨|标准轨|重轨>", "<期>", "<域>"],
-  "pm/decisions.md": [
-    "<yyyy-mm-dd>",
-    "<谁>",
-    "<包ID>",
-    "<默认 2–5 个真实取舍的收敛结论;单项决定直接写一句>",
-    "<文件/落点>",
-  ],
-  "pm/当期看板.md": [
-    "<期名>",
-    "<工作包名>",
-    "<这轮最终要交付什么结果,不用文件名代替>",
-    "<产品 / 全栈 / 测试;按需调用,各自仍只写自己的边界>",
-    "<为达成结果可自动继续的关联任务/AI视角/文件边界>",
-    "<带证据完成 / 必须由人处理的真实阻塞 / 用户明确的检查点>",
-    "<完成时填一条可核验的仓库相对路径 / candidate hash;未完成留空>",
-    "<N>",
-    "<Gate>",
-    "<需求1>",
-    "<跨边界接口/字段/机制 约定;契约口径落 `contracts/PROTOCOL.md`>",
-    "<对照需求清单 + 设计稿逐屏;上线前必过的清单>",
-  ],
-  "pm/adr/ADR-0000-template.md": [
-    "<标题>",
-    "<yyyy-mm-dd>",
-    "<为什么现在必须做这个长期技术决定>",
-    "<最终选择及其边界>",
-    "<正向、负向与回滚影响>",
-    "<方案 A / B / C 及未选原因>",
-    "<工作包 / 契约 / evidence 路径或 n/a>",
-  ],
-  "scripts/drift-check.sh": ["<应用1>", "<应用2>", "<代码子仓1>"],
-  "scripts/verify-status.sh": ["<套件1>", "<套件2>", "<代码子仓1>", "<代码子仓2>"],
-  "standards/STACK.md": [
-    "<项目名>",
-    "<运行时及版本约束>",
-    "<包管理器及 lockfile>",
-    "<主要语言与框架>",
-    "<数据库 / 缓存 / 消息设施>",
-    "<部署平台 / 容器基线>",
-    "<CI 与测试命令>",
-    "<许可证 / 供应链约束>",
-    "<.nvmrc / engines.node 的精确值；多值重复本行；无则 n/a>",
-    "<lockfile 文件名；多类重复本行；无则 n/a>",
-    "<Dockerfile FROM 镜像；多值重复本行；无则 n/a>",
-  ],
-  "standards/CODE.md": ["<项目名>", "<代码组织与命名约定>", "<项目特有禁止事项>"],
-  "standards/REVIEW.md": ["<项目名>", "<项目特有 Review 条件>"],
-  "standards/DESIGN.md": [
-    "<项目名>",
-    "<设计原则>",
-    "<排版 / 色彩 / 间距 token 来源>",
-    "<核心组件与复用边界>",
-    "<项目特有例外>",
-  ],
-  "指挥台.md": ["<被测仓>"],
-};
-
-export const FILE_POLICIES = {
-  REPLACE_IF_UNMODIFIED: "replace-if-unmodified",
-  // Schema 1 compatibility only. New plans and schema 2 manifests never emit
-  // this historical policy.
-  THREE_WAY_ONLY: "three-way-only",
-  PROJECT_OWNED: "project-owned",
-  MERGE_ONLY: "merge-only",
-};
-
-export function filePolicy(templatePath) {
-  if (templatePath === "gitignore.template") {
-    return FILE_POLICIES.MERGE_ONLY;
-  }
-  if (
-    templatePath === "CLAUDE.md" ||
-    templatePath === ".claude/agents/reviewer.md" ||
-    templatePath === "AGENTS.md" ||
-    templatePath === "BUILDBEAT.md" ||
-    templatePath === "指挥台.md" ||
-    (/^scripts\//.test(templatePath) && templatePath !== "scripts/verify-status.sh")
-  ) {
-    return FILE_POLICIES.REPLACE_IF_UNMODIFIED;
-  }
-  return FILE_POLICIES.PROJECT_OWNED;
-}