From 22a46ff0f8156247f61d8904a582799e4440ce28 Mon Sep 17 00:00:00 2001 From: zichun Date: Tue, 26 May 2026 10:21:05 +0800 Subject: [PATCH] refactor(skills): flatten plan/ and crosscut/plan-start into skills/ root --- README.md | 2 +- skills/crosscut/plan-start/SKILL.md | 90 ------------------------------------------------------------------------------------------ skills/crosscut/plan-start/banners/flow-overview.txt | 15 --------------- skills/db-design-gen/SKILL.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/db-design-gen/banners/flow.txt | 17 +++++++++++++++++ skills/db-design-gen/templates/docs-03-header-template.md | 28 ++++++++++++++++++++++++++++ skills/db-design-gen/templates/docs-03-table-template.md | 27 +++++++++++++++++++++++++++ skills/db-init/SKILL.md | 154 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/db-init/banners/flow.txt | 17 +++++++++++++++++ skills/db-init/scripts/validate.sh | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/downstream-gen/SKILL.md | 139 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/downstream-gen/banners/flow.txt | 17 +++++++++++++++++ skills/downstream-gen/templates/docs-02-template.md | 26 ++++++++++++++++++++++++++ skills/downstream-gen/templates/docs-05-endpoint-template.md | 12 ++++++++++++ skills/downstream-gen/templates/docs-05-header-template.md | 30 ++++++++++++++++++++++++++++++ skills/downstream-gen/templates/docs-06-module-pagelist-template.md | 9 +++++++++ skills/downstream-gen/templates/docs-08-module-row-template.md | 6 ++++++ skills/downstream-gen/templates/docs-10-header-template.md | 16 ++++++++++++++++ skills/plan-start/SKILL.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/plan-start/banners/flow-overview.txt | 15 +++++++++++++++ skills/plan/db-design-gen/SKILL.md | 102 ------------------------------------------------------------------------------------------------------ skills/plan/db-design-gen/banners/flow.txt | 17 ----------------- skills/plan/db-design-gen/templates/docs-03-header-template.md | 28 ---------------------------- skills/plan/db-design-gen/templates/docs-03-table-template.md | 27 --------------------------- skills/plan/db-init/SKILL.md | 154 ---------------------------------------------------------------------------------------------------------------------------------------------------------- skills/plan/db-init/banners/flow.txt | 17 ----------------- skills/plan/db-init/scripts/validate.sh | 96 ------------------------------------------------------------------------------------------------ skills/plan/downstream-gen/SKILL.md | 139 ------------------------------------------------------------------------------------------------------------------------------------------- skills/plan/downstream-gen/banners/flow.txt | 17 ----------------- skills/plan/downstream-gen/templates/docs-02-template.md | 26 -------------------------- skills/plan/downstream-gen/templates/docs-05-endpoint-template.md | 12 ------------ skills/plan/downstream-gen/templates/docs-05-header-template.md | 30 ------------------------------ skills/plan/downstream-gen/templates/docs-06-module-pagelist-template.md | 9 --------- skills/plan/downstream-gen/templates/docs-08-module-row-template.md | 6 ------ skills/plan/downstream-gen/templates/docs-10-header-template.md | 16 ---------------- skills/plan/project-init/SKILL.md | 89 ----------------------------------------------------------------------------------------- skills/plan/project-init/banners/flow.txt | 17 ----------------- skills/plan/project-init/templates/CLAUDE-template.md | 260 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- skills/plan/project-init/templates/docs-01-index-template.md | 16 ---------------- skills/plan/project-init/templates/docs-04-stack-template.md | 32 -------------------------------- skills/plan/project-init/templates/docs-08-initial-template.md | 70 ---------------------------------------------------------------------- skills/plan/scope-lock/SKILL.md | 162 ------------------------------------------------------------------------------------------------------------------------------------------------------------------ skills/plan/scope-lock/banners/flow.txt | 17 ----------------- skills/plan/scope-lock/scripts/render.sh | 42 ------------------------------------------ skills/plan/scope-lock/templates/_module-template.md | 5 ----- skills/plan/scope-lock/templates/req-card-template.md | 63 --------------------------------------------------------------- skills/plan/skeleton-gen/SKILL.md | 162 ------------------------------------------------------------------------------------------------------------------------------------------------------------------ skills/plan/skeleton-gen/banners/flow.txt | 17 ----------------- skills/plan/skeleton-gen/scripts/merge-gitignore.sh | 39 --------------------------------------- skills/plan/skeleton-gen/templates/docs-04-skeleton-template.md | 69 --------------------------------------------------------------------- skills/plan/skeleton-gen/templates/docs-06-static-template.md | 42 ------------------------------------------ skills/plan/skeleton-gen/templates/docs-07-env-template.md | 26 -------------------------- skills/plan/skeleton-gen/templates/docs-09-structure-template.md | 45 --------------------------------------------- skills/plan/skeleton-gen/templates/env-local-template | 25 ------------------------- skills/plan/skeleton-gen/templates/gitignore-append-template | 32 -------------------------------- skills/plan/skeleton-gen/templates/scripts-setup-test-db-template.mjs | 126 ------------------------------------------------------------------------------------------------------------------------------ skills/plan/skeleton-gen/templates/scripts-test-template.mjs | 69 --------------------------------------------------------------------- skills/plan/skeleton-gen/templates/styles-tokens-template.css | 43 ------------------------------------------- skills/project-init/SKILL.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/project-init/banners/flow.txt | 17 +++++++++++++++++ skills/project-init/templates/CLAUDE-template.md | 260 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/project-init/templates/docs-01-index-template.md | 16 ++++++++++++++++ skills/project-init/templates/docs-04-stack-template.md | 32 ++++++++++++++++++++++++++++++++ skills/project-init/templates/docs-08-initial-template.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/scope-lock/SKILL.md | 162 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/scope-lock/banners/flow.txt | 17 +++++++++++++++++ skills/scope-lock/scripts/render.sh | 42 ++++++++++++++++++++++++++++++++++++++++++ skills/scope-lock/templates/_module-template.md | 5 +++++ skills/scope-lock/templates/req-card-template.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/SKILL.md | 162 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/banners/flow.txt | 17 +++++++++++++++++ skills/skeleton-gen/scripts/merge-gitignore.sh | 39 +++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/docs-04-skeleton-template.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/docs-06-static-template.md | 42 ++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/docs-07-env-template.md | 26 ++++++++++++++++++++++++++ skills/skeleton-gen/templates/docs-09-structure-template.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/env-local-template | 25 +++++++++++++++++++++++++ skills/skeleton-gen/templates/gitignore-append-template | 32 ++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/scripts-setup-test-db-template.mjs | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/scripts-test-template.mjs | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ skills/skeleton-gen/templates/styles-tokens-template.css | 43 +++++++++++++++++++++++++++++++++++++++++++ 81 files changed, 2270 insertions(+), 2270 deletions(-) delete mode 100644 skills/crosscut/plan-start/SKILL.md delete mode 100644 skills/crosscut/plan-start/banners/flow-overview.txt create mode 100644 skills/db-design-gen/SKILL.md create mode 100644 skills/db-design-gen/banners/flow.txt create mode 100644 skills/db-design-gen/templates/docs-03-header-template.md create mode 100644 skills/db-design-gen/templates/docs-03-table-template.md create mode 100644 skills/db-init/SKILL.md create mode 100644 skills/db-init/banners/flow.txt create mode 100644 skills/db-init/scripts/validate.sh create mode 100644 skills/downstream-gen/SKILL.md create mode 100644 skills/downstream-gen/banners/flow.txt create mode 100644 skills/downstream-gen/templates/docs-02-template.md create mode 100644 skills/downstream-gen/templates/docs-05-endpoint-template.md create mode 100644 skills/downstream-gen/templates/docs-05-header-template.md create mode 100644 skills/downstream-gen/templates/docs-06-module-pagelist-template.md create mode 100644 skills/downstream-gen/templates/docs-08-module-row-template.md create mode 100644 skills/downstream-gen/templates/docs-10-header-template.md create mode 100644 skills/plan-start/SKILL.md create mode 100644 skills/plan-start/banners/flow-overview.txt delete mode 100644 skills/plan/db-design-gen/SKILL.md delete mode 100644 skills/plan/db-design-gen/banners/flow.txt delete mode 100644 skills/plan/db-design-gen/templates/docs-03-header-template.md delete mode 100644 skills/plan/db-design-gen/templates/docs-03-table-template.md delete mode 100644 skills/plan/db-init/SKILL.md delete mode 100644 skills/plan/db-init/banners/flow.txt delete mode 100644 skills/plan/db-init/scripts/validate.sh delete mode 100644 skills/plan/downstream-gen/SKILL.md delete mode 100644 skills/plan/downstream-gen/banners/flow.txt delete mode 100644 skills/plan/downstream-gen/templates/docs-02-template.md delete mode 100644 skills/plan/downstream-gen/templates/docs-05-endpoint-template.md delete mode 100644 skills/plan/downstream-gen/templates/docs-05-header-template.md delete mode 100644 skills/plan/downstream-gen/templates/docs-06-module-pagelist-template.md delete mode 100644 skills/plan/downstream-gen/templates/docs-08-module-row-template.md delete mode 100644 skills/plan/downstream-gen/templates/docs-10-header-template.md delete mode 100644 skills/plan/project-init/SKILL.md delete mode 100644 skills/plan/project-init/banners/flow.txt delete mode 100644 skills/plan/project-init/templates/CLAUDE-template.md delete mode 100644 skills/plan/project-init/templates/docs-01-index-template.md delete mode 100644 skills/plan/project-init/templates/docs-04-stack-template.md delete mode 100644 skills/plan/project-init/templates/docs-08-initial-template.md delete mode 100644 skills/plan/scope-lock/SKILL.md delete mode 100644 skills/plan/scope-lock/banners/flow.txt delete mode 100644 skills/plan/scope-lock/scripts/render.sh delete mode 100644 skills/plan/scope-lock/templates/_module-template.md delete mode 100644 skills/plan/scope-lock/templates/req-card-template.md delete mode 100644 skills/plan/skeleton-gen/SKILL.md delete mode 100644 skills/plan/skeleton-gen/banners/flow.txt delete mode 100755 skills/plan/skeleton-gen/scripts/merge-gitignore.sh delete mode 100644 skills/plan/skeleton-gen/templates/docs-04-skeleton-template.md delete mode 100644 skills/plan/skeleton-gen/templates/docs-06-static-template.md delete mode 100644 skills/plan/skeleton-gen/templates/docs-07-env-template.md delete mode 100644 skills/plan/skeleton-gen/templates/docs-09-structure-template.md delete mode 100644 skills/plan/skeleton-gen/templates/env-local-template delete mode 100644 skills/plan/skeleton-gen/templates/gitignore-append-template delete mode 100644 skills/plan/skeleton-gen/templates/scripts-setup-test-db-template.mjs delete mode 100644 skills/plan/skeleton-gen/templates/scripts-test-template.mjs delete mode 100644 skills/plan/skeleton-gen/templates/styles-tokens-template.css create mode 100644 skills/project-init/SKILL.md create mode 100644 skills/project-init/banners/flow.txt create mode 100644 skills/project-init/templates/CLAUDE-template.md create mode 100644 skills/project-init/templates/docs-01-index-template.md create mode 100644 skills/project-init/templates/docs-04-stack-template.md create mode 100644 skills/project-init/templates/docs-08-initial-template.md create mode 100644 skills/scope-lock/SKILL.md create mode 100644 skills/scope-lock/banners/flow.txt create mode 100644 skills/scope-lock/scripts/render.sh create mode 100644 skills/scope-lock/templates/_module-template.md create mode 100644 skills/scope-lock/templates/req-card-template.md create mode 100644 skills/skeleton-gen/SKILL.md create mode 100644 skills/skeleton-gen/banners/flow.txt create mode 100755 skills/skeleton-gen/scripts/merge-gitignore.sh create mode 100644 skills/skeleton-gen/templates/docs-04-skeleton-template.md create mode 100644 skills/skeleton-gen/templates/docs-06-static-template.md create mode 100644 skills/skeleton-gen/templates/docs-07-env-template.md create mode 100644 skills/skeleton-gen/templates/docs-09-structure-template.md create mode 100644 skills/skeleton-gen/templates/env-local-template create mode 100644 skills/skeleton-gen/templates/gitignore-append-template create mode 100644 skills/skeleton-gen/templates/scripts-setup-test-db-template.mjs create mode 100644 skills/skeleton-gen/templates/scripts-test-template.mjs create mode 100644 skills/skeleton-gen/templates/styles-tokens-template.css diff --git a/README.md b/README.md index 23505d4..d45d120 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ erp-workflow-plugin/ ## Skill 清单（25 个） -### Plan 阶段（6 个，`skills/plan/`） +### Plan 阶段（6 个，`skills/`） | # | Skill | 作用 | 流程中谁调用 | |---|---|---|---| diff --git a/skills/crosscut/plan-start/SKILL.md b/skills/crosscut/plan-start/SKILL.md deleted file mode 100644 index 2d25329..0000000 --- a/skills/crosscut/plan-start/SKILL.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -name: plan-start -description: A 阶段（Plan）入口与分发器。根据 docs/08 § 一 的 checkbox 状态派发到 A0~A5 对应 skill。Plan 全部完成（A5 已勾）时打印提示让用户运行 /erp-workflow:coding-start 进入 B 阶段。 -user-invocable: true -allowed-tools: Skill Read Glob Grep Bash(cat *) ---- - -**所有输出必须使用中文。** - -你是 ERP 项目**规划阶段的编排器**。你**只派发 A 阶段（A0~A5）的 skill**；docs/08 § 一 全部勾选后即停下，提示用户显式运行 `/erp-workflow:coding-start` 进入 B 阶段。你不直接生成任何文件。 - -## 第一步：读取 docs/08 + 决定分发目标 - -docs/08 § 一 是**Plan 阶段进度追踪**（A0~A5 的 checkbox）。§ 二的模块元数据由 coding-start 读写，本 skill 不读。 - -### 分发判定 - -1. **docs/08 是否存在** - 用 `Glob` 检查 `docs/08-模块任务管理.md`。 - - 如果不存在 → 后续 = `project-init`。 - -2. **根据 § 一 找到当前进度** - -| `进度` | `后续` | `阶段` | -|---|---|---| -| 无 docs/08 | `project-init` | `A0` | -| 含 `A0` / `A0 子项` | `project-init` | `A0` | -| 含 `A1` / `A1 子项` | `scope-lock` | `A1` | -| 含 `A2` / `A2 子项` | `skeleton-gen` | `A2` | -| 含 `A3` / `A3 子项` | `db-design-gen` | `A3` | -| 含 `A4` / `A4 子项` | `db-init` | `A4` | -| 含 `A5` / `A5 子项` | `downstream-gen` | `A5` | -| `A` 全勾，Plan 阶段结束 | **无分发** | - | - -## 第二步：分发通知 + 调用目标 skill - -### 2.1 Plan 已完成 - -A 阶段所有 checkbox 均 `[x]`。无后续 skill，本步骤**先打印整体流程图**，再输出完成横幅，然后**停下**： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/crosscut/plan-start/banners/flow-overview.txt" -``` - -再向用户输出完成横幅： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [plan-start] ✅ Plan 阶段全部完成 - - ⚠️ 进入 B 阶段前必须完成： - 1. 人工通读 docs/* + CLAUDE.md + sql/migrations/V1 + 各 scripts/* - - 2. 把全部 Plan 产物 commit 到本地默认分支（main / master）： - git add -A && git commit -m "chore: plan phase A0~A5 done" - - 3. B 阶段全程纯本地（无需远程仓库 / push / MR）： - 每个模块由 milestone-tag 本地 merge 进默认分支并打 milestone/ tag。 - 确认当前已在本地默认分支（main / master）上即可。 - - 4. 运行 /erp-workflow:coding-start 进入 B 阶段 -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -不调任何下游 skill。 - -### 2.2 正常派发（`后续` 非空） - -先打印整体流程图，再打印分发通知： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/crosscut/plan-start/banners/flow-overview.txt" -``` - -打印简短分发通知： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [plan-start] → 派发到 <后续> - 未勾项： -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -立即用 `Skill` 工具调用 `后续`。 - -## 参考 - -- `docs/08-模块任务管理.md`（进度追踪） -- `CLAUDE.md`（项目指令） -- 后续 skills（通过 `Skill` 工具按名称调用） diff --git a/skills/crosscut/plan-start/banners/flow-overview.txt b/skills/crosscut/plan-start/banners/flow-overview.txt deleted file mode 100644 index b3e7a4d..0000000 --- a/skills/crosscut/plan-start/banners/flow-overview.txt +++ /dev/null @@ -1,15 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/db-design-gen/SKILL.md b/skills/db-design-gen/SKILL.md new file mode 100644 index 0000000..31e6750 --- /dev/null +++ b/skills/db-design-gen/SKILL.md @@ -0,0 +1,102 @@ +--- +name: db-design-gen +description: A3 DB 设计 + REQ 回填——基于 docs/01-需求清单//REQ-*.md 正向设计 docs/03-数据库设计文档.md（业务实体 → 表 + 字段 + 索引 + 外键 + 业务注记），并把回填值写入 REQ 卡片的「依赖表: TBD(A3 自动补)」与模块头的「涉及表: TBD(A3 自动补)」占位。生成完毕停下等人工审阅。 +user-invocable: false +allowed-tools: Read Write Edit Grep Glob Bash(cat *) +--- + +**所有输出必须使用中文。** + +# db-design-gen + +## 前置条件 + +- A1 `scope-lock` 已完成：`docs/01-需求清单//_module.md` + `docs/01-需求清单//REQ-*.md` 已生成，含 `TBD(A3 自动补)` 占位。 +- A2 `skeleton-gen` 已完成：`docs/04-技术规范.md § 一+` 命名规范已生成（本 skill 推导表/字段命名时严格遵循）。 + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/db-design-gen/banners/flow.txt" +``` + +### A. 读取设计输入 + +读： + +- `docs/04-技术规范.md` +- `docs/01-需求清单/index.md` 模块索引 +- `docs/01-需求清单/*/REQ-*.md` 所有 REQ 卡片 + +### B. 推导 schema + +基于步骤 A 读到的 REQ + 命名规范，**正向推导**业务实体 → 表 + 字段 + 索引 + 外键。要求： + +1. 严格套用 `docs/04` 的命名规范 +2. **主键**：模板内置 `iIncrement` 为主键。REQ 明确要求复合主键 / UUID / 业务主键时按 REQ；其他主键变更需同步改 docs-03-header / docs-03-table 两份模板 +3. **外键**：依据 REQ 中的引用关系（如「订单引用客户」），明确列出 `ON DELETE` / `ON UPDATE` 策略；不能确定时默认 `RESTRICT` +4. **索引**：根据 REQ 的查询模式推导业务索引；外键列默认建索引；标准列里 `sBrandsId` / `sSubsidiaryId` 这类多租户隔离列，按业务查询模式建组合索引 +5. **业务注记**：对每张表用一两句话说明业务用途、关键约束、与其他表的关系 + +如果某 REQ 表述模糊以致无法推断关键 schema 细节（如：枚举值范围 / 字段长度上限 / 必填性），先按合理默认推导并在该字段「业务含义」列加 `【人工填写：需用户审阅】` 标注，待步骤 E 用户审阅时调整；**不打断本次推导**。 + +### C. 渲染 docs/03 + +1. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md`，填充 `schema_name`（从 `.env.local` 读 `DB_SCHEMA`，无则填 `【人工填写：DB_SCHEMA】`）、`er_overview`（纯文本 ER 概览）。 +2. 渲染「表清单」：对每张表：读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md`。 +3. 写入 `docs/03-数据库设计文档.md`。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/03-数据库设计文档.md 已生成` + +### D. 回填模块头 + REQ 卡片的 TBD 字段 + +1. 列出 `docs/01-需求清单/*/_module.md`（模块头）和 `docs/01-需求清单/*/REQ-*.md`（REQ 卡片）。 +2. 在这些文件中搜索 `TBD(A3 自动补)` 的并回填。 不动 `TBD(A5 自动补)` +3. 打印回填统计：`A3 回填 处模块"涉及表" + 处 REQ"依赖表"`。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填` + +### E. 勾选 A3 顶层 + 停下等人工审阅 + +1. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选 A3 顶层（A3 两个子项已在 C / D 步骤分别勾选）： + - `- [ ] A3 DB 设计 + REQ 回填 — db-design-gen` + +2. 打印停下横幅并**停下**： + + ``` + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [db-design-gen] ✅ A3 DB 设计完成 + + 产出： + ✓ docs/03-数据库设计文档.md + ✓ docs/01-需求清单//REQ-*.md 依赖表已回填 + _module.md 涉及表已回填 + + ⏸ 现在请你审阅 docs/03。 + 重点关注： + - 业务实体覆盖是否完整 + - 字段类型 / 长度 / 是否可空 / 默认值是否合理 + - 索引是否覆盖主要查询模式 + - 外键 ON DELETE / ON UPDATE 策略是否符合业务 + - 字段「业务含义」列含 `【人工填写：需用户审阅】` 标注的位置需逐一确认 + + 审阅完成后，再运行： + /erp-workflow:plan-start + + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + ``` + + **停止**，不调用任何下游 skill。 + +## 参考 + +- `${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md` +- `${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md` +- `docs/04-技术规范.md` § 一+（命名规范输入） +- `docs/01-需求清单//_module.md`（模块头：回填 `涉及表`） +- `docs/01-需求清单//REQ-*.md`（REQ 输入 + 回填 `依赖表`） diff --git a/skills/db-design-gen/banners/flow.txt b/skills/db-design-gen/banners/flow.txt new file mode 100644 index 0000000..1d4c9ac --- /dev/null +++ b/skills/db-design-gen/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ ▶ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/db-design-gen/templates/docs-03-header-template.md b/skills/db-design-gen/templates/docs-03-header-template.md new file mode 100644 index 0000000..6ef65d9 --- /dev/null +++ b/skills/db-design-gen/templates/docs-03-header-template.md @@ -0,0 +1,28 @@ +# 03-数据库设计文档 + +- **Schema**: `{{schema_name}}` +- **Migration 清单**: `sql/migrations/V*.sql`（由 Flyway 顺序 apply） +- **生成方式**: 由 A3 `db-design-gen` 基于 `docs/01-需求清单//REQ-*.md` REQ 卡片正向设计生成（schema SSoT）。 + +## 项目标准列约定 + +下文每张业务表的字段清单都自动包含以下 5 个标准列（匈牙利前缀 `i` int / `s` varchar / `t` datetime）。渲染时由 `docs-03-table-template.md` 模板内置原样输出。 + +| 列名 | 类型 | 可空 | 主键 | 说明 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | 是 | 整数主键 ID（自增方式由实现决定：DB `AUTO_INCREMENT` 或应用 / 触发器分配） | +| `sId` | varchar(100) | 是 | — | 业务 ID（对外暴露的字符串标识，如 UUID / 人类可读编号） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离） | +| `tCreateDate` | datetime | 否 | — | 记录创建时间 | + +字典 / 辅助表如有豁免，在该表业务注记里注明豁免原因。 + +## ER 关系概览 + +{{er_overview}} + +## 表清单 +{{#each tables}} +- `{{table_name}}` — {{purpose}} +{{/each}} diff --git a/skills/db-design-gen/templates/docs-03-table-template.md b/skills/db-design-gen/templates/docs-03-table-template.md new file mode 100644 index 0000000..d05c5be --- /dev/null +++ b/skills/db-design-gen/templates/docs-03-table-template.md @@ -0,0 +1,27 @@ +## `{{table_name}}` — {{purpose}} + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | 自增函数 | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | uuid 函数 | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | `1111111111` | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | `1111111111` | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | 当前时间 | 创建时间（标准列） | +{{#each columns}} +| {{name}} | {{type}} | {{nullable}} | {{default}} | {{business_meaning}} | +{{/each}} + +### 索引 +{{#each indexes}} +- `{{name}}` ({{type}}): {{columns}} +{{/each}} + +### 外键 +{{#each foreign_keys}} +- `{{name}}`: {{from_col}} → {{to_table}}.{{to_col}} ({{on_delete}}) +{{/each}} + +### 业务注记 +{{notes}} diff --git a/skills/db-init/SKILL.md b/skills/db-init/SKILL.md new file mode 100644 index 0000000..fcc2be9 --- /dev/null +++ b/skills/db-init/SKILL.md @@ -0,0 +1,154 @@ +--- +name: db-init +description: A4 DB 初始化——LLM 解析 docs/03-数据库设计文档.md → 生成 sql/migrations/V1__initial_schema.sql（DDL only，Flyway 初始 migration）→ 全量校验 DDL ↔ docs/03 一致性 → 验证 MySQL 连接 → 调 scripts/setup-test-db.sh 复用三层防护并 DROP+CREATE 空库 → apply V1。 +user-invocable: false +allowed-tools: Read Write Edit Glob Skill Bash(mkdir *) Bash(mysql *) Bash(set *) Bash(. .env.local) Bash(grep *) Bash(bash *) Bash(./scripts/setup-test-db.sh) Bash(cat *) +--- + +**所有输出必须使用中文。** + +# db-init + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/db-init/banners/flow.txt" +``` + +### A. DDL 生成（不依赖数据库连接） + +#### A.1 读 docs/03 并翻译为 DDL + +读取 `docs/03-数据库设计文档.md`，按字段 / 索引 / 外键 / 业务注记**严格翻译**为： + +- 每张表一段 `CREATE TABLE` +- 字段顺序与 docs/03 表格行序一致；`Nullable` 列直接映射 `NOT NULL` / `NULL`；`默认` 列映射 `DEFAULT `；列尾用 `COMMENT '<业务含义>'` 写注释 +- 索引 +- 外键：在所有表创建完成后**统一追加** + +要求： +- **严禁臆造** docs/03 中没有的表 / 字段 / 索引 / 外键 +- **严禁省略** docs/03 中已有的列、注释或约束 +- 字符集统一 `utf8mb4` + `utf8mb4_unicode_ci`，引擎统一 `InnoDB`，除非 docs/03 业务注记明确要求其他设置 + +#### A.2 落盘 V1 文件 + +`Bash`: `mkdir -p sql/migrations`。 + +用 `Write` 写 `sql/migrations/V1__initial_schema.sql`，内容 = 头部注释 + DDL 主体： + +1. **头部注释**（6 行 SQL 注释）： + - `-- Flyway migration V1 — initial schema for `（从 `CLAUDE.md § 🎯 项目概述` 读） + - `-- Generated: `（UTC ISO 8601 时间戳） + - `-- Source: 由 A4 db-init 从 docs/03-数据库设计文档.md 翻译生成（schema SSoT 是 docs/03）` + - `-- This is the FIRST migration; subsequent schema changes must be written as new files sql/migrations/V2__.sql, V3__... etc.` + - `-- Apply: Flyway runs this automatically at Spring Boot startup.` + - `-- Do not hand-edit this file after it is committed; write a new migration instead.` + +2. **DDL 主体**：A.1 推导出的所有 `CREATE TABLE` → `CREATE INDEX` → `ALTER TABLE ... ADD CONSTRAINT ... FOREIGN KEY`，按此顺序拼接。 + +#### A.3 校验 V1 ↔ docs/03 集合一致性 + 自主修正 + +调 `${CLAUDE_SKILL_DIR}/scripts/validate.sh` 做脚本化的校验： + +```bash +bash "${CLAUDE_SKILL_DIR}/scripts/validate.sh" \ + sql/migrations/V1__initial_schema.sql \ + docs/03-数据库设计文档.md +``` + +退出码与处理： +- `0` → 通过，进入步骤 B +- `1` → **自主修正循环**（最多 3 轮，docs/03 是 SSoT 不动）： + 1. 解析 stderr 差异清单，修正 V1.sql + 2. 重跑 validate.sh + 3. 退出 0 → 进入 B；退出 1 且本轮 < 3 → 回步骤 1；本轮 ≥ 3 仍失败 → 停下，打印最终残留差异 + 已尝试的 3 轮修正摘要，让用户介入 +- `2` → 用法错（V1 / docs 路径找不到），打印路径并停下 + +完成后（V1 写入并通过 validate.sh 校验），用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] sql/migrations/V1__initial_schema.sql 已生成` +- ` - [ ] DDL 与 docs/03 全量一致` + +### B. 数据库环境检查 + +#### B.1 检查 .env.local 凭据 + +用 `Glob` 检查 `.env.local` 是否存在；不存在 → 提示用户重新运行 A2 `skeleton-gen` 重建并停下。 + +用 `Bash` 加载并校验 5 个必填字段非空： + +```bash +set -a; . .env.local; set +a +for v in DB_HOST DB_PORT DB_USER DB_PASSWORD DB_SCHEMA; do + eval val=\${$v:-} + [ -z "$val" ] && echo "MISSING: $v" +done +``` + +任一缺失 → 打印缺失字段名并停下，提示用户编辑 `.env.local` 后重跑。 + +#### B.2 验证 MySQL 连接 + +```bash +set -a; . .env.local; set +a +mysql -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" -e "SELECT 1;" +``` + +- **成功** → 进入步骤 C +- **失败** → 打印具体错误（认证 / 主机不可达 / 端口拒接等），提示检查 `.env.local`，**停下**。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] .env.local 凭据已验证（mysql -e "SELECT 1" OK）` + +### C. 自动导入 MySQL + +#### C.1 DROP+CREATE 空库 + +```bash +./scripts/setup-test-db.sh +``` + +#### C.2 把 V1 灌入已清空的 schema + +```bash +set -a; . .env.local; set +a +mysql -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" "$DB_SCHEMA" \ + < sql/migrations/V1__initial_schema.sql +``` + +非零退出 → 报错停下，打印 mysql stderr。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] setup-test-db.sh 防护通过 + DROP+CREATE + apply V1 已执行` + +#### C.3 自检 SHOW TABLES + +```bash +set -a; . .env.local; set +a +ACTUAL=$(mysql -N -B -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" \ + -e "SHOW TABLES;" "$DB_SCHEMA" | wc -l | tr -d ' ') +EXPECTED=$(grep -c '^## `' docs/03-数据库设计文档.md) +[ "$ACTUAL" = "$EXPECTED" ] || { echo "MISMATCH: actual=$ACTUAL expected=$EXPECTED"; exit 1; } +``` + +行数不一致 → 报错停下；一致 → 进入步骤 D。 + +### D. 勾选 docs/08 进度 + 进入 A5 + + +1. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选（A4 子项 + A4 顶层）： + - ` - [ ] SHOW TABLES 行数 == docs/03 表数量` + - `- [ ] A4 DB 初始化 — db-init` + +2. 立即调用 `Skill(downstream-gen)` 进入 A5，不等用户手动输入。 + +## 参考 + +- `${CLAUDE_SKILL_DIR}/scripts/validate.sh`（A.3 表名 + 每表列名集合校验脚本） +- `docs/03-数据库设计文档.md`（DDL 翻译输入，SSoT） +- `.env.local`（DB 凭据） +- 产物：`sql/migrations/V1__initial_schema.sql`（由 Flyway 在 Spring Boot 启动时验证 / apply） diff --git a/skills/db-init/banners/flow.txt b/skills/db-init/banners/flow.txt new file mode 100644 index 0000000..b8cba75 --- /dev/null +++ b/skills/db-init/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ ▶ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/db-init/scripts/validate.sh b/skills/db-init/scripts/validate.sh new file mode 100644 index 0000000..bed28ad --- /dev/null +++ b/skills/db-init/scripts/validate.sh @@ -0,0 +1,96 @@ +#!/usr/bin/env bash +# validate.sh — 校验 V1.sql 与 docs/03 的两个集合一致性： +# 维度 1: 表名集合 +# 维度 2: 每张共有表的列名集合 +# +# 用法: bash validate.sh +# 退出码: +# 0 = 一致 +# 1 = 不一致（差异明细打印到 stderr） +# 2 = 用法错误（路径找不到等） + +set -uo pipefail +export LC_ALL=C # sort / comm 行为确定 + +V1=${1:?missing V1 sql path} +DOC=${2:?missing docs/03 path} + +[ -f "$V1" ] || { echo "validate.sh: V1 not found: $V1" >&2; exit 2; } +[ -f "$DOC" ] || { echo "validate.sh: docs not found: $DOC" >&2; exit 2; } + +ERR=0 + +# ─── 维度 1: 表名集合 ─────────────────────────────────────────── +TABLES_DOC=$(grep -E '^## `[^`]+`' "$DOC" \ + | sed -E 's/^## `([^`]+)`.*/\1/' | sort -u) +TABLES_SQL=$(grep -E '^CREATE TABLE `[^`]+`' "$V1" \ + | sed -E 's/^CREATE TABLE `([^`]+)`.*/\1/' | sort -u) + +ONLY_DOC=$(comm -23 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) +ONLY_SQL=$(comm -13 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) + +if [ -n "$ONLY_DOC" ] || [ -n "$ONLY_SQL" ]; then + { + echo "=== 维度 1: 表名集合不一致 ===" + [ -n "$ONLY_DOC" ] && { echo " docs/03 有但 V1 无:"; echo "$ONLY_DOC" | sed 's/^/ - /'; } + [ -n "$ONLY_SQL" ] && { echo " V1 有但 docs/03 无:"; echo "$ONLY_SQL" | sed 's/^/ - /'; } + } >&2 + ERR=1 + # 表数差异 → 不再做列校验 + exit 1 +fi + +# ─── 维度 2: 每张共有表的列名集合 ────────────────────────────── +COMMON=$(comm -12 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) + +extract_doc_cols() { + local table=$1 + awk -v t="$table" ' + $0 ~ "^## `" t "`" { in_table=1; in_fields=0; next } + in_table && /^## `/ { exit } + in_table && /^### 字段/ { in_fields=1; next } + in_table && in_fields && /^###/ { in_fields=0 } + in_table && in_fields && /^\|/ { + n = split($0, a, "|") + gsub(/^[ ]+|[ ]+$/, "", a[2]) + gsub(/`/, "", a[2]) + if (a[2] != "" && a[2] != "字段" && a[2] !~ /^-+$/) print a[2] + } + ' "$DOC" | sort -u +} + +extract_sql_cols() { + local table=$1 + awk -v t="$table" ' + $0 ~ "^CREATE TABLE `" t "`" { in_table=1; next } + in_table && /^\)/ { in_table=0; next } + in_table && /^[[:space:]]*`[^`]+`/ \ + && $0 !~ /^[[:space:]]*(PRIMARY|UNIQUE|KEY|FOREIGN|CONSTRAINT|INDEX)/ { + match($0, /`[^`]+`/) + print substr($0, RSTART+1, RLENGTH-2) + } + ' "$V1" | sort -u +} + +while IFS= read -r t; do + [ -z "$t" ] && continue + D_COLS=$(extract_doc_cols "$t") + S_COLS=$(extract_sql_cols "$t") + ONLY_D=$(comm -23 <(echo "$D_COLS") <(echo "$S_COLS")) + ONLY_S=$(comm -13 <(echo "$D_COLS") <(echo "$S_COLS")) + if [ -n "$ONLY_D" ] || [ -n "$ONLY_S" ]; then + { + echo "=== 维度 2: 表 \`$t\` 列名不一致 ===" + [ -n "$ONLY_D" ] && { echo " docs/03 有但 V1 无:"; echo "$ONLY_D" | sed 's/^/ - /'; } + [ -n "$ONLY_S" ] && { echo " V1 有但 docs/03 无:"; echo "$ONLY_S" | sed 's/^/ - /'; } + } >&2 + ERR=1 + fi +done <<< "$COMMON" + +if [ $ERR -ne 0 ]; then + exit 1 +fi + +echo "validate.sh: ✓ 表名集合 + 每表列名集合 与 docs/03 一致" +exit 0 diff --git a/skills/downstream-gen/SKILL.md b/skills/downstream-gen/SKILL.md new file mode 100644 index 0000000..9d3cfc0 --- /dev/null +++ b/skills/downstream-gen/SKILL.md @@ -0,0 +1,139 @@ +--- +name: downstream-gen +description: A5 下游文档生成——基于 docs/01 和 docs/03 推导，一次性生成 docs/02 + docs/05 + docs/06 § 三 + docs/10，回填 REQ 卡片依赖接口，把模块清单追加到 docs/08 § 二。 +user-invocable: false +allowed-tools: Read Write Edit Glob Grep Skill AskUserQuestion Bash(cat *) Bash(cp *) +--- + +**所有输出必须使用中文。** + +# downstream-gen + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/downstream-gen/banners/flow.txt" +``` + +### A. docs/02 — 开发计划（含 REQ 级开发顺序清单） + +**清单颗粒度**：一行一个 REQ，同一模块的 REQ 必须**连续排列**。 + +1. 构建**模块依赖 DAG**。 +3. 对**每个模块内部**构建 REQ 间依赖，得到模块内 REQ 顺序。 +4. 合成 `req_order[]`：按 `module_topo_order[]` 依次铺开每个模块内的 REQ 序列（**同模块 REQ 连续**）。 +5. **环依赖打破**： + - **模块级**：若模块 DAG 存在环（module_A ↔ module_B），按启发式（字母序 / 被依赖次数多者先）破环排出 `module_topo_order`，并在**参与环的模块里第一个 REQ** 的 `note` 字段填入原因（如 "A↔B 互依赖：先做 A 的骨架"）。 + - **REQ 级（同模块内）**：若模块内 REQ 互依赖，同样破环，`note` 填原因。 + - 非环 REQ `note` 留 `—`。 +6. 为 `req_order[]` 每项生成字段： + - `index`：行号（从 1 开始） + - `req_id`：如 `REQ-SYS-001` + - `module_id`：该 REQ 所属模块，如 `module_sys` + - `rationale`（**选中理由**）：依赖驱动的简短描述，如 `所属模块无依赖，基础模块` / `依赖 REQ-SYS-001 已在前` / `所属模块依赖 module_sys 已在前` + - `note`（**备注**）：默认 `—`；仅环依赖打破场景填原因 +7. 读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-02-template.md`。 +8. 写入 `docs/02-开发计划.md`。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/02 开发计划已生成` + +### B. docs/05 — API 接口契约 + +1. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-05-header-template.md`，写入 `docs/05-API接口契约.md` 头部。 +2. 对所有模块的每个 REQ：读取并推断 `${CLAUDE_SKILL_DIR}/templates/docs-05-endpoint-template.md`，追加到 docs/05。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/05 API 契约已生成` + +### B2. 回填模块头 + REQ 卡片的 TBD(A5) 字段 + +1. 在`docs/01-需求清单/*/_module.md`（模块头）和 `docs/01-需求清单/*/REQ-*.md`（REQ 卡片）中搜索并回填 `TBD(A5 自动补)` +2. 打印回填统计：`A5 回填 处模块"依赖模块" + 处 REQ"依赖接口"`。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] REQ 卡片依赖接口已回填` + +### C. docs/06 — 页面清单 + +对每个有前端页面的模块：读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-06-module-pagelist-template.md`，追加到 `docs/06-UI交互规范.md` § 三。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/06 § 三 页面清单已填入` + +### D. docs/08 — 追加模块清单 + +读 `${CLAUDE_SKILL_DIR}/templates/docs-08-module-row-template.md`，按 `module_id` 字母序为每个模块渲染 bullet（模块元数据 + REQ 子项清单，REQ 序保持步骤 A 模块内顺序），追加到 docs/08。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 下方模块列表已填入` + +### E. docs/10 — 验收清单（项目级 SOP） + +```bash +cp "${CLAUDE_SKILL_DIR}/templates/docs-10-header-template.md" docs/10-验收检查清单.md +``` + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] docs/10 验收清单已生成` + +### F. 验证 + 勾选 docs/08 进度 + 结束 Plan + +1. 一致性检查 + 自主修复循环（最多 3 轮，docs/01 是 REQ SSoT 不动）： + + **检查项**： + - 每个 docs/01 REQ 都出现在 docs/05（作为接口，如适用） + - `docs/02 § 二` 的 `module_id` 集合 = `docs/08 § 二` 的 `module_id` 集合 + + **不一致 → 按差异类型自主修复**： + - **REQ 缺 docs/05 endpoint** → 按步骤 B 规则为该 REQ 推测，并追加到 docs/05 + - **module_id 缺 docs/08 § 二** → 按步骤 D 规则渲染该模块 bullet（含 REQ 子项），按 `module_id` 字母序插入正确位置 + - **module_id 缺 docs/02 § 二** → 重算该模块的 `req_order` 段（步骤 A 子流程），按拓扑序插入 docs/02 § 二 + + 修复后重跑检查；通过 → 进入 2；3 轮仍失败 → 停下，打印最终残留差异 + 已尝试的 3 轮修复摘要让用户介入。 + +2. **最终占位符扫描**（覆盖 Plan 阶段全部产出）： + + a. **`TBD` → 自动补齐**：Grep 搜索 `TBD(A3 自动补)` 和 `TBD(A5 自动补)`。有命中则就地补填（A3 残留 → 查 docs/03 填 `依赖表`；A5 残留 → 查 docs/05 按 REQ-ID 填 `依赖接口`），再 Grep 确认 0 命中；仍残留报错停下。 + + b. **`【人工填写：...】` → QA 循环等用户补**： + + 循环执行直到搜索不到 `【人工填写：` 且用户选「继续」： + - 0 命中 → 直接放行进入步骤 3 + - 有命中 → 打印残留清单（`<文件:行号> — <内容摘要>`），用 `AskUserQuestion` 弹「继续」/「有疑问想先沟通」二选一；用户回答后重扫验证再决定放行 / 继续循环 + + **每次弹 QA 前都重扫一次**——保证用户看到的 N 是最新的，避免「用户以为填完但实际还有残留」直接放行。 + +3. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 勾选 A5 父项： + - `- [ ] A5 下游文档生成 — downstream-gen` + +4. 打印 Plan 阶段终止横幅并**停下**（不自动进入 B 阶段）： + + ``` + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [downstream-gen] ✅ Plan 阶段（A0~A5）全部完成 + + 所有规划文档已就绪，docs/08 § 一 全部勾选。 + + ⚠️ 进入 B 阶段前必须完成： + 1. 审核 docs/01~10 + CLAUDE.md + sql/migrations/V1 + 各 scripts/* + + 2. 把全部 Plan 产物 commit 到本地默认分支（main / master）： + git add -A && git commit -m "chore: plan phase done" + + 3. 运行 /erp-workflow:coding-start 进入 B 阶段 + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + ``` + +## 参考 + +- `${CLAUDE_SKILL_DIR}/templates/docs-02-template.md` +- `${CLAUDE_SKILL_DIR}/templates/docs-05-header-template.md` +- `${CLAUDE_SKILL_DIR}/templates/docs-05-endpoint-template.md` +- `${CLAUDE_SKILL_DIR}/templates/docs-06-module-pagelist-template.md`（追加到 docs/06 § 三） +- `${CLAUDE_SKILL_DIR}/templates/docs-08-module-row-template.md`（模块 bullet 行模板） +- `${CLAUDE_SKILL_DIR}/templates/docs-10-header-template.md` diff --git a/skills/downstream-gen/banners/flow.txt b/skills/downstream-gen/banners/flow.txt new file mode 100644 index 0000000..f53fce1 --- /dev/null +++ b/skills/downstream-gen/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ ▶ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/downstream-gen/templates/docs-02-template.md b/skills/downstream-gen/templates/docs-02-template.md new file mode 100644 index 0000000..9eed94e --- /dev/null +++ b/skills/downstream-gen/templates/docs-02-template.md @@ -0,0 +1,26 @@ +# 02-开发计划 + +## 一、模块依赖表 + +| 模块 ID | 模块名 | 依赖模块 | 依赖表 | +|---|---|---|---| +{{#each modules}} +| {{id}} | {{name}} | {{deps}} | {{tables}} | +{{/each}} + +## 二、开发顺序清单（CC 分发权威） + +> 本清单由 A5 `downstream-gen` 一次性生成。**每行是一个 REQ**，不是模块。CC 按表格行序从上到下扫描，对每个 REQ 所属模块查 `docs/08 § 二` 的 `里程碑:` 字段 + 本地 `git tag -l 'milestone/'`：tag 存在则跳过，否则（`—` / tag 不存在）选为当前模块；`module-start` 会把该模块的所有 REQ 一次做完。 +> +> **约束**：同一模块的所有 REQ 必须**连续排列**。允许打破依赖拓扑（如环依赖、业务必须先做），但必须在「备注」列写明原因。 + +| # | REQ | 所属模块 | 选中理由 | 备注 | +|---|-----|---------|---------|------| +{{#each req_order}} +| {{index}} | **{{req_id}}** | {{module_id}} | {{rationale}} | {{note}} | +{{/each}} + +> **后端模块全部打里程碑后**：milestone-tag 自动回调 `coding-start` → coding-start 检测到 `backend_done=true && frontend_done=false` → 派发 `frontend-start`。`frontend-start` 步骤 1 自带 prototype/ 门禁（≥ 1 个 `*.html` mockup，缺失则 AskUserQuestion 提示用户补齐）。前端阶段以业务功能（不是 HTML 文件数）为粒度拆分 FE，每个 FE 跑一次 feature 循环（fe-feature-*），最后整个阶段打 1 个里程碑 tag（分支 `frontend-phase`，记录在 `docs/08 § 三 整体里程碑`）。 + +## 三、关键说明 +{{notes}} diff --git a/skills/downstream-gen/templates/docs-05-endpoint-template.md b/skills/downstream-gen/templates/docs-05-endpoint-template.md new file mode 100644 index 0000000..91a1fda --- /dev/null +++ b/skills/downstream-gen/templates/docs-05-endpoint-template.md @@ -0,0 +1,12 @@ +### {{req_id}} {{title}} + +- **Method**: {{method}} +- **Path**: `{{path}}` +- **Auth**: {{auth}} +- **请求**: {{request_summary}} +- **响应**: {{response_summary}} + +#### 错误码 +{{#each errors}} +- `{{code}}` — {{message}} +{{/each}} diff --git a/skills/downstream-gen/templates/docs-05-header-template.md b/skills/downstream-gen/templates/docs-05-header-template.md new file mode 100644 index 0000000..e89cc3d --- /dev/null +++ b/skills/downstream-gen/templates/docs-05-header-template.md @@ -0,0 +1,30 @@ +# 05-API接口契约 + +BasePath: `{{base_path}}` +端口: `【人工填写：后端端口，默认 8080】` + +## 全局约定 + +### 响应格式 +```json +{"code": 200, "message": "操作成功", "data": {}, "timestamp": 1700000000000} +``` + +### 错误码 +| 范围 | 含义 | +|---|---| +| 200 | 成功 | +| 400xx | 客户端参数错误 | +| 401xx | 认证/授权错误 | +| 403xx | 权限不足 | +| 404xx | 资源不存在 | +| 500xx | 服务端内部错误 | + +### 鉴权 +{{auth_note}} + +### 分页参数 +{{pagination_note}} + +## 接口清单 +（各模块接口段落见下方，由 `downstream-gen` 按 REQ 填入） diff --git a/skills/downstream-gen/templates/docs-06-module-pagelist-template.md b/skills/downstream-gen/templates/docs-06-module-pagelist-template.md new file mode 100644 index 0000000..36f18a5 --- /dev/null +++ b/skills/downstream-gen/templates/docs-06-module-pagelist-template.md @@ -0,0 +1,9 @@ +### {{module_id}} {{module_name}} + +{{#each pages}} +- **{{page_name}}** (`{{route}}`) + - 类型: {{page_type}} （列表页 / 表单页 / 详情页 / 树形管理页） + - 对应 REQ: {{req_ids}} + - 入口菜单: {{menu_path}} + - 主要交互: {{interactions}} +{{/each}} diff --git a/skills/downstream-gen/templates/docs-08-module-row-template.md b/skills/downstream-gen/templates/docs-08-module-row-template.md new file mode 100644 index 0000000..edd15f1 --- /dev/null +++ b/skills/downstream-gen/templates/docs-08-module-row-template.md @@ -0,0 +1,6 @@ +- {{module_id}} {{module_name}} + - 依赖: {{depends_on}} + - 路径: {{path_scopes}} + - 里程碑: — + - 功能: +{{req_checklist}} diff --git a/skills/downstream-gen/templates/docs-10-header-template.md b/skills/downstream-gen/templates/docs-10-header-template.md new file mode 100644 index 0000000..3a9c860 --- /dev/null +++ b/skills/downstream-gen/templates/docs-10-header-template.md @@ -0,0 +1,16 @@ +# 10-验收检查清单 + +通用验收项（全项目适用）： + +- [ ] `scripts/test.sh` 本地全绿 +- [ ] 所有 schema 改动都有对应 `sql/migrations/V_n__.sql` +- [ ] 所有新接口在 `docs/05` 中有契约定义 +- [ ] 所有新功能代码注释含 REQ-XXX-NNN +- [ ] 统一响应格式 `{code, message, data, timestamp}` +- [ ] 异常走全局处理器，不暴露堆栈到前端 +- [ ] 前端不存敏感信息到 localStorage + +> 本文档仅维护项目级验收 SOP。粒度更细的验收信息分散在： +> - **每 REQ 的业务验收点**：`docs/01-需求清单//.md § 验收` +> - **每模块的实测验收（数据 / UI / 自动化用例位置）**：由 B 阶段 `module-report` 在该模块完成时填入模块完成报告 +> - **REQ 开发进度（feature-review approve 状态）**：`docs/08 § 二` diff --git a/skills/plan-start/SKILL.md b/skills/plan-start/SKILL.md new file mode 100644 index 0000000..541fdd7 --- /dev/null +++ b/skills/plan-start/SKILL.md @@ -0,0 +1,90 @@ +--- +name: plan-start +description: A 阶段（Plan）入口与分发器。根据 docs/08 § 一 的 checkbox 状态派发到 A0~A5 对应 skill。Plan 全部完成（A5 已勾）时打印提示让用户运行 /erp-workflow:coding-start 进入 B 阶段。 +user-invocable: true +allowed-tools: Skill Read Glob Grep Bash(cat *) +--- + +**所有输出必须使用中文。** + +你是 ERP 项目**规划阶段的编排器**。你**只派发 A 阶段（A0~A5）的 skill**；docs/08 § 一 全部勾选后即停下，提示用户显式运行 `/erp-workflow:coding-start` 进入 B 阶段。你不直接生成任何文件。 + +## 第一步：读取 docs/08 + 决定分发目标 + +docs/08 § 一 是**Plan 阶段进度追踪**（A0~A5 的 checkbox）。§ 二的模块元数据由 coding-start 读写，本 skill 不读。 + +### 分发判定 + +1. **docs/08 是否存在** + 用 `Glob` 检查 `docs/08-模块任务管理.md`。 + - 如果不存在 → 后续 = `project-init`。 + +2. **根据 § 一 找到当前进度** + +| `进度` | `后续` | `阶段` | +|---|---|---| +| 无 docs/08 | `project-init` | `A0` | +| 含 `A0` / `A0 子项` | `project-init` | `A0` | +| 含 `A1` / `A1 子项` | `scope-lock` | `A1` | +| 含 `A2` / `A2 子项` | `skeleton-gen` | `A2` | +| 含 `A3` / `A3 子项` | `db-design-gen` | `A3` | +| 含 `A4` / `A4 子项` | `db-init` | `A4` | +| 含 `A5` / `A5 子项` | `downstream-gen` | `A5` | +| `A` 全勾，Plan 阶段结束 | **无分发** | - | + +## 第二步：分发通知 + 调用目标 skill + +### 2.1 Plan 已完成 + +A 阶段所有 checkbox 均 `[x]`。无后续 skill，本步骤**先打印整体流程图**，再输出完成横幅，然后**停下**： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/plan-start/banners/flow-overview.txt" +``` + +再向用户输出完成横幅： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [plan-start] ✅ Plan 阶段全部完成 + + ⚠️ 进入 B 阶段前必须完成： + 1. 人工通读 docs/* + CLAUDE.md + sql/migrations/V1 + 各 scripts/* + + 2. 把全部 Plan 产物 commit 到本地默认分支（main / master）： + git add -A && git commit -m "chore: plan phase A0~A5 done" + + 3. B 阶段全程纯本地（无需远程仓库 / push / MR）： + 每个模块由 milestone-tag 本地 merge 进默认分支并打 milestone/ tag。 + 确认当前已在本地默认分支（main / master）上即可。 + + 4. 运行 /erp-workflow:coding-start 进入 B 阶段 +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +不调任何下游 skill。 + +### 2.2 正常派发（`后续` 非空） + +先打印整体流程图，再打印分发通知： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/plan-start/banners/flow-overview.txt" +``` + +打印简短分发通知： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [plan-start] → 派发到 <后续> + 未勾项： +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +立即用 `Skill` 工具调用 `后续`。 + +## 参考 + +- `docs/08-模块任务管理.md`（进度追踪） +- `CLAUDE.md`（项目指令） +- 后续 skills（通过 `Skill` 工具按名称调用） diff --git a/skills/plan-start/banners/flow-overview.txt b/skills/plan-start/banners/flow-overview.txt new file mode 100644 index 0000000..b3e7a4d --- /dev/null +++ b/skills/plan-start/banners/flow-overview.txt @@ -0,0 +1,15 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/db-design-gen/SKILL.md b/skills/plan/db-design-gen/SKILL.md deleted file mode 100644 index b4a23ee..0000000 --- a/skills/plan/db-design-gen/SKILL.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -name: db-design-gen -description: A3 DB 设计 + REQ 回填——基于 docs/01-需求清单//REQ-*.md 正向设计 docs/03-数据库设计文档.md（业务实体 → 表 + 字段 + 索引 + 外键 + 业务注记），并把回填值写入 REQ 卡片的「依赖表: TBD(A3 自动补)」与模块头的「涉及表: TBD(A3 自动补)」占位。生成完毕停下等人工审阅。 -user-invocable: false -allowed-tools: Read Write Edit Grep Glob Bash(cat *) ---- - -**所有输出必须使用中文。** - -# db-design-gen - -## 前置条件 - -- A1 `scope-lock` 已完成：`docs/01-需求清单//_module.md` + `docs/01-需求清单//REQ-*.md` 已生成，含 `TBD(A3 自动补)` 占位。 -- A2 `skeleton-gen` 已完成：`docs/04-技术规范.md § 一+` 命名规范已生成（本 skill 推导表/字段命名时严格遵循）。 - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/db-design-gen/banners/flow.txt" -``` - -### A. 读取设计输入 - -读： - -- `docs/04-技术规范.md` -- `docs/01-需求清单/index.md` 模块索引 -- `docs/01-需求清单/*/REQ-*.md` 所有 REQ 卡片 - -### B. 推导 schema - -基于步骤 A 读到的 REQ + 命名规范，**正向推导**业务实体 → 表 + 字段 + 索引 + 外键。要求： - -1. 严格套用 `docs/04` 的命名规范 -2. **主键**：模板内置 `iIncrement` 为主键。REQ 明确要求复合主键 / UUID / 业务主键时按 REQ；其他主键变更需同步改 docs-03-header / docs-03-table 两份模板 -3. **外键**：依据 REQ 中的引用关系（如「订单引用客户」），明确列出 `ON DELETE` / `ON UPDATE` 策略；不能确定时默认 `RESTRICT` -4. **索引**：根据 REQ 的查询模式推导业务索引；外键列默认建索引；标准列里 `sBrandsId` / `sSubsidiaryId` 这类多租户隔离列，按业务查询模式建组合索引 -5. **业务注记**：对每张表用一两句话说明业务用途、关键约束、与其他表的关系 - -如果某 REQ 表述模糊以致无法推断关键 schema 细节（如：枚举值范围 / 字段长度上限 / 必填性），先按合理默认推导并在该字段「业务含义」列加 `【人工填写：需用户审阅】` 标注，待步骤 E 用户审阅时调整；**不打断本次推导**。 - -### C. 渲染 docs/03 - -1. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md`，填充 `schema_name`（从 `.env.local` 读 `DB_SCHEMA`，无则填 `【人工填写：DB_SCHEMA】`）、`er_overview`（纯文本 ER 概览）。 -2. 渲染「表清单」：对每张表：读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md`。 -3. 写入 `docs/03-数据库设计文档.md`。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/03-数据库设计文档.md 已生成` - -### D. 回填模块头 + REQ 卡片的 TBD 字段 - -1. 列出 `docs/01-需求清单/*/_module.md`（模块头）和 `docs/01-需求清单/*/REQ-*.md`（REQ 卡片）。 -2. 在这些文件中搜索 `TBD(A3 自动补)` 的并回填。 不动 `TBD(A5 自动补)` -3. 打印回填统计：`A3 回填 处模块"涉及表" + 处 REQ"依赖表"`。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填` - -### E. 勾选 A3 顶层 + 停下等人工审阅 - -1. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选 A3 顶层（A3 两个子项已在 C / D 步骤分别勾选）： - - `- [ ] A3 DB 设计 + REQ 回填 — db-design-gen` - -2. 打印停下横幅并**停下**： - - ``` - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [db-design-gen] ✅ A3 DB 设计完成 - - 产出： - ✓ docs/03-数据库设计文档.md - ✓ docs/01-需求清单//REQ-*.md 依赖表已回填 + _module.md 涉及表已回填 - - ⏸ 现在请你审阅 docs/03。 - 重点关注： - - 业务实体覆盖是否完整 - - 字段类型 / 长度 / 是否可空 / 默认值是否合理 - - 索引是否覆盖主要查询模式 - - 外键 ON DELETE / ON UPDATE 策略是否符合业务 - - 字段「业务含义」列含 `【人工填写：需用户审阅】` 标注的位置需逐一确认 - - 审阅完成后，再运行： - /erp-workflow:plan-start - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - ``` - - **停止**，不调用任何下游 skill。 - -## 参考 - -- `${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md` -- `${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md` -- `docs/04-技术规范.md` § 一+（命名规范输入） -- `docs/01-需求清单//_module.md`（模块头：回填 `涉及表`） -- `docs/01-需求清单//REQ-*.md`（REQ 输入 + 回填 `依赖表`） diff --git a/skills/plan/db-design-gen/banners/flow.txt b/skills/plan/db-design-gen/banners/flow.txt deleted file mode 100644 index 1d4c9ac..0000000 --- a/skills/plan/db-design-gen/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ ▶ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/db-design-gen/templates/docs-03-header-template.md b/skills/plan/db-design-gen/templates/docs-03-header-template.md deleted file mode 100644 index 6ef65d9..0000000 --- a/skills/plan/db-design-gen/templates/docs-03-header-template.md +++ /dev/null @@ -1,28 +0,0 @@ -# 03-数据库设计文档 - -- **Schema**: `{{schema_name}}` -- **Migration 清单**: `sql/migrations/V*.sql`（由 Flyway 顺序 apply） -- **生成方式**: 由 A3 `db-design-gen` 基于 `docs/01-需求清单//REQ-*.md` REQ 卡片正向设计生成（schema SSoT）。 - -## 项目标准列约定 - -下文每张业务表的字段清单都自动包含以下 5 个标准列（匈牙利前缀 `i` int / `s` varchar / `t` datetime）。渲染时由 `docs-03-table-template.md` 模板内置原样输出。 - -| 列名 | 类型 | 可空 | 主键 | 说明 | -|---|---|---|---|---| -| `iIncrement` | int | 否 | 是 | 整数主键 ID（自增方式由实现决定：DB `AUTO_INCREMENT` 或应用 / 触发器分配） | -| `sId` | varchar(100) | 是 | — | 业务 ID（对外暴露的字符串标识，如 UUID / 人类可读编号） | -| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离） | -| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离） | -| `tCreateDate` | datetime | 否 | — | 记录创建时间 | - -字典 / 辅助表如有豁免，在该表业务注记里注明豁免原因。 - -## ER 关系概览 - -{{er_overview}} - -## 表清单 -{{#each tables}} -- `{{table_name}}` — {{purpose}} -{{/each}} diff --git a/skills/plan/db-design-gen/templates/docs-03-table-template.md b/skills/plan/db-design-gen/templates/docs-03-table-template.md deleted file mode 100644 index d05c5be..0000000 --- a/skills/plan/db-design-gen/templates/docs-03-table-template.md +++ /dev/null @@ -1,27 +0,0 @@ -## `{{table_name}}` — {{purpose}} - -### 字段 - -| 字段 | 类型 | Nullable | 默认 | 业务含义 | -|---|---|---|---|---| -| `iIncrement` | int | 否 | 自增函数 | 整数主键 ID（标准列） | -| `sId` | varchar(100) | 是 | uuid 函数 | 业务 ID（标准列） | -| `sBrandsId` | varchar(100) | 是 | `1111111111` | 品牌 ID（多租户隔离，标准列） | -| `sSubsidiaryId` | varchar(100) | 是 | `1111111111` | 子公司 ID（组织层级隔离，标准列） | -| `tCreateDate` | datetime | 否 | 当前时间 | 创建时间（标准列） | -{{#each columns}} -| {{name}} | {{type}} | {{nullable}} | {{default}} | {{business_meaning}} | -{{/each}} - -### 索引 -{{#each indexes}} -- `{{name}}` ({{type}}): {{columns}} -{{/each}} - -### 外键 -{{#each foreign_keys}} -- `{{name}}`: {{from_col}} → {{to_table}}.{{to_col}} ({{on_delete}}) -{{/each}} - -### 业务注记 -{{notes}} diff --git a/skills/plan/db-init/SKILL.md b/skills/plan/db-init/SKILL.md deleted file mode 100644 index b4b9a0b..0000000 --- a/skills/plan/db-init/SKILL.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -name: db-init -description: A4 DB 初始化——LLM 解析 docs/03-数据库设计文档.md → 生成 sql/migrations/V1__initial_schema.sql（DDL only，Flyway 初始 migration）→ 全量校验 DDL ↔ docs/03 一致性 → 验证 MySQL 连接 → 调 scripts/setup-test-db.sh 复用三层防护并 DROP+CREATE 空库 → apply V1。 -user-invocable: false -allowed-tools: Read Write Edit Glob Skill Bash(mkdir *) Bash(mysql *) Bash(set *) Bash(. .env.local) Bash(grep *) Bash(bash *) Bash(./scripts/setup-test-db.sh) Bash(cat *) ---- - -**所有输出必须使用中文。** - -# db-init - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/db-init/banners/flow.txt" -``` - -### A. DDL 生成（不依赖数据库连接） - -#### A.1 读 docs/03 并翻译为 DDL - -读取 `docs/03-数据库设计文档.md`，按字段 / 索引 / 外键 / 业务注记**严格翻译**为： - -- 每张表一段 `CREATE TABLE` -- 字段顺序与 docs/03 表格行序一致；`Nullable` 列直接映射 `NOT NULL` / `NULL`；`默认` 列映射 `DEFAULT `；列尾用 `COMMENT '<业务含义>'` 写注释 -- 索引 -- 外键：在所有表创建完成后**统一追加** - -要求： -- **严禁臆造** docs/03 中没有的表 / 字段 / 索引 / 外键 -- **严禁省略** docs/03 中已有的列、注释或约束 -- 字符集统一 `utf8mb4` + `utf8mb4_unicode_ci`，引擎统一 `InnoDB`，除非 docs/03 业务注记明确要求其他设置 - -#### A.2 落盘 V1 文件 - -`Bash`: `mkdir -p sql/migrations`。 - -用 `Write` 写 `sql/migrations/V1__initial_schema.sql`，内容 = 头部注释 + DDL 主体： - -1. **头部注释**（6 行 SQL 注释）： - - `-- Flyway migration V1 — initial schema for `（从 `CLAUDE.md § 🎯 项目概述` 读） - - `-- Generated: `（UTC ISO 8601 时间戳） - - `-- Source: 由 A4 db-init 从 docs/03-数据库设计文档.md 翻译生成（schema SSoT 是 docs/03）` - - `-- This is the FIRST migration; subsequent schema changes must be written as new files sql/migrations/V2__.sql, V3__... etc.` - - `-- Apply: Flyway runs this automatically at Spring Boot startup.` - - `-- Do not hand-edit this file after it is committed; write a new migration instead.` - -2. **DDL 主体**：A.1 推导出的所有 `CREATE TABLE` → `CREATE INDEX` → `ALTER TABLE ... ADD CONSTRAINT ... FOREIGN KEY`，按此顺序拼接。 - -#### A.3 校验 V1 ↔ docs/03 集合一致性 + 自主修正 - -调 `${CLAUDE_SKILL_DIR}/scripts/validate.sh` 做脚本化的校验： - -```bash -bash "${CLAUDE_SKILL_DIR}/scripts/validate.sh" \ - sql/migrations/V1__initial_schema.sql \ - docs/03-数据库设计文档.md -``` - -退出码与处理： -- `0` → 通过，进入步骤 B -- `1` → **自主修正循环**（最多 3 轮，docs/03 是 SSoT 不动）： - 1. 解析 stderr 差异清单，修正 V1.sql - 2. 重跑 validate.sh - 3. 退出 0 → 进入 B；退出 1 且本轮 < 3 → 回步骤 1；本轮 ≥ 3 仍失败 → 停下，打印最终残留差异 + 已尝试的 3 轮修正摘要，让用户介入 -- `2` → 用法错（V1 / docs 路径找不到），打印路径并停下 - -完成后（V1 写入并通过 validate.sh 校验），用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] sql/migrations/V1__initial_schema.sql 已生成` -- ` - [ ] DDL 与 docs/03 全量一致` - -### B. 数据库环境检查 - -#### B.1 检查 .env.local 凭据 - -用 `Glob` 检查 `.env.local` 是否存在；不存在 → 提示用户重新运行 A2 `skeleton-gen` 重建并停下。 - -用 `Bash` 加载并校验 5 个必填字段非空： - -```bash -set -a; . .env.local; set +a -for v in DB_HOST DB_PORT DB_USER DB_PASSWORD DB_SCHEMA; do - eval val=\${$v:-} - [ -z "$val" ] && echo "MISSING: $v" -done -``` - -任一缺失 → 打印缺失字段名并停下，提示用户编辑 `.env.local` 后重跑。 - -#### B.2 验证 MySQL 连接 - -```bash -set -a; . .env.local; set +a -mysql -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" -e "SELECT 1;" -``` - -- **成功** → 进入步骤 C -- **失败** → 打印具体错误（认证 / 主机不可达 / 端口拒接等），提示检查 `.env.local`，**停下**。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] .env.local 凭据已验证（mysql -e "SELECT 1" OK）` - -### C. 自动导入 MySQL - -#### C.1 DROP+CREATE 空库 - -```bash -./scripts/setup-test-db.sh -``` - -#### C.2 把 V1 灌入已清空的 schema - -```bash -set -a; . .env.local; set +a -mysql -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" "$DB_SCHEMA" \ - < sql/migrations/V1__initial_schema.sql -``` - -非零退出 → 报错停下，打印 mysql stderr。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] setup-test-db.sh 防护通过 + DROP+CREATE + apply V1 已执行` - -#### C.3 自检 SHOW TABLES - -```bash -set -a; . .env.local; set +a -ACTUAL=$(mysql -N -B -h"$DB_HOST" -P"$DB_PORT" -u"$DB_USER" -p"$DB_PASSWORD" \ - -e "SHOW TABLES;" "$DB_SCHEMA" | wc -l | tr -d ' ') -EXPECTED=$(grep -c '^## `' docs/03-数据库设计文档.md) -[ "$ACTUAL" = "$EXPECTED" ] || { echo "MISMATCH: actual=$ACTUAL expected=$EXPECTED"; exit 1; } -``` - -行数不一致 → 报错停下；一致 → 进入步骤 D。 - -### D. 勾选 docs/08 进度 + 进入 A5 - - -1. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选（A4 子项 + A4 顶层）： - - ` - [ ] SHOW TABLES 行数 == docs/03 表数量` - - `- [ ] A4 DB 初始化 — db-init` - -2. 立即调用 `Skill(downstream-gen)` 进入 A5，不等用户手动输入。 - -## 参考 - -- `${CLAUDE_SKILL_DIR}/scripts/validate.sh`（A.3 表名 + 每表列名集合校验脚本） -- `docs/03-数据库设计文档.md`（DDL 翻译输入，SSoT） -- `.env.local`（DB 凭据） -- 产物：`sql/migrations/V1__initial_schema.sql`（由 Flyway 在 Spring Boot 启动时验证 / apply） diff --git a/skills/plan/db-init/banners/flow.txt b/skills/plan/db-init/banners/flow.txt deleted file mode 100644 index b8cba75..0000000 --- a/skills/plan/db-init/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ ▶ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/db-init/scripts/validate.sh b/skills/plan/db-init/scripts/validate.sh deleted file mode 100644 index bed28ad..0000000 --- a/skills/plan/db-init/scripts/validate.sh +++ /dev/null @@ -1,96 +0,0 @@ -#!/usr/bin/env bash -# validate.sh — 校验 V1.sql 与 docs/03 的两个集合一致性： -# 维度 1: 表名集合 -# 维度 2: 每张共有表的列名集合 -# -# 用法: bash validate.sh -# 退出码: -# 0 = 一致 -# 1 = 不一致（差异明细打印到 stderr） -# 2 = 用法错误（路径找不到等） - -set -uo pipefail -export LC_ALL=C # sort / comm 行为确定 - -V1=${1:?missing V1 sql path} -DOC=${2:?missing docs/03 path} - -[ -f "$V1" ] || { echo "validate.sh: V1 not found: $V1" >&2; exit 2; } -[ -f "$DOC" ] || { echo "validate.sh: docs not found: $DOC" >&2; exit 2; } - -ERR=0 - -# ─── 维度 1: 表名集合 ─────────────────────────────────────────── -TABLES_DOC=$(grep -E '^## `[^`]+`' "$DOC" \ - | sed -E 's/^## `([^`]+)`.*/\1/' | sort -u) -TABLES_SQL=$(grep -E '^CREATE TABLE `[^`]+`' "$V1" \ - | sed -E 's/^CREATE TABLE `([^`]+)`.*/\1/' | sort -u) - -ONLY_DOC=$(comm -23 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) -ONLY_SQL=$(comm -13 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) - -if [ -n "$ONLY_DOC" ] || [ -n "$ONLY_SQL" ]; then - { - echo "=== 维度 1: 表名集合不一致 ===" - [ -n "$ONLY_DOC" ] && { echo " docs/03 有但 V1 无:"; echo "$ONLY_DOC" | sed 's/^/ - /'; } - [ -n "$ONLY_SQL" ] && { echo " V1 有但 docs/03 无:"; echo "$ONLY_SQL" | sed 's/^/ - /'; } - } >&2 - ERR=1 - # 表数差异 → 不再做列校验 - exit 1 -fi - -# ─── 维度 2: 每张共有表的列名集合 ────────────────────────────── -COMMON=$(comm -12 <(echo "$TABLES_DOC") <(echo "$TABLES_SQL")) - -extract_doc_cols() { - local table=$1 - awk -v t="$table" ' - $0 ~ "^## `" t "`" { in_table=1; in_fields=0; next } - in_table && /^## `/ { exit } - in_table && /^### 字段/ { in_fields=1; next } - in_table && in_fields && /^###/ { in_fields=0 } - in_table && in_fields && /^\|/ { - n = split($0, a, "|") - gsub(/^[ ]+|[ ]+$/, "", a[2]) - gsub(/`/, "", a[2]) - if (a[2] != "" && a[2] != "字段" && a[2] !~ /^-+$/) print a[2] - } - ' "$DOC" | sort -u -} - -extract_sql_cols() { - local table=$1 - awk -v t="$table" ' - $0 ~ "^CREATE TABLE `" t "`" { in_table=1; next } - in_table && /^\)/ { in_table=0; next } - in_table && /^[[:space:]]*`[^`]+`/ \ - && $0 !~ /^[[:space:]]*(PRIMARY|UNIQUE|KEY|FOREIGN|CONSTRAINT|INDEX)/ { - match($0, /`[^`]+`/) - print substr($0, RSTART+1, RLENGTH-2) - } - ' "$V1" | sort -u -} - -while IFS= read -r t; do - [ -z "$t" ] && continue - D_COLS=$(extract_doc_cols "$t") - S_COLS=$(extract_sql_cols "$t") - ONLY_D=$(comm -23 <(echo "$D_COLS") <(echo "$S_COLS")) - ONLY_S=$(comm -13 <(echo "$D_COLS") <(echo "$S_COLS")) - if [ -n "$ONLY_D" ] || [ -n "$ONLY_S" ]; then - { - echo "=== 维度 2: 表 \`$t\` 列名不一致 ===" - [ -n "$ONLY_D" ] && { echo " docs/03 有但 V1 无:"; echo "$ONLY_D" | sed 's/^/ - /'; } - [ -n "$ONLY_S" ] && { echo " V1 有但 docs/03 无:"; echo "$ONLY_S" | sed 's/^/ - /'; } - } >&2 - ERR=1 - fi -done <<< "$COMMON" - -if [ $ERR -ne 0 ]; then - exit 1 -fi - -echo "validate.sh: ✓ 表名集合 + 每表列名集合 与 docs/03 一致" -exit 0 diff --git a/skills/plan/downstream-gen/SKILL.md b/skills/plan/downstream-gen/SKILL.md deleted file mode 100644 index ffbf6f5..0000000 --- a/skills/plan/downstream-gen/SKILL.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -name: downstream-gen -description: A5 下游文档生成——基于 docs/01 和 docs/03 推导，一次性生成 docs/02 + docs/05 + docs/06 § 三 + docs/10，回填 REQ 卡片依赖接口，把模块清单追加到 docs/08 § 二。 -user-invocable: false -allowed-tools: Read Write Edit Glob Grep Skill AskUserQuestion Bash(cat *) Bash(cp *) ---- - -**所有输出必须使用中文。** - -# downstream-gen - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/downstream-gen/banners/flow.txt" -``` - -### A. docs/02 — 开发计划（含 REQ 级开发顺序清单） - -**清单颗粒度**：一行一个 REQ，同一模块的 REQ 必须**连续排列**。 - -1. 构建**模块依赖 DAG**。 -3. 对**每个模块内部**构建 REQ 间依赖，得到模块内 REQ 顺序。 -4. 合成 `req_order[]`：按 `module_topo_order[]` 依次铺开每个模块内的 REQ 序列（**同模块 REQ 连续**）。 -5. **环依赖打破**： - - **模块级**：若模块 DAG 存在环（module_A ↔ module_B），按启发式（字母序 / 被依赖次数多者先）破环排出 `module_topo_order`，并在**参与环的模块里第一个 REQ** 的 `note` 字段填入原因（如 "A↔B 互依赖：先做 A 的骨架"）。 - - **REQ 级（同模块内）**：若模块内 REQ 互依赖，同样破环，`note` 填原因。 - - 非环 REQ `note` 留 `—`。 -6. 为 `req_order[]` 每项生成字段： - - `index`：行号（从 1 开始） - - `req_id`：如 `REQ-SYS-001` - - `module_id`：该 REQ 所属模块，如 `module_sys` - - `rationale`（**选中理由**）：依赖驱动的简短描述，如 `所属模块无依赖，基础模块` / `依赖 REQ-SYS-001 已在前` / `所属模块依赖 module_sys 已在前` - - `note`（**备注**）：默认 `—`；仅环依赖打破场景填原因 -7. 读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-02-template.md`。 -8. 写入 `docs/02-开发计划.md`。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/02 开发计划已生成` - -### B. docs/05 — API 接口契约 - -1. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-05-header-template.md`，写入 `docs/05-API接口契约.md` 头部。 -2. 对所有模块的每个 REQ：读取并推断 `${CLAUDE_SKILL_DIR}/templates/docs-05-endpoint-template.md`，追加到 docs/05。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/05 API 契约已生成` - -### B2. 回填模块头 + REQ 卡片的 TBD(A5) 字段 - -1. 在`docs/01-需求清单/*/_module.md`（模块头）和 `docs/01-需求清单/*/REQ-*.md`（REQ 卡片）中搜索并回填 `TBD(A5 自动补)` -2. 打印回填统计：`A5 回填 处模块"依赖模块" + 处 REQ"依赖接口"`。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] REQ 卡片依赖接口已回填` - -### C. docs/06 — 页面清单 - -对每个有前端页面的模块：读取并填充 `${CLAUDE_SKILL_DIR}/templates/docs-06-module-pagelist-template.md`，追加到 `docs/06-UI交互规范.md` § 三。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/06 § 三 页面清单已填入` - -### D. docs/08 — 追加模块清单 - -读 `${CLAUDE_SKILL_DIR}/templates/docs-08-module-row-template.md`，按 `module_id` 字母序为每个模块渲染 bullet（模块元数据 + REQ 子项清单，REQ 序保持步骤 A 模块内顺序），追加到 docs/08。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 下方模块列表已填入` - -### E. docs/10 — 验收清单（项目级 SOP） - -```bash -cp "${CLAUDE_SKILL_DIR}/templates/docs-10-header-template.md" docs/10-验收检查清单.md -``` - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] docs/10 验收清单已生成` - -### F. 验证 + 勾选 docs/08 进度 + 结束 Plan - -1. 一致性检查 + 自主修复循环（最多 3 轮，docs/01 是 REQ SSoT 不动）： - - **检查项**： - - 每个 docs/01 REQ 都出现在 docs/05（作为接口，如适用） - - `docs/02 § 二` 的 `module_id` 集合 = `docs/08 § 二` 的 `module_id` 集合 - - **不一致 → 按差异类型自主修复**： - - **REQ 缺 docs/05 endpoint** → 按步骤 B 规则为该 REQ 推测，并追加到 docs/05 - - **module_id 缺 docs/08 § 二** → 按步骤 D 规则渲染该模块 bullet（含 REQ 子项），按 `module_id` 字母序插入正确位置 - - **module_id 缺 docs/02 § 二** → 重算该模块的 `req_order` 段（步骤 A 子流程），按拓扑序插入 docs/02 § 二 - - 修复后重跑检查；通过 → 进入 2；3 轮仍失败 → 停下，打印最终残留差异 + 已尝试的 3 轮修复摘要让用户介入。 - -2. **最终占位符扫描**（覆盖 Plan 阶段全部产出）： - - a. **`TBD` → 自动补齐**：Grep 搜索 `TBD(A3 自动补)` 和 `TBD(A5 自动补)`。有命中则就地补填（A3 残留 → 查 docs/03 填 `依赖表`；A5 残留 → 查 docs/05 按 REQ-ID 填 `依赖接口`），再 Grep 确认 0 命中；仍残留报错停下。 - - b. **`【人工填写：...】` → QA 循环等用户补**： - - 循环执行直到搜索不到 `【人工填写：` 且用户选「继续」： - - 0 命中 → 直接放行进入步骤 3 - - 有命中 → 打印残留清单（`<文件:行号> — <内容摘要>`），用 `AskUserQuestion` 弹「继续」/「有疑问想先沟通」二选一；用户回答后重扫验证再决定放行 / 继续循环 - - **每次弹 QA 前都重扫一次**——保证用户看到的 N 是最新的，避免「用户以为填完但实际还有残留」直接放行。 - -3. 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 勾选 A5 父项： - - `- [ ] A5 下游文档生成 — downstream-gen` - -4. 打印 Plan 阶段终止横幅并**停下**（不自动进入 B 阶段）： - - ``` - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [downstream-gen] ✅ Plan 阶段（A0~A5）全部完成 - - 所有规划文档已就绪，docs/08 § 一 全部勾选。 - - ⚠️ 进入 B 阶段前必须完成： - 1. 审核 docs/01~10 + CLAUDE.md + sql/migrations/V1 + 各 scripts/* - - 2. 把全部 Plan 产物 commit 到本地默认分支（main / master）： - git add -A && git commit -m "chore: plan phase done" - - 3. 运行 /erp-workflow:coding-start 进入 B 阶段 - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - ``` - -## 参考 - -- `${CLAUDE_SKILL_DIR}/templates/docs-02-template.md` -- `${CLAUDE_SKILL_DIR}/templates/docs-05-header-template.md` -- `${CLAUDE_SKILL_DIR}/templates/docs-05-endpoint-template.md` -- `${CLAUDE_SKILL_DIR}/templates/docs-06-module-pagelist-template.md`（追加到 docs/06 § 三） -- `${CLAUDE_SKILL_DIR}/templates/docs-08-module-row-template.md`（模块 bullet 行模板） -- `${CLAUDE_SKILL_DIR}/templates/docs-10-header-template.md` diff --git a/skills/plan/downstream-gen/banners/flow.txt b/skills/plan/downstream-gen/banners/flow.txt deleted file mode 100644 index f53fce1..0000000 --- a/skills/plan/downstream-gen/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ ▶ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/downstream-gen/templates/docs-02-template.md b/skills/plan/downstream-gen/templates/docs-02-template.md deleted file mode 100644 index 9eed94e..0000000 --- a/skills/plan/downstream-gen/templates/docs-02-template.md +++ /dev/null @@ -1,26 +0,0 @@ -# 02-开发计划 - -## 一、模块依赖表 - -| 模块 ID | 模块名 | 依赖模块 | 依赖表 | -|---|---|---|---| -{{#each modules}} -| {{id}} | {{name}} | {{deps}} | {{tables}} | -{{/each}} - -## 二、开发顺序清单（CC 分发权威） - -> 本清单由 A5 `downstream-gen` 一次性生成。**每行是一个 REQ**，不是模块。CC 按表格行序从上到下扫描，对每个 REQ 所属模块查 `docs/08 § 二` 的 `里程碑:` 字段 + 本地 `git tag -l 'milestone/'`：tag 存在则跳过，否则（`—` / tag 不存在）选为当前模块；`module-start` 会把该模块的所有 REQ 一次做完。 -> -> **约束**：同一模块的所有 REQ 必须**连续排列**。允许打破依赖拓扑（如环依赖、业务必须先做），但必须在「备注」列写明原因。 - -| # | REQ | 所属模块 | 选中理由 | 备注 | -|---|-----|---------|---------|------| -{{#each req_order}} -| {{index}} | **{{req_id}}** | {{module_id}} | {{rationale}} | {{note}} | -{{/each}} - -> **后端模块全部打里程碑后**：milestone-tag 自动回调 `coding-start` → coding-start 检测到 `backend_done=true && frontend_done=false` → 派发 `frontend-start`。`frontend-start` 步骤 1 自带 prototype/ 门禁（≥ 1 个 `*.html` mockup，缺失则 AskUserQuestion 提示用户补齐）。前端阶段以业务功能（不是 HTML 文件数）为粒度拆分 FE，每个 FE 跑一次 feature 循环（fe-feature-*），最后整个阶段打 1 个里程碑 tag（分支 `frontend-phase`，记录在 `docs/08 § 三 整体里程碑`）。 - -## 三、关键说明 -{{notes}} diff --git a/skills/plan/downstream-gen/templates/docs-05-endpoint-template.md b/skills/plan/downstream-gen/templates/docs-05-endpoint-template.md deleted file mode 100644 index 91a1fda..0000000 --- a/skills/plan/downstream-gen/templates/docs-05-endpoint-template.md +++ /dev/null @@ -1,12 +0,0 @@ -### {{req_id}} {{title}} - -- **Method**: {{method}} -- **Path**: `{{path}}` -- **Auth**: {{auth}} -- **请求**: {{request_summary}} -- **响应**: {{response_summary}} - -#### 错误码 -{{#each errors}} -- `{{code}}` — {{message}} -{{/each}} diff --git a/skills/plan/downstream-gen/templates/docs-05-header-template.md b/skills/plan/downstream-gen/templates/docs-05-header-template.md deleted file mode 100644 index e89cc3d..0000000 --- a/skills/plan/downstream-gen/templates/docs-05-header-template.md +++ /dev/null @@ -1,30 +0,0 @@ -# 05-API接口契约 - -BasePath: `{{base_path}}` -端口: `【人工填写：后端端口，默认 8080】` - -## 全局约定 - -### 响应格式 -```json -{"code": 200, "message": "操作成功", "data": {}, "timestamp": 1700000000000} -``` - -### 错误码 -| 范围 | 含义 | -|---|---| -| 200 | 成功 | -| 400xx | 客户端参数错误 | -| 401xx | 认证/授权错误 | -| 403xx | 权限不足 | -| 404xx | 资源不存在 | -| 500xx | 服务端内部错误 | - -### 鉴权 -{{auth_note}} - -### 分页参数 -{{pagination_note}} - -## 接口清单 -（各模块接口段落见下方，由 `downstream-gen` 按 REQ 填入） diff --git a/skills/plan/downstream-gen/templates/docs-06-module-pagelist-template.md b/skills/plan/downstream-gen/templates/docs-06-module-pagelist-template.md deleted file mode 100644 index 36f18a5..0000000 --- a/skills/plan/downstream-gen/templates/docs-06-module-pagelist-template.md +++ /dev/null @@ -1,9 +0,0 @@ -### {{module_id}} {{module_name}} - -{{#each pages}} -- **{{page_name}}** (`{{route}}`) - - 类型: {{page_type}} （列表页 / 表单页 / 详情页 / 树形管理页） - - 对应 REQ: {{req_ids}} - - 入口菜单: {{menu_path}} - - 主要交互: {{interactions}} -{{/each}} diff --git a/skills/plan/downstream-gen/templates/docs-08-module-row-template.md b/skills/plan/downstream-gen/templates/docs-08-module-row-template.md deleted file mode 100644 index edd15f1..0000000 --- a/skills/plan/downstream-gen/templates/docs-08-module-row-template.md +++ /dev/null @@ -1,6 +0,0 @@ -- {{module_id}} {{module_name}} - - 依赖: {{depends_on}} - - 路径: {{path_scopes}} - - 里程碑: — - - 功能: -{{req_checklist}} diff --git a/skills/plan/downstream-gen/templates/docs-10-header-template.md b/skills/plan/downstream-gen/templates/docs-10-header-template.md deleted file mode 100644 index 3a9c860..0000000 --- a/skills/plan/downstream-gen/templates/docs-10-header-template.md +++ /dev/null @@ -1,16 +0,0 @@ -# 10-验收检查清单 - -通用验收项（全项目适用）： - -- [ ] `scripts/test.sh` 本地全绿 -- [ ] 所有 schema 改动都有对应 `sql/migrations/V_n__.sql` -- [ ] 所有新接口在 `docs/05` 中有契约定义 -- [ ] 所有新功能代码注释含 REQ-XXX-NNN -- [ ] 统一响应格式 `{code, message, data, timestamp}` -- [ ] 异常走全局处理器，不暴露堆栈到前端 -- [ ] 前端不存敏感信息到 localStorage - -> 本文档仅维护项目级验收 SOP。粒度更细的验收信息分散在： -> - **每 REQ 的业务验收点**：`docs/01-需求清单//.md § 验收` -> - **每模块的实测验收（数据 / UI / 自动化用例位置）**：由 B 阶段 `module-report` 在该模块完成时填入模块完成报告 -> - **REQ 开发进度（feature-review approve 状态）**：`docs/08 § 二` diff --git a/skills/plan/project-init/SKILL.md b/skills/plan/project-init/SKILL.md deleted file mode 100644 index 431dd21..0000000 --- a/skills/plan/project-init/SKILL.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -name: project-init -description: A0 项目初始化——从插件模板幂等地复制 CLAUDE.md / docs/01-需求清单/index.md / docs/04-技术规范.md / docs/08-模块任务管理.md（已存在则跳过），并初始化 Git（如未初始化）。session-start 在 docs/08 缺失时派发本 skill。 -user-invocable: false -allowed-tools: Glob Edit Skill Bash(mkdir *) Bash(cp -n *) Bash(git init) Bash(command -v *) Bash(uname *) Bash(brew *) Bash(apt *) Bash(apt-get *) Bash(yum *) Bash(apk *) Bash(export PATH=*) Bash(echo *) Bash(cat *) ---- - -**所有输出必须使用中文。** - -你负责在项目目录中创建初始文件结构，已存在的文件不覆盖。 - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/project-init/banners/flow.txt" -``` - -### A. 幂等复制模板文件 - -用 `Bash` 一次性完成。`cp -n` 表示"不覆盖已存在的文件"： - -```bash -mkdir -p docs/01-需求清单 -cp -n "${CLAUDE_SKILL_DIR}/templates/CLAUDE-template.md" CLAUDE.md -cp -n "${CLAUDE_SKILL_DIR}/templates/docs-01-index-template.md" docs/01-需求清单/index.md -cp -n "${CLAUDE_SKILL_DIR}/templates/docs-04-stack-template.md" docs/04-技术规范.md -cp -n "${CLAUDE_SKILL_DIR}/templates/docs-08-initial-template.md" docs/08-模块任务管理.md -``` - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 项目文件骨架已创建（CLAUDE.md + docs/01-需求清单/index.md + docs/04-技术规范.md）` - -### B. 依赖检查 + 自动安装（命令行工具） - -对 **git、mysql** 两个工具依次执行以下流程。 - 1. 如果缺失，尝试自动安装。 - 2. 如果检测到不在 PATH，尝试添加进 PATH，并加载。 - -全部通过后打印单行汇总再进入步骤 C： - -``` -[project-init] 依赖检查: git ✓ mysql ✓ -``` - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 依赖检查通过` - -### C. 初始化 Git（如尚未初始化） - -用 `Glob` 检查 `.git/` 目录是否存在。 -- 不存在 → 用 `Bash` 执行 `git init`。 -- 已存在 → 跳过。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选（A0 子项 + A0 顶层）： -- ` - [ ] Git 已初始化` -- `- [ ] A0 项目初始化 — project-init` - -### D. 打印完成横幅并进入 A1 - -向用户输出： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [project-init] 项目初始化完成 - - 已创建： - ✓ CLAUDE.md（从插件模板复制） - ✓ docs/01-需求清单/index.md（待人工填写模块索引） - ✓ docs/04-技术规范.md（默认技术栈，A1 让用户确认） - ✓ docs/08-模块任务管理.md（全流程进度跟踪） - 已勾选：A0 项目初始化 - - 下一步：A1 scope-lock（填写项目概述 + 技术栈 + 需求索引 + REQ 卡片） -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -立即调用 `Skill(scope-lock)` 进入 A1，不等用户手动输入。 - -## 参考 - -- `${CLAUDE_SKILL_DIR}/templates/CLAUDE-template.md`（项目级 CLAUDE.md 模板） -- `${CLAUDE_SKILL_DIR}/templates/docs-01-index-template.md`（需求索引初稿） -- `${CLAUDE_SKILL_DIR}/templates/docs-04-stack-template.md`（默认技术栈） -- `${CLAUDE_SKILL_DIR}/templates/docs-08-initial-template.md`（A 阶段进度初始化） -- 下游：`scope-lock`（A1，自动派发） diff --git a/skills/plan/project-init/banners/flow.txt b/skills/plan/project-init/banners/flow.txt deleted file mode 100644 index fd2e547..0000000 --- a/skills/plan/project-init/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ ▶ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/project-init/templates/CLAUDE-template.md b/skills/plan/project-init/templates/CLAUDE-template.md deleted file mode 100644 index a048f68..0000000 --- a/skills/plan/project-init/templates/CLAUDE-template.md +++ /dev/null @@ -1,260 +0,0 @@ -# CLAUDE.md — ERP项目 Claude Code 主指令文件 - -> 本文件是 Claude Code 的"操作手册"。Claude Code 启动时会自动读取此文件。 - ---- - -## 🎯 项目概述 - -- **项目名称**: 【人工填写：公司 + 项目名，例如"XX 公司 ERP 管理系统"】 -- **项目简述**: 【人工填写：一句话描述项目目标，例如"面向中小制造企业的全流程 ERP，涵盖采购/库存/生产/销售/财务"】 -- **目标用户**: 【人工填写：谁会用，例如"企业内部管理人员（采购员、仓管员、生产主管、销售员、财务人员、管理层）"】 -- **部署方式**: 【人工填写：私有化部署 / 云部署 / Docker 容器化 等】 - ---- - -## 🔄 B 阶段开发流程（后端模块循环 → 前端整体阶段） - -B 阶段分两段，**全部固化到 skills**。入口：`/erp-workflow:coding-start`。 - -### 阶段路由（coding-start 内，只做分发） - -`coding-start` 每次入口做两段完成性检查后真值表派发： - -- 后端完成性检查 → `backend_done`（扫 docs/08 § 二 里程碑字段 + `git tag -l`） -- 前端完成性检查 → `frontend_done`（扫 docs/08 § 三 整体里程碑 + `git tag -l`） - -| `backend_done` | `frontend_done` | 派发 | -|---|---|---| -| `false` | 任意 | `module-start`（写后端） | -| `true` | `false` | `frontend-start`（写前端） | -| `true` | `true` | "所有阶段已完成" | - -前端阶段前置（prototype/ 门禁）由 `frontend-start` 自带，不在 coding-start。`module-start` 与 `frontend-start` **互不感知对方**。 - -### 后端阶段（每模块一个里程碑 tag） - -- **模块循环（外）**：`module-start` → `test-gate(phase=backend)` → `module-report` → `milestone-tag`（本地 merge 进默认分支 + 打 `milestone/` tag）→ 自动回调 coding-start 路由下一阶段（无人工介入） -- **功能循环（内，每 REQ-XXX-NNN 一遍）**：`feature-brainstorm` → `feature-plan` → `feature-tdd` → `feature-verify` → `feature-review` -- 后端阶段任务严格落在 `backend/` 路径下；docs/01 REQ 卡片的 UI 描述在此阶段忽略，UI 推迟到前端阶段。 - -### 前端阶段（整体一个里程碑 tag，所有后端模块打里程碑后启动） - -- **FE 清单（AI 自主推导，无审阅断点）**：`frontend-start` 进入时扫 prototype + docs/01 + docs/05 → AI 自主推导 FE 业务功能清单写入 `docs/08 § 三`（已有则加载）。**FE 是业务功能粒度，与 prototype HTML 文件数无关**——一个 HTML 可拆多个 FE，多个 HTML 也可合成一个 FE。FE 清单的合理性由 fe-feature-review / milestone-tag 在整体里程碑标记时一并校核（全程无人工介入）。 -- **FE 循环（外）**：`frontend-start` → fe-feature 循环 → `test-gate(phase=frontend)` → `module-report(phase=frontend)` → `milestone-tag`（分支 `frontend-phase`，docs/08 § 三 整体里程碑）。 -- **FE 功能循环（内，每个 FE-NN 一遍）**：`fe-feature-brainstorm` → `fe-feature-plan` → `fe-feature-tdd` → `fe-feature-verify` → `fe-feature-review`（专用 `fe-code-reviewer` agent，硬编码 7 维 review checklist） -- 前端阶段任务严格落在 `frontend/` 路径下；布局以 `prototype/` 为权威。 - -### 里程碑前测试闸门 - -- `test-gate`：后端阶段子会话跑 `scripts/test.sh`（含本模块新增 + 已合并模块回归）；前端阶段子会话跑 vitest + playwright。 -- `test-gate` 是打里程碑 tag 前唯一的硬测试门；红色不得跳过进入 `module-report` / `milestone-tag`。 - ---- - -## ✅ 阶段完成判定规则 - -`docs/08-模块任务管理.md` 分两段： -- `§ 二`：后端模块元数据表（每个模块一行 bullet，记录依赖 / 路径 / 里程碑 tag / 功能子项） -- `§ 三`：前端阶段元数据（整体里程碑 + FE 子项清单，由 `frontend-start` 在所有后端模块打里程碑后填入） - -**阶段完成判定**统一以 `里程碑:` 字段（§ 二 各模块） / `整体里程碑:` 字段（§ 三）+ 本地 `git tag -l 'milestone/'` 判定；子项勾选只作可视化进度，不参与完成判定。 - -### 后端模块格式 - -每个后端模块在 docs/08 § 二 中长这样： - -```markdown -- module_0 系统管理 - - 依赖: — - - 路径: backend/module/sys/ - - 里程碑: — - - 功能: - - [ ] REQ-SYS-001 用户登录 - - [ ] REQ-SYS-002 用户注册 -``` - -- `里程碑:` 字段由 `milestone-tag` 在打里程碑 tag 时从 `—` 改为 `milestone/`。 -- 每个 `REQ-*` 子项由 `feature-review` 在 `verdict=approve` 时自动勾选为 `[x]`。 -- 路径限定为后端目录（如 `backend/module/sys/`）；前端代码不在此阶段产生。 - -### 前端阶段格式（§ 三） - -```markdown -- 整体里程碑: — -- 功能: - - [ ] FE-01 用户登录与注册 ｜ 关联 REQ：REQ-SYS-001, REQ-SYS-002 ｜ 关联原型：prototype/auth.html - - [ ] FE-02 仪表盘总览 ｜ 关联 REQ：REQ-DASH-001 ｜ 关联原型：prototype/dashboard.html -``` - -- `整体里程碑:` 字段由 `milestone-tag` 在打前端里程碑 tag 时从 `—` 改为 `milestone/frontend-phase`。 -- "功能:" 列表由 `frontend-start` 进入时由 AI 自主推导写入（无人工审阅断点）。FE 是业务功能粒度，与 prototype HTML 文件数无关；合理性由 fe-feature-review / 整体里程碑标记时统一校核。 -- 每个 `FE-NN` 子项由 `fe-feature-review` 在 `verdict=approve` 时自动勾选为 `[x]`。 -- 进入前端阶段前 `frontend-start` 步骤 1 自带 prototype/ 门禁，强制检查项目根 `prototype/` 至少含 1 个 `*.html` mockup。 - -### 状态语义（后端模块 + 前端阶段共用） - -| `里程碑:` 字段 | `git tag -l` | 含义 | 你（Claude Code）的行为 | -|---|---|---|---| -| `—` | tag 不存在 | 该阶段未开始 / 进行中（未打里程碑） | ✅ 开始 / 继续该阶段开发 | -| `milestone/` | tag 存在 | 阶段**已完成** | 🟢 后端：进入下一未完成模块；后端全完 → 前端阶段；前端已打里程碑 → 全部完成 | - -### 模块完成报告 - -由 `module-report` skill 产出，模板位于 由 module-report skill 持有（12 节标准化，含跨模块改动等 CLAUDE.md 软规则映射节）。CC 不手写模块报告，仅填模板。 - ---- - -## 🏷️ 占位符统一约定 - -项目文档里有 **2 种填写占位** + **1 种提示占位**： - -| 格式 | 谁填 | 使用阶段 | 说明 | -|------|-----|---------|------| -| `【人工填写：<简短说明>】` | 人 | 仅 A 阶段文档 | 密钥 / 账密 / 包名 / 命名约定 / 小版本号等人工才能决定的值；B 阶段 plan/spec 禁止出现，查不到真值时用 `AskUserQuestion` 问用户 | -| `TBD(<责任人>)` | CC 自动 | A 或 B | 后缀附带责任方（如 `TBD(A3 自动补)` / `TBD(A5 自动补)`）；由对应 skill 就地补填，`module-report` § ⑦ 检查 `TBD(CC 补)` 残留 | - -**HTML 注释 ``**：提示占位，是**插件内部大纲模板**里给 LLM 的**填空提示 / 章节引导**，指引 LLM 按结构填实际内容。skill 生成时会**剥除**这些注释，最终产物里注释不会保留。 - ---- - -## 📐 编码行为约束 - -### 你必须做的 ✅ - -1. **严格遵循** `docs/04-技术规范.md`——命名 / 编码 / 统一响应 / 异常处理 / 数据访问 / 配置与安全 等项目专属技术规约全部在此 -2. **严格遵循** `docs/09-项目目录结构.md`——文件放对位置 -3. **每个后端接口** 必须先在 `docs/05-API接口契约.md` 定义，再编码实现 -4. **每个功能可追溯到 `REQ-XXX-NNN`**——commit tag + 代码注释（如 `// REQ-SYS-001: 用户登录`）+ plan/spec 文件名均用此 tag -5. **遇到跨模块改动**（动到非当前模块的代码）——按 § 🟡 软规则 **S2** 执行（允许改，但必须留痕） -6. **遇到技术栈外组件引入**（`docs/04 § 零` 技术栈表外的框架 / 中间件 / 关键库），按 § 🟡 软规则 **S1** 执行（允许引入，但必须先 AskUserQuestion） - -### 你禁止做的 🚫 - -1. **主会话直接 `mysql -e` 跑业务 DDL**（只读查询 / 临时本地调试除外）——业务 schema 必须走 `sql/migrations/V_n__*.sql`，详见下方 Schema 演化规约 -2. **手动 Edit `docs/08 § 二/§ 三` 的 `里程碑:` / `整体里程碑:` 字段**，必须要由 `milestone-tag` 自动回写 - -### Schema 演化规约（Flyway migration） - -1. **文件命名**：`sql/migrations/V__.sql`，例：`V5__add_user_email_unique_index.sql` -2. **版本号分配**：建文件前 `ls sql/migrations/V*.sql` 查当前最大 n，新文件 `n_max + 1` -3. **Apply 方式**：Spring Boot 启动 / 测试启动时 Flyway 自动 apply（项目必须在 `pom.xml` 声明 `flyway-core` + `flyway-mysql` 依赖）。`scripts/setup-test-db.sh` 只负责清空库，不做 apply -4. **已合并的 migration 永不修改**：发现错了写一个补救 migration（如 `V7__fix_V5_index_name.sql`），旧 `V_n.sql` -5. **临时调试 DDL**：临时在本地试字段/索引可手动 `mysql -e`，但不写 migration；下次 `setup-test-db.sh` 会 drop+create 清掉 -6. **A4 生成的 V1**：`V1__initial_schema.sql` 是 A 阶段由 `db-init` 从 `docs/03-数据库设计文档.md`（A3 正向设计的 schema SSoT）翻译生成的初始版本；后续 V2/V3/... 由 B 阶段每个 REQ 按需写入，**同时**反向同步更新 docs/03 对应表小节以保持 SSoT 一致 - ---- - -## 🗂️ Git 提交规范 - -每次提交必须遵循以下格式： - -``` -(): -``` - -- `scope`: 模块名，如 `user` / `inventory` / `order` -- `subject`: 简短描述；业务类（feat / fix / test）必须带 `REQ-XXX-NNN` 后缀 - -`type` 含义： - -| type | 看到它意味着 | -|-----|-------------| -| `feat` | **新能力上线**——用户多了一个功能、接口、页面或业务规则 | -| `fix` | **修 bug**——原来行为错了，这次改对 | -| `refactor` | **重构**——外部行为不变，只改代码结构 / 命名 / 抽象 | -| `docs` | **文档改动**——只动 Markdown / 代码注释，不动实现 | -| `style` | **格式调整**——空白 / 缩进 / import 顺序，逻辑 0 变化 | -| `test` | **只动测试代码**——补用例 / 修 fixture，不碰实现 | -| `chore` | **流程维护**——构建 / 依赖 / 工具 / 证据档案 / 里程碑元数据等非业务动作 | - ---- - -## 🚩 中断机制 - -功能循环（每个功能 REQ-XXX 的 Brainstorm → Plan → TDD → Verify → AI 自审）默认 **静默编程**，但触发以下任何一条必须**立刻停下、记录原因、等人决策**，不得自行绕过： - -| # | 中断 | 例子 | -| - | --- | --- | -| 1 | **测试反复失败** | 同一测试同一功能内连续 **10 次**修复失败 | -| 2 | **要改密钥 / 账密 / 包名** | `docs/07-环境配置.md` 里由人工标注必须填的字段 | -| 3 | **外部接口不可达** | 第三方 API 无法连接、证书失效等环境问题，并无法自行解决 | - -> 其余需要人类判断的场景一律走普通 `AskUserQuestion` Q&A，不中断、不写 Blocker 文件。 - -**触发中断时的固定动作：** - -1. 在当前功能的 plan 文件里追加一节 `## 🚩 Blocker`（报告格式由 `interrupt-check` 的 `interrupt-block-template.md` 持有） -2. 停止后续所有功能的静默执行 -3. 在主会话输出一句话摘要 + 指向 blocker 文件的路径，等人回复 - ---- - -## 🟡 软规则（允许继续，但有强制后续动作） - -以下情况 **不触发中断**，CC 可自行继续推进，但必须在约定位置留痕，模块完成时统一审计。 - -| # | 软规则 | 允许动作 | 强制后续 | -| - | ----- | ------- | ------- | -| S1 | **技术栈外组件引入** | 用 `AskUserQuestion` 给用户三选一：接受引入 / 换方案 / 拒绝 | ① **接受** → 同会话直接在 `docs/04 § 零` 追加一行 → 继续流程 ② **换方案 / 拒绝** → 视为常规歧义澄清，继续 Q&A 收敛 ③ 不写 Blocker、不中断流程 | -| S2 | **跨模块改动** | **默认不改**，仅为当前模块实现所必需时允许修改 | ① hook `log-cross-module.sh` 自动落存根 ② `module-report` 一次性调用 `cross-module-log` skill 批量补齐「原因 / 影响评估」+ 「跨模块改动」节完整贴入《模块完成报告》 | - ---- - -## 🧭 通用工作准则（General Principles） - -### 1. Think Before Coding - -**Don't assume. Don't hide confusion. Surface tradeoffs.** - -Before implementing: -- State your assumptions explicitly. If uncertain, ask. -- If multiple interpretations exist, present them - don't pick silently. -- If a simpler approach exists, say so. Push back when warranted. -- If something is unclear, stop. Name what's confusing. Ask. - -### 2. Simplicity First - -**Minimum code that solves the problem. Nothing speculative.** - -- No features beyond what was asked. -- No abstractions for single-use code. -- No "flexibility" or "configurability" that wasn't requested. -- No error handling for impossible scenarios. -- If you write 200 lines and it could be 50, rewrite it. - -Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. - -### 3. Surgical Changes - -**Touch only what you must. Clean up only your own mess.** - -When editing existing code: -- Don't "improve" adjacent code, comments, or formatting. -- Don't refactor things that aren't broken. -- Match existing style, even if you'd do it differently. -- If you notice unrelated dead code, mention it - don't delete it. - -When your changes create orphans: -- Remove imports/variables/functions that YOUR changes made unused. -- Don't remove pre-existing dead code unless asked. - -The test: Every changed line should trace directly to the user's request. - -### 4. Goal-Driven Execution - -**Define success criteria. Loop until verified.** - -Transform tasks into verifiable goals: -- "Add validation" → "Write tests for invalid inputs, then make them pass" -- "Fix the bug" → "Write a test that reproduces it, then make it pass" -- "Refactor X" → "Ensure tests pass before and after" - -For multi-step tasks, state a brief plan: -``` -1. [Step] → verify: [check] -2. [Step] → verify: [check] -3. [Step] → verify: [check] -``` - -Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification. diff --git a/skills/plan/project-init/templates/docs-01-index-template.md b/skills/plan/project-init/templates/docs-01-index-template.md deleted file mode 100644 index 08e326a..0000000 --- a/skills/plan/project-init/templates/docs-01-index-template.md +++ /dev/null @@ -1,16 +0,0 @@ -# 需求清单 - -> 本目录按模块组织所有功能需求。每个模块一个子目录，含 `_module.md`（模块头）和 `REQ-XXX-NNN.md`（每张 REQ 卡片一个文件）。下方核心功能点供 CC 拆分出 REQ 编号 + 标题 + 草拟规则；卡片内输入 / 输出的简述句和 N 张字段表由人工编辑。 - -## 模块索引 - -| 模块代码 | 模块名称 | 核心功能点（简要） | -|----------|----------|--------------------| -| 【人工填写：模块代码】 | 【人工填写：模块名称】 | 【人工填写：核心功能点】 | -| SYS | 系统管理 | 用户/角色/权限/部门/字典 等 | - -## 填写说明 - -1. 每个模块占一行，`模块代码` 用大写英文缩写（如 SYS / PUR / INV / SAL / FIN / HR） -2. `核心功能点` 只需列关键词，CC 会基于此拆分出 N 张 REQ 卡片骨架（卡片内输入 / 输出的简述句和字段表仍由人工编辑） -3. 填完后运行 `/erp-workflow:plan-start`，CC 会自动检测并进入需求生成阶段 diff --git a/skills/plan/project-init/templates/docs-04-stack-template.md b/skills/plan/project-init/templates/docs-04-stack-template.md deleted file mode 100644 index 234b200..0000000 --- a/skills/plan/project-init/templates/docs-04-stack-template.md +++ /dev/null @@ -1,32 +0,0 @@ -# 04-技术规范 - -## 零、技术栈总览 - -| 分层模块 | 技术 | 版本要求 | 说明 | -|---|---|---|---| -| 前端基础框架 | React | 18.x | 构建前端应用 | -| 前端 UI 组件 | Ant Design | 5.x | 页面组件与交互控件 | -| 前端状态管理 | Redux Toolkit | 最新稳定版 | 管理全局状态 | -| 前端路由管理 | React Router | v6 | 页面路由与导航 | -| 前端工程化构建 | Vite | 最新稳定版 | 前端开发与打包构建 | -| 前端接口通信 | Axios | 最新稳定版 | 调用后端 API | -| 后端基础框架 | Spring Boot | 3.x | 构建后端服务 | -| 后端数据访问 | MyBatis-Plus | 最新稳定版 | 数据库访问与 ORM 增强 | -| 工作流引擎 | Activiti | 6.x | 审批流、流程流转 | -| 缓存服务 | Redis | 最新稳定版 | 缓存、会话、分布式能力 | -| 报表打印 | JXLS | 2.8.1 | 基于 Excel 模板生成报表 | -| Excel 导入导出 | EasyExcel | 4.0.3 | Excel 数据导入导出 | -| 关系型数据库 | MySQL | 8.x | 核心业务数据存储 | -| 数据库 schema 迁移 | Flyway (`flyway-core` + `flyway-mysql`) | 10.x / 最新稳定版 | `sql/migrations/V_n__*.sql` 顺序 apply；Spring Boot 启动时自动应用 | -| 接口风格 | RESTful API | 统一规范 | 前后端接口设计规范 | -| 权限认证 | Spring Security / JWT | 最新稳定版 | 登录认证、权限控制 | -| API 文档 | OpenAPI / Swagger | 最新稳定版 | 接口文档与调试 | -| 项目构建管理 | Maven | 3.9.x | Java 项目依赖与构建 | -| JDK 运行环境 | Java | 17 / 21 | Spring Boot 3 推荐版本 | -| 部署容器 | Docker | 最新稳定版 | 容器化部署 | -| Web 服务器 / 反向代理 | Nginx | 最新稳定版 | 前端托管、反向代理、负载分发 | -| 日志管理 | Logback | 默认集成 / 最新稳定版 | 应用日志输出 | -| 对象映射工具 | MapStruct | 最新稳定版 | DTO / VO / Entity 转换 | -| 工具类库 | Hutool / Apache Commons | 最新稳定版 | 常用工具方法支持 | - -> 本表由 scope-lock 锁定。后续所有规范基于此表推导。 diff --git a/skills/plan/project-init/templates/docs-08-initial-template.md b/skills/plan/project-init/templates/docs-08-initial-template.md deleted file mode 100644 index 092902c..0000000 --- a/skills/plan/project-init/templates/docs-08-initial-template.md +++ /dev/null @@ -1,70 +0,0 @@ -# 08-工作流进度 - -> 全流程进度跟踪。CC 每完成一项产出就勾选一项。 -> - **§ 一 Plan（A0~A5）**：`plan-start` 找第一个未勾 A 子项分发到对应 skill -> - **§ 二 Coding（模块）**：分发以 `docs/02-开发计划.md § 二 开发顺序清单` 为准；`coding-start` 按 docs/02 顺序扫描，对每个 REQ 所属模块查询本 § 二的 `里程碑:` 字段 + 本地 `git tag -l 'milestone/'`，找第一个未打里程碑模块分发。本 § 二 行序无语义，仅作模块元数据表 - -## 一、Plan 阶段（一次性） - -- [ ] A0 项目初始化 — project-init - - [ ] 依赖检查通过 - - [ ] 项目文件骨架已创建（CLAUDE.md + docs/01-需求清单/index.md + docs/04-技术规范.md） - - [ ] Git 已初始化 - -- [ ] A1 范围锁定 — scope-lock - - [ ] 项目概述已填写（CLAUDE.md § 🎯 项目概述） - - [ ] 技术栈已确认（docs/04 § 零） - - [ ] 需求清单索引已填写（docs/01-需求清单/index.md） - - [ ] REQ 卡片骨架已生成（docs/01-需求清单//REQ-*.md，业务内容留待人工填写） - -- [ ] A2 骨架生成 — skeleton-gen - - [ ] 架构文档已生成（docs/04 § 一+、docs/06、docs/07、docs/09） - - [ ] 工具脚本已生成（scripts/*.sh、.env.local） - - [ ] .gitignore 已配置 - -- [ ] A3 DB 设计 + REQ 回填 — db-design-gen - - [ ] docs/03-数据库设计文档.md 已生成 - - [ ] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填 - -- [ ] A4 DB 初始化 — db-init - - [ ] sql/migrations/V1__initial_schema.sql 已生成 - - [ ] DDL 与 docs/03 全量一致 - - [ ] .env.local 凭据已验证（mysql -e "SELECT 1" OK） - - [ ] setup-test-db.sh 防护通过 + DROP+CREATE + apply V1 已执行 - - [ ] SHOW TABLES 行数 == docs/03 表数量 - -- [ ] A5 下游文档生成 — downstream-gen - - [ ] docs/02 开发计划已生成 - - [ ] docs/05 API 契约已生成 - - [ ] docs/06 § 三 页面清单已填入 - - [ ] docs/10 验收清单已生成 - - [ ] 下方模块列表已填入 - - [ ] REQ 卡片依赖接口已回填 - -## 二、Coding 阶段（后端模块循环） - -（A5 填入后，每行一个后端模块。每个模块的 `里程碑:` 字段在 `—` 和 `milestone/` 之间变化，完成由本地 `git tag -l` 判定。`coding-start` 每次按 docs/02 REQ 序扫每模块的里程碑 tag 决定派发。后端模块全部打里程碑后自动进入 § 三 前端阶段。） - - - -## 三、Coding 阶段（前端整体） - -（`frontend-start` 进入时扫 prototype/ + docs/01 + docs/05 → AI 自主推导 FE 业务功能清单写到下方"功能:"项（无人工审阅断点；合理性由整体里程碑标记时统一校核）。已有清单则直接加载。整个前端阶段 1 个里程碑 tag，分支 `frontend-phase`。） - -- 整体里程碑: — -- 功能: - diff --git a/skills/plan/scope-lock/SKILL.md b/skills/plan/scope-lock/SKILL.md deleted file mode 100644 index 2e39871..0000000 --- a/skills/plan/scope-lock/SKILL.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -name: scope-lock -description: A1 计划范围锁定——引导用户填写项目概述 + 技术栈 + 需求索引，并按模块子目录生成 REQ 卡片骨架（CC 推断 req_id/title/goal/rules/constraints/acceptance；输入/输出 各含一句简述 + N 张示例字段表全部原样复制由人工编辑；依赖表/依赖接口模板写死 `TBD(A3/A5 自动补)` 由后续 skill 回填）。 -user-invocable: false -allowed-tools: Read Edit Grep Skill AskUserQuestion Bash(mkdir *) Bash(cp *) Bash(sed *) Bash(bash *) Bash(cat *) ---- - -**所有输出必须使用中文。** - -# scope-lock - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/scope-lock/banners/flow.txt" -``` - -### A. 提示用户填写项目概述并等待 - -向用户输出： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [scope-lock] 请填写项目概述 - - 📄 文件位置: ./CLAUDE.md - 📌 编辑位置: § 🎯 项目概述 - - 请将以下占位符替换为实际值： - - 项目名称 - - 项目简述 - - 目标用户 - - 部署方式 - 改完后回来选择「继续」。 -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -用 `AskUserQuestion` 询问： -- **question**: `项目概述填写完毕了吗？` - - 用户选择「继续」→ 用 `Grep` 在 `CLAUDE.md` 搜索 `【人工填写：`（限定 § 🎯 项目概述 节）。命中 → 打印残留行 + 路径，重新弹出同样的 AskUserQuestion；0 命中 → 勾选并进入步骤 B。 - - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 - -0 命中后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 项目概述已填写（CLAUDE.md § 🎯 项目概述）` - -### B. 提示用户检查默认技术栈并等待 - -`docs/04-技术规范.md` 已由 A0 `project-init` 用模板复制（默认技术栈，见 `project-init/templates/docs-04-stack-template.md`）。本步骤让用户检查 / 调整 § 零。 - -向用户输出： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [scope-lock] 技术栈已保存 - - 📄 文件位置: ./docs/04-技术规范.md（由 A0 模板生成） - 📌 编辑位置: § 零、技术栈总览 - - 请检查技术栈表： - - 不需要的行直接删除（如纯后端项目删前端行） - - 需要替换的技术直接改 - - 需要新增的条目直接加行 - 改完后回来选择「继续」。 -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -用 `AskUserQuestion` 询问： -- **question**: `技术栈检查完毕了吗？` - - 用户选择「继续」→ 进入步骤 C。 - - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 技术栈已确认（docs/04 § 零）` - -### C. 提示用户填写需求清单并等待 - -`docs/01-需求清单/index.md` 已由 `project-init` 写入占位符模板，这里让用户补齐模块清单。 - -向用户输出： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [scope-lock] 请填写需求清单模块索引 - - 📄 文件位置: ./docs/01-需求清单/index.md - 📌 编辑位置: § 模块索引（表格） - - 请按业务列出所有模块： - - 每行一个模块（如 SYS 系统管理 / PUR 采购 / SAL 销售） - - 「核心功能点」只需关键词，CC 会拆分为 REQ 卡片 - 改完后回来选择「继续」。 -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -用 `AskUserQuestion` 询问： -- **question**: `需求清单模块索引填写完毕了吗？` - - 用户选择「继续」→ 进入步骤 D。 - - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 需求清单索引已填写（docs/01-需求清单/index.md）` - -### D. 生成 REQ 卡片骨架并停下等人工审阅 - -1. 用 `Grep` 校验 `docs/01-需求清单/index.md` 无 `【人工填写：` 残留；有则回步骤 C。 -2. 用 `Read` 读 `index.md` 解析模块索引。 -3. **单次 Bash 写入所有文件**（替代 N×9 次 Edit）： - - - **每模块推断**：三元组 `{module_code, module_name, module_brief}` + N 个 REQ 的六元组 `{req_id, title, goal, rules, constraints, acceptance}`。`req_id`/`title` 从核心功能点拆分；`goal` 展开 `title`；`rules`/`constraints`/`acceptance` 起草业务语义。**不推断**输入 / 输出（模板原样保留示例）。 - - **单次 Bash**：调 `${CLAUDE_SKILL_DIR}/scripts/render.sh` 落盘所有文件（脚本内部完成模板读取 + 占位符替换 + HTML 注释剥离）。下面是**调用形态**示例，`` / `<模块名>` / `` 等尖括号位置 CC 按 `index.md` 实际值替换： - - ```bash - R="${CLAUDE_SKILL_DIR}/scripts/render.sh" - # 每个模块：mkdir + 1 个 render module + N 个 render req（每 REQ 一行） - mkdir -p "docs/01-需求清单/-<模块名>" - bash "$R" module "docs/01-需求清单/-<模块名>/_module.md" "" "<模块名>" "" - bash "$R" req "docs/01-需求清单/-<模块名>/.md" "" "" "<goal>" "<rules>" "<constraints>" "<acceptance>" - ``` - - - **兜底**：值含字面 `$xxx` 或 `}}` 的 REQ 单独走 cp + Edit。 -4. 用 `Edit` 在 `docs/08-模块任务管理.md` 勾选（A1 子项 + A1 顶层）： - - ` - [ ] REQ 卡片骨架已生成（docs/01-需求清单/<module>/REQ-*.md，业务内容留待人工填写）` - - `- [ ] A1 范围锁定 — scope-lock` -5. 打印停下横幅并**停止**： - -``` -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - [scope-lock] ✅ A1 范围锁定完成 - - 产出： - ✓ CLAUDE.md § 🎯 项目概述 - ✓ docs/04 § 零 技术栈 - ✓ docs/01-需求清单/index.md 模块索引 - ✓ docs/01-需求清单/<module>/_module.md 模块头 - ✓ docs/01-需求清单/<module>/REQ-*.md REQ 卡片骨架 - - ⏸ 现在请你逐张打开 REQ 卡片： - - **必改**：输入 / 输出 两段 - · `表1` / `表2` 是模板示例，按本 REQ 业务**改字段 / 增删行 / 增删整张表** - - **审阅**：目标 / 跨字段规则 / 边界 / 验收（已起草，对照业务校正） - - **保留**：`TBD` 不要改，由之后流程自动回填 - - 审阅完成后，运行以下命令继续进入 A2： - /erp-workflow:plan-start - -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -``` - -## 参考 - -- `CLAUDE.md` § 🎯 项目概述（写入目标） -- `docs/04-技术规范.md`（技术栈输出，供 skeleton-gen 读取使用） -- `docs/01-需求清单/index.md`（模块索引输入） -- `docs/01-需求清单/<module>/_module.md`（模块头输出） -- `docs/01-需求清单/<module>/REQ-*.md`（REQ 卡片骨架输出，A3 db-design-gen / A5 downstream-gen 会回填 TBD 字段） -- `${CLAUDE_SKILL_DIR}/templates/req-card-template.md` -- `${CLAUDE_SKILL_DIR}/templates/_module-template.md` -- `${CLAUDE_SKILL_DIR}/scripts/render.sh`（步骤 D 渲染助手，dispatch `module` / `req` 两种模式） diff --git a/skills/plan/scope-lock/banners/flow.txt b/skills/plan/scope-lock/banners/flow.txt deleted file mode 100644 index e012667..0000000 --- a/skills/plan/scope-lock/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ ▶ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/scope-lock/scripts/render.sh b/skills/plan/scope-lock/scripts/render.sh deleted file mode 100644 index 8a83488..0000000 --- a/skills/plan/scope-lock/scripts/render.sh +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/env bash -# render.sh — scope-lock 步骤 D 渲染单个 _module.md 或 REQ-*.md -# -# 用法： -# bash render.sh module <out_path> <module_code> <module_name> <module_brief> -# bash render.sh req <out_path> <req_id> <title> <goal> <rules> <constraints> <acceptance> -# -# 模板路径自定位：脚本同级父目录下 templates/{_module-template.md, req-card-template.md} - -set -euo pipefail - -TYPE=${1:?missing type (module|req)} -shift - -SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) -TPL_DIR="$SCRIPT_DIR/../templates" - -case "$TYPE" in - module) - out=${1:?missing out_path}; code=${2:?}; name=${3:?}; brief=${4:?} - c=$(cat "$TPL_DIR/_module-template.md") - c="${c//\{\{module_code\}\}/$code}" - c="${c//\{\{module_name\}\}/$name}" - c="${c//\{\{module_brief\}\}/$brief}" - ;; - req) - out=${1:?missing out_path}; req_id=${2:?}; title=${3:?}; goal=${4:?}; rules=${5:?}; constraints=${6:?}; acceptance=${7:?} - c=$(sed '/^<!--$/,/^-->$/d' "$TPL_DIR/req-card-template.md") - c="${c//\{\{req_id\}\}/$req_id}" - c="${c//\{\{title\}\}/$title}" - c="${c//\{\{goal\}\}/$goal}" - c="${c//\{\{rules\}\}/$rules}" - c="${c//\{\{constraints\}\}/$constraints}" - c="${c//\{\{acceptance\}\}/$acceptance}" - ;; - *) - echo "render.sh: unknown type '$TYPE' (expect module|req)" >&2 - exit 1 - ;; -esac - -printf '%s\n' "$c" > "$out" diff --git a/skills/plan/scope-lock/templates/_module-template.md b/skills/plan/scope-lock/templates/_module-template.md deleted file mode 100644 index 5425b83..0000000 --- a/skills/plan/scope-lock/templates/_module-template.md +++ /dev/null @@ -1,5 +0,0 @@ -# {{module_code}}-{{module_name}} - -- **模块简述**: {{module_brief}} -- **依赖模块**: TBD(A5 自动补) -- **涉及表**: TBD(A3 自动补) diff --git a/skills/plan/scope-lock/templates/req-card-template.md b/skills/plan/scope-lock/templates/req-card-template.md deleted file mode 100644 index bb5a169..0000000 --- a/skills/plan/scope-lock/templates/req-card-template.md +++ /dev/null @@ -1,63 +0,0 @@ -<!-- -req-card-template：单张 REQ 卡片骨架。每张卡片是 docs/01-需求清单/<module>/REQ-XXX-NNN.md 一个独立文件。 -渲染约定： -1) scope-lock 渲染时**只替换 6 个占位符**：{{req_id}} / {{title}} / {{goal}} / {{rules}} / {{constraints}} / {{acceptance}} - 这 6 项由 CC 根据 docs/01-需求清单/index.md 的「核心功能点」推断起草： - - req_id / title：从核心功能点拆分命名得来 - - goal：用一句话展开 title - - rules / constraints / acceptance：业务语义层面的合理起草，待人工审阅修订 -2) `**输入**` / `**输出**` 二级结构：每段先一句话总结（如「用户提交...」/「返回用户 id」），再跟「表1 / 表2 / ...」N 张平铺的字段表。CC 渲染时对**两段简述 + 所有表（含示例数据）全部原样复制**，不要根据 REQ 业务篡改示例字段、也不要换列结构： - - `输入` 的表：8 列（字段 / 类型 / 必填 / 输入方式 / 显示来源 / 预加载 / 默认值 / 业务规则），其中 `预加载` 取值为 `页面加载时` / `用户操作时` / `—`；模板内含示例数据（表1 6 行、表2 3 行） - - `输出` 的表：3 列（字段 / 类型 / 显示来源），模板内含示例数据（表1 / 表2 各 3 行） - - 表的数量是可变的：人工拿到卡片后按 REQ 实际情况增删表（删多余的 `表N` 整段 / 复制为 `表3 / 表4 / ...`）和编辑字段 -3) `**依赖表**: TBD(A3 自动补)` 和 `**依赖接口**: TBD(A5 自动补)` 是后续 skill 自动回填的占位，渲染时**保持原样**，不要替换为 `-` 也不要替换为 `{{...}}` -4) 渲染后这段 HTML 注释要**剥掉**，不进入最终卡片 ---> -### {{req_id}} {{title}} - -**目标**: {{goal}} - -- **输入**: 用户提交用户名（3-20 位字母数字下划线，系统内唯一）、姓名（2-50字符）、手机号（11 位数字，系统内唯一）、邮箱（标准邮箱格式，可选）、初始密码（8-20位含大小写字母和数字） - - - **表1**： - - | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 预加载 | 默认值 | 业务规则 | - | ---- | ---- | --- | ---- | ----- | --- | --- | ------------------- | - | 用户名 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 3-20 位字母数字下划线；系统内唯一 | - | 姓名 | 文本 | 是 | 下拉单选 | `职员表` | 用户操作时 | — | 2-50 个字符 | - | 手机号 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 11 位数字；系统内唯一 | - | 邮箱 | 文本 | 否 | 手工输入 | `职员表` | 否 | — | 标准邮箱格式 | - | 角色 | 文本 | 是 | 下拉单选 | 普通用户/超级管理员 | 页面加载时 | 普通用户 | 至少选择 1 个 | - | 初始密码 | 文本 | 是 | 手工输入 | — | — | — | 8-20 位；含大小写字母和数字；显示星号 | - - - **表2**： - - | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 预加载 | 默认值 | 业务规则 | - | --- | --- | --- | --- | --- | --- | --- | --- | - | 用户名 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 3-20 位字母数字下划线；系统内唯一 | - | 姓名 | 文本 | 是 | 下拉单选 | `职员表` | 用户操作时 | — | 2-50 个字符 | - | 手机号 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 11 位数字；系统内唯一 | - -- **输出**: 返回用户 id - - - **表1**： - - | 字段 | 类型 | 显示来源 | - | --- | --- | --- | - | 用户名 | 文本 | `职员表` | - | 姓名 | 文本 | `职员表` | - | 角色 | 文本 | `职员表` | - - - **表2**： - - | 字段 | 类型 | 显示来源 | - | --- | --- | --- | - | 用户名 | 文本 | `职员表` | - | 姓名 | 文本 | `职员表` | - | 角色 | 文本 | `职员表` | - -- **跨字段规则**: {{rules}} -- **边界**: {{constraints}} -- **验收**: {{acceptance}} -- **依赖表**: TBD(A3 自动补) -- **依赖接口**: TBD(A5 自动补) diff --git a/skills/plan/skeleton-gen/SKILL.md b/skills/plan/skeleton-gen/SKILL.md deleted file mode 100644 index 4930347..0000000 --- a/skills/plan/skeleton-gen/SKILL.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -name: skeleton-gen -description: A2 骨架生成——基于 docs/04 § 零 技术栈 + docs/01-需求清单/index.md 模块索引，生成项目专属的架构文档（docs/04 § 一+、docs/06、docs/07、docs/09）和工具脚本。固定工具文件走 cp，架构文档由 LLM 按大纲生成。 -user-invocable: false -allowed-tools: Read Write Edit Skill Grep Glob AskUserQuestion Bash(mkdir *) Bash(cp *) Bash(touch *) Bash(chmod *) Bash(cat *) Bash(bash *) ---- - -**所有输出必须使用中文。** - -# skeleton-gen - -## 执行步骤 - -### 步骤 0：打印当前位置流程图 - -用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： - -```bash -cat "${CLAUDE_PLUGIN_ROOT}/skills/plan/skeleton-gen/banners/flow.txt" -``` - -### A. 读取锁定的输入 - -用 `Read` 读取： -- `docs/04-技术规范.md` § 零 技术栈表 -- `docs/01-需求清单/index.md` 需求索引 -- `docs/01-需求清单/` 需求卡片 - -后续所有内容都基于它们推导。 - -### B.1 生成 3 个全新架构文档（docs/06 / 07 / 09） - -对下表每个目标文件： -1. 读取对应的大纲模板 -2. 基于步骤 A 的输入，按大纲生成项目专属内容 -3. 剥掉 HTML 注释（注释是给 LLM 的提示，不应出现在最终文档里） -4. 写入目标路径 - -| 目标文件 | 大纲模板 | -|---|---| -| `docs/06-UI交互规范.md`（§ 一 ~ 四，§ 五 占位） | `${CLAUDE_SKILL_DIR}/templates/docs-06-static-template.md` | -| `docs/07-环境配置.md` | `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md` | -| `docs/09-项目目录结构.md` | `${CLAUDE_SKILL_DIR}/templates/docs-09-structure-template.md` | - -项目专属标识（根包名 / 命名空间）保留 `【人工填写：<说明>】` 占位，等人工在 docs/09 顶部补填一次后，其他文件复用。 - -### B.2 追加 docs/04 § 一+（保留 § 零 不覆盖） - -docs/04 已由 scope-lock 写入 § 零。本步骤追加 § 一 ~ 三。 - -1. 读取 `docs/04-技术规范.md`（现有 § 零 完整内容）。 -2. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md`。 -3. 基于技术栈，按大纲生成 § 一 ~ 三 的项目专属内容，剥掉 HTML 注释。 -4. 拼接原有内容和新生成内容，写回 `docs/04-技术规范.md`。 - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 架构文档已生成（docs/04 § 一+、docs/06、docs/07、docs/09）` - -### C. 生成工具脚本 - -#### C.1 复制 - -```bash -mkdir -p scripts sql/migrations src/styles -touch sql/migrations/.gitkeep -cp "${CLAUDE_SKILL_DIR}/templates/env-local-template" .env.local -cp "${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.sh" scripts/setup-test-db.sh -cp "${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css" src/styles/tokens.css -``` - -#### C.2 渲染 scripts/test.sh - -读取 `${CLAUDE_SKILL_DIR}/templates/scripts-test-template.sh`，基于步骤 A 的技术栈（docs/04 § 零）为 7 个占位推断命令后写到 `scripts/test.sh`： - -- `{{backend_build}}` / `{{backend_lint}}` / `{{backend_test}}` 后端各 stage 命令 -- `{{frontend_build}}` / `{{frontend_lint}}` / `{{frontend_test}}` 前端各 stage 命令 -- `{{e2e_cmd}}` E2E（无 E2E 工具则填 `echo "[test.sh] e2e 略"`） - -> 推断规则：根据 `docs/04 § 零` 。 -> - 「后端*」存在 → 据后端技术栈推 backend 三槽（build / lint / test 命令） -> - 「前端*」存在 → 据前端技术栈推 frontend 三槽 -> - 缺席 stack → 三槽全填 `:`（运行期 `[ -d X ]` 守卫对接；语法合法即可） -> - `{{e2e_cmd}}` 通常仅前端，按上述前端规则或填 `echo "[test.sh] e2e 略"` -> -> 表结构异常（列名变更 / 无中文前缀）时停下，用 `AskUserQuestion` 让用户显式确认每 stack 命令。 - -#### C.3 赋权 - -```bash -chmod +x scripts/*.sh -``` - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 工具脚本已生成（scripts/*.sh、.env.local）` -- ` - [ ] 样式 token 骨架已生成（src/styles/tokens.css）` - -### D. 追加 .gitignore 忽略项 - -调用脚本完成合并： - -```bash -bash "${CLAUDE_SKILL_DIR}/scripts/merge-gitignore.sh" "${CLAUDE_SKILL_DIR}/templates/gitignore-append-template" -``` - -完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] .gitignore 已配置` - -### E. 占位符补填 + QA 闸门 - -#### E.1 扫描 + 分组 - -用 `Grep` 在以下 8 个路径扫 `【人工填写：`，记录命中（文件 / 行号 / 说明）： -- `docs/04-技术规范.md` / `docs/06-UI交互规范.md` / `docs/07-环境配置.md` / `docs/09-项目目录结构.md` -- `scripts/*.sh` / `.gitignore` -- `.env.local` - -分两组： -- **敏感组**：`.env.local` 路径命中（凭据 / 密钥）。**不弹 QA**（凭据不进会话），E.3 提示用户自填。 -- **非敏感组**：其余文件。按说明文字聚合为「根占位」（相同说明 = 同一值，多处共用）或「派生占位」（说明表达派生关系，如"后端 java 根包路径"派生自"根包名"）。 - -无命中 → 跳 E.4。 - -#### E.2 问根占位 + 推派生 + 批量 Edit - -- 每个根占位用 `AskUserQuestion` 问（给合理默认值 + 自由输入），用 `Edit` 批量替换所有命中位置 -- 派生占位**不问**，CC 基于根占位值推断后 `Edit`；不能可靠推断则回退当独立根占位问 - -#### E.3 敏感占位提示（不弹 QA） - -若敏感组非空：打印提示横幅，列出 `.env.local` 待填字段名 + 告诉用户"直接编辑文件，凭据不进会话"。 - -#### E.4 验证 + QA 闸门 - -循环直到两条件**同时**满足： -(a) `Grep` 重新扫 8 路径，0 命中 -(b) 用户 `AskUserQuestion` 选「继续」 - -每次弹 QA 前重扫；有残留则打印残留位置清单（文件:行号 — 说明）+ 再弹 QA。 - -QA 横幅涵盖：产出文件清单（docs/04 / 06 / 07 / 09 + scripts/*.sh + .env.local + .gitignore）、占位状态（N=0 或待填清单）、「继续」/「有疑问先沟通」两选项。 - -通过后（N=0 且用户选「继续」），用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- `- [ ] A2 骨架生成 — skeleton-gen` - -### F. 进入 A3 - -输出 `skeleton-gen: 完成`，立即调用 `Skill(db-design-gen)`。 - -## 参考 - -- `docs/04-技术规范.md` § 零（技术栈输入） -- `docs/01-需求清单/index.md`（模块索引输入） -- `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md`（大纲） -- `${CLAUDE_SKILL_DIR}/templates/docs-06-static-template.md`（大纲） -- `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md`（大纲） -- `${CLAUDE_SKILL_DIR}/templates/docs-09-structure-template.md`（大纲） -- `${CLAUDE_SKILL_DIR}/templates/scripts-test-template.sh`（推断命令填充 7 槽：backend/frontend × build/lint/test + e2e；缺席 stack 填 `:`） -- `${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.sh`（0 槽位） -- `${CLAUDE_SKILL_DIR}/templates/env-local-template`（0 槽位） -- `${CLAUDE_SKILL_DIR}/templates/gitignore-append-template`（0 槽位） -- `${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css`（0 槽位，样式 token 骨架） -- `${CLAUDE_SKILL_DIR}/scripts/merge-gitignore.sh`（.gitignore 逐行判重合并脚本） diff --git a/skills/plan/skeleton-gen/banners/flow.txt b/skills/plan/skeleton-gen/banners/flow.txt deleted file mode 100644 index 798f4a9..0000000 --- a/skills/plan/skeleton-gen/banners/flow.txt +++ /dev/null @@ -1,17 +0,0 @@ -┌────────────────────────────────────────────────────────┐ -│ 📋 阶段 A：规划（一次性） │ -│ │ -│ A0 初始化项目 │ -│ ↓ │ -│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ -│ ↓ │ -│ ▶ A2 生成骨架 │ -│ ↓ │ -│ A3 生成 DB 设计 → 人工审核 │ -│ ↓ │ -│ A4 初始化 DB │ -│ ↓ │ -│ A5 生成下游文档 │ -│ │ -│ 规划阶段到此结束 │ -└────────────────────────────────────────────────────────┘ diff --git a/skills/plan/skeleton-gen/scripts/merge-gitignore.sh b/skills/plan/skeleton-gen/scripts/merge-gitignore.sh deleted file mode 100755 index cfff18c..0000000 --- a/skills/plan/skeleton-gen/scripts/merge-gitignore.sh +++ /dev/null @@ -1,39 +0,0 @@ -#!/usr/bin/env bash -# merge-gitignore.sh -# 把模板里的忽略规则合并到项目根的 .gitignore： -# - 若 .gitignore 不存在 → 直接 cp 模板（含注释头和结构） -# - 若已存在 → 逐行判重，只追加模板里缺失的规则行（跳过注释/空行） -# -# 用法：merge-gitignore.sh <template_path> [<target_gitignore_path>] -# template_path 模板文件绝对路径（由 skeleton-gen skill 传入） -# target_gitignore_path 目标 .gitignore 路径，默认为当前工作目录下的 .gitignore -# -# 判重：grep -xF 整行精确匹配 + 字面字符串（非正则），避免 .env 误匹配 .env.local， -# 也避免 *.class / *.iml 等通配符被当作 regex。 - -set -euo pipefail - -template="${1:?usage: merge-gitignore.sh <template_path> [<target_gitignore_path>]}" -target="${2:-.gitignore}" - -if [ ! -f "$template" ]; then - echo "[merge-gitignore] ERROR: template not found: $template" >&2 - exit 1 -fi - -if [ ! -f "$target" ]; then - cp "$template" "$target" - echo "[merge-gitignore] created $target from template" - exit 0 -fi - -added=0 -while IFS= read -r line; do - case "$line" in ""|"#"*) continue ;; esac - if ! grep -qxF "$line" "$target"; then - echo "$line" >> "$target" - added=$((added + 1)) - fi -done < "$template" - -echo "[merge-gitignore] $target updated (+$added rules)" diff --git a/skills/plan/skeleton-gen/templates/docs-04-skeleton-template.md b/skills/plan/skeleton-gen/templates/docs-04-skeleton-template.md deleted file mode 100644 index 7f2c116..0000000 --- a/skills/plan/skeleton-gen/templates/docs-04-skeleton-template.md +++ /dev/null @@ -1,69 +0,0 @@ -<!-- -本文件是 docs/04-技术规范.md 的 § 一+ 大纲。 -skeleton-gen 读取 docs/04 § 零（技术栈表）和 docs/01-需求清单/index.md（模块索引）， -按下述大纲生成本项目专属的规范内容。LLM 不要原样拷贝提示文字，只保留 section 标题。 ---> - -## 一、后端规范 - -### 1.1 规则 -<!-- 后端通用约定：保留下方占位符不要代填，由人工在 skeleton-gen § E 填写；每条一个 bullet，按需复制本行新增更多。 --> -- 【人工填写：一条后端通用约定，按需复制本行新增更多；无则填「无」】 - -### 1.2 分层结构 -<!-- 按 § 零 的后端框架定层次：controller/service/mapper 等；每层职责一句话。 --> - -### 1.3 命名约定 -<!-- 包名（根包用【人工填写：根包名】占位）/ 类名 / 方法名 / 常量的大小写规则，含 2 个示例。 --> - -### 1.4 统一响应格式 -<!-- 成功/失败的 JSON 结构，错误码段位划分。 --> - -### 1.5 异常处理 -<!-- 全局异常处理器的使用方式；哪些异常要 catch，哪些禁止；**接口响应禁止回显后端异常堆栈**（返用户友好错误码 + 文案）。 --> - -### 1.6 事务 -<!-- 事务边界（通常 service 层）；跨服务调用的禁止/替代方案。 --> - -### 1.7 认证 -<!-- 基于 § 零 认证方案推导：token 生命周期、刷新机制、密钥管理。 --> - -## 二、前端规范 - -### 2.1 目录约定 -<!-- 基于 § 零 前端框架推导：api/components/pages/store/hooks/utils 的职责；**前端禁止直接写 SQL / 操作 DB**，所有数据访问走 api/ 层统一封装。 --> - -### 2.2 状态管理 -<!-- 基于 § 零 状态管理技术推导：全局 vs 局部、服务端数据的存放。 --> - -### 2.3 请求封装 -<!-- HTTP 客户端的拦截器、超时、错误重试、鉴权注入。 --> - -### 2.4 错误处理 -<!-- 网络错误 / 业务错误 / 页面级错误的分层处理。 --> - -### 2.5 样式与主题 -<!-- 基于 § 零 UI 库给出 CSS 变量约定： - - 命名格式 `--color-<scope>-<role>-<state>`（scope=form/table-row/...，role=bg/fg/border，state=edit/readonly/hover/selected） - - 文件位置 `src/styles/tokens.css`，由 skeleton-gen 生成空骨架，色值由 docs/06 § 四锁定后填入 - - 组件样式中只用 var(--color-xxx)，禁止硬编码 hex/rgba - - 与 UI 库主题对接（如 Ant Design ConfigProvider.theme.token）的映射方式 - 具体 token 表见 docs/06 § 四。 --> - -## 三、共同约定 - -### 3.1 Git 提交 -`<type>(<scope>): <subject> REQ-XXX-NNN` - -### 3.2 分页查询 -<!-- 后端分页对象 + 前端分页组件，入参出参约定。 --> - -### 3.3 日期与金额 -<!-- 后端类型（如 LocalDateTime / BigDecimal）+ 前端展示工具；金额精度约定。 --> - -### 3.4 数据访问规约 -<!-- 基于 § 零 数据访问技术（MyBatis-Plus / JPA 等）：SELECT 字段显式列举，**禁止 `SELECT *`**；循环中不得执行 DB 查询（**N+1 反模式**），改用批量查 / IN 子句 / JOIN；Mapper XML 里字段与表名用常量或引用，避免拼字符串。 --> - -### 3.5 配置与安全 -<!-- 配置：DB 连接 / 端口 / 密钥 / 第三方 URL 等一律放 `application.yml` + `.env.local`，代码里**禁止硬编码**。 - 前端安全：`localStorage` 不存敏感信息（token / 身份 / 个人数据），推荐 HttpOnly Cookie 或 内存 + 刷新 token 模式；接口响应禁止回显后端异常堆栈（与 § 1.5 一致）。 --> diff --git a/skills/plan/skeleton-gen/templates/docs-06-static-template.md b/skills/plan/skeleton-gen/templates/docs-06-static-template.md deleted file mode 100644 index 467bf32..0000000 --- a/skills/plan/skeleton-gen/templates/docs-06-static-template.md +++ /dev/null @@ -1,42 +0,0 @@ -<!-- -本文件是 docs/06-UI交互规范.md 的 § 一~二 大纲（§ 三由 downstream-gen 追加）。 -skeleton-gen 读取 docs/04 § 零 和 docs/01 index，按下述大纲生成项目专属内容。 -布局/页面骨架以项目根的 prototype/ 静态 HTML mockup 为权威，本文件仅承载跨页面通用规则与 Design Tokens。 ---> - -# 06-UI交互规范 - -> 本项目所有页面布局以项目根 `prototype/` 目录下的静态 HTML mockup 为权威。前端阶段（fe-feature-*）实现时直接以 prototype/ HTML 推导组件树与样式。本文件仅承载跨页面通用规则与 Design Tokens。 - -## 一、通用交互规则 - -### 1.1 操作反馈 -<!-- 成功/失败消息；危险操作二次确认；长耗时按钮 loading 态。 --> - -### 1.2 数据展示 -<!-- 空状态 / 加载 / 异常 的统一组件与文案。 --> - -### 1.3 权限控制（前端） -<!-- 菜单级 / 按钮级 / 路由级的控制方式，关联后端 RBAC。 --> - -## 二、Design Tokens - -<!-- 所有色值统一以 CSS 变量定义于 src/styles/tokens.css；命名规范见 docs/04 § 2.5。 --> - -### 2.1 全局调色板 -<!-- 与 § 零 UI 库主题对齐：列名 = 语义 / 变量名 / 默认值 / 用途。 - 至少含：主色/成功/警告/错误/主文字/次文字/边框/背景。 --> - -### 2.2 组件级状态色 -<!-- 场景 × 状态映射表：列名 = 序号 / 组件 / 编辑bg / 只读bg / 悬浮bg / 编辑fg / 只读fg / 悬浮fg / 备注。 - 单元格写 token 名（var(--color-xxx) 形式），不写 hex；"—" 表示该状态不适用。 - 表后追加「Token 默认值」表，列出每个 --color-xxx 在 tokens.css 的默认值。 --> - -### 2.3 引用约定 -<!-- 一句话三条： - - 组件样式只用 var(--color-xxx)，禁止硬编码 - - 新增 token 须先登记到 § 2.1/2.2 再补 tokens.css - - 修改色值只改 tokens.css 一处，不允许组件覆盖 --> - -## 三、页面清单 -（由 `downstream-gen` 按模块追加段落） diff --git a/skills/plan/skeleton-gen/templates/docs-07-env-template.md b/skills/plan/skeleton-gen/templates/docs-07-env-template.md deleted file mode 100644 index 3a3306f..0000000 --- a/skills/plan/skeleton-gen/templates/docs-07-env-template.md +++ /dev/null @@ -1,26 +0,0 @@ -<!-- -本文件是 docs/07-环境配置.md 的大纲。 -skeleton-gen 基于 docs/04 § 零 技术栈表推导各节内容： - § 一 依赖清单 → 从技术栈的每一行技术推导运行时和构建依赖 - § 二 端口约定 → 从后端/前端/数据库/缓存/反向代理 各取默认端口 - § 四 常用命令 → 基于构建工具、包管理器给出开发者最常用命令 ---> - -# 07-环境配置 - -## 一、依赖清单 - -<!-- 表格：| 层 | 依赖 | 版本 | 说明 |；覆盖 运行时 / 构建 / 容器 / CLI 工具。 --> - -## 二、端口约定 - -<!-- 表格：| 服务 | 端口 | 说明 |；至少列 后端 HTTP / 前端 dev / 数据库 / 缓存 / 反代。 --> - -## 三、环境变量 - -运行时凭据（数据库连接、JWT 密钥等）全部放在仓库根的 `.env.local`，不入 git。 -字段清单与占位符见该文件，真实值由开发者本地填写。 - -## 四、常用命令 - -<!-- 表格：| 命令 | 说明 |；包含 启动后端 / 启动前端 / 打包 / 运行测试 / 重置测试数据。 --> diff --git a/skills/plan/skeleton-gen/templates/docs-09-structure-template.md b/skills/plan/skeleton-gen/templates/docs-09-structure-template.md deleted file mode 100644 index d913c08..0000000 --- a/skills/plan/skeleton-gen/templates/docs-09-structure-template.md +++ /dev/null @@ -1,45 +0,0 @@ -<!-- -本文件是 docs/09-项目目录结构.md 的大纲。 -skeleton-gen 基于 docs/04 § 零 技术栈推导目录树： - § 二 后端目录 → 按后端框架的惯例（如 Spring Boot 的 src/main/java） - § 三 前端目录 → 按前端框架的惯例（如 Vite + React 的 src/） - § 四 docs 目录 → 沿用插件标准 - § 五 命名约定 → 按后端语言的包/命名空间习惯 - -模块划分参考 docs/01-需求清单/index.md 的模块索引，将业务模块落到代码目录。 ---> - -# 09-项目目录结构 - -## 一、仓库顶层 - -<!-- 用代码块画出顶层目录树，含 CLAUDE.md / README.md / .env.local / scripts / docs / sql / backend / frontend 等。 --> - -## 二、后端目录 - -<!-- 基于后端框架的目录树；按 docs/01 index 的模块代码把业务模块列出（module/user/、module/order/ 等）。 --> - -## 三、前端目录 - -<!-- 基于前端框架的目录树；pages/ 下按业务模块建子目录。 --> - -## 四、docs/ 结构 - -``` -docs/ -├── 01-需求清单/ # 每模块一子目录（_module.md 模块头 + REQ-*.md 卡片） -├── 02-开发计划.md -├── 03-数据库设计文档.md -├── 04-技术规范.md -├── 05-API接口契约.md -├── 06-UI交互规范.md -├── 07-环境配置.md -├── 08-模块任务管理.md -├── 09-项目目录结构.md -├── 10-验收检查清单.md -└── superpowers/ # CC 运行时产物 -``` - -## 五、命名与放置约定 - -<!-- 根包 / 命名空间用【人工填写：】占位；Controller / Service / Mapper / DTO / VO / 前端组件 / 前端页面 的放置规则。 --> diff --git a/skills/plan/skeleton-gen/templates/env-local-template b/skills/plan/skeleton-gen/templates/env-local-template deleted file mode 100644 index c16e67f..0000000 --- a/skills/plan/skeleton-gen/templates/env-local-template +++ /dev/null @@ -1,25 +0,0 @@ -# .env.local — 本地开发凭据（入 .gitignore，不提交） -# -# 规则： -# 1. 值含 `$`、反引号、空格、`!` 等 shell 特殊字符时，必须用单引号包裹： -# DB_PASSWORD='p@ss$w0rd!' -# 否则 `set -a; . .env.local; set +a` 会做变量展开导致密码错乱。 -# 2. DB_HOST 建议保持 localhost / 127.0.0.1；非本地 host 默认会被 scripts/setup-test-db.sh 防护拒绝。 -# 若必须用远程测试库，把 host 列入下方 TEST_DB_ALLOWED_HOSTS。 -# 3. DB_SCHEMA 建议命名含 test / _dev / _local / _ci，避免与生产库同名。 - -DB_HOST=【人工填写：MySQL host，推荐 localhost】 -DB_PORT=【人工填写：MySQL port，默认 3306】 -DB_USER=【人工填写：开发账号名】 -DB_PASSWORD=【人工填写：对应密码，含特殊字符时用单引号包裹】 -DB_SCHEMA=【人工填写：schema 名，推荐含 test/_dev/_local，例如 erp_dev】 -JWT_SECRET=【人工填写：JWT 签名密钥，256+ bit 随机串】 - -# 可选：额外允许 DROP CREATE 的远程 host（空格或逗号分隔）。仅当 DB_HOST 指向公司测试 MySQL 等 -# 非本地服务器时填写；留空表示只允许 localhost / 127.0.0.1 / ::1。 -# 示例：TEST_DB_ALLOWED_HOSTS="118.178.19.35 test-mysql.internal" -# -# ⚠️ 列入后该 host 每次 test.sh 都会被 DROP CREATE（无二次确认）。 -# 仅用于你完全可控的测试库；生产/共享库/多人共享的 staging 库**千万别列**。 -# （防护 2 还会检查 schema 名须含 test/_dev/_local/_ci，独立兜底。） -TEST_DB_ALLOWED_HOSTS= diff --git a/skills/plan/skeleton-gen/templates/gitignore-append-template b/skills/plan/skeleton-gen/templates/gitignore-append-template deleted file mode 100644 index ac39aa6..0000000 --- a/skills/plan/skeleton-gen/templates/gitignore-append-template +++ /dev/null @@ -1,32 +0,0 @@ -# ==== ERP 插件推荐忽略项（skeleton-gen 追加） ==== -# 本地运行时配置（含真实凭据，严禁入库） -.env.local -.env.*.local - -# Java / Maven -target/ -*.class - -# Node / 前端构建产物 -node_modules/ -dist/ -build/ -coverage/ - -# IDE -.idea/ -.vscode/ -*.iml - -# OS -.DS_Store -Thumbs.db - -# 日志 -*.log -logs/ - -# 插件运行时临时文件 -.tmp/ -*.raw -# ==== 结束 ==== diff --git a/skills/plan/skeleton-gen/templates/scripts-setup-test-db-template.mjs b/skills/plan/skeleton-gen/templates/scripts-setup-test-db-template.mjs deleted file mode 100644 index ec56d45..0000000 --- a/skills/plan/skeleton-gen/templates/scripts-setup-test-db-template.mjs +++ /dev/null @@ -1,126 +0,0 @@ -#!/usr/bin/env node -// scripts/setup-test-db.mjs — 数据库重置脚本：drop + create 空库。 -// schema apply 由 Flyway 在 Spring Boot 启动时自动处理（见 docs/04 技术栈 + sql/migrations/V*.sql）。 -// seed 数据由测试框架负责（Spring @Sql / Flyway R__seed.sql / data.sql）。 -// -// 使用场景： -// - scripts/test.mjs 开头：清空库，让 Spring 启动时 Flyway 从 V1 开始重放所有 migration -// - scripts/test.mjs 结尾：清空库，避免测试遗留污染下次运行 -// - 手动调试时：reset 到零状态 -// -// 跨平台：用纯 JS 解析 .env.local（dotenv 风格，逐行 KEY=VALUE），**绝不** shell-source， -// 因此 mac / Windows 原生 node 均可运行，且消除 shell 注入 / 变量展开隐患。 -// DROP/CREATE 通过 `mysql` 客户端以 argv 数组方式执行（不经 shell），密码不进命令行解析层。 -// -// 防护：本脚本只允许在本地 host + 测试库名上执行；非预期目标会被拒绝， -// 避免 .env.local 误指向 staging/prod 时触发不可逆 DROP。 - -import { spawnSync } from 'node:child_process' -import { existsSync, readFileSync } from 'node:fs' -import { dirname, join } from 'node:path' -import { fileURLToPath } from 'node:url' - -const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url)) -const ENV_FILE = join(SCRIPT_DIR, '..', '.env.local') - -// dotenv 风格解析：逐行 KEY=VALUE，跳过空行与 # 注释，去除两侧空白， -// 可选地剥离一层成对单/双引号。**不做**变量展开，特殊字符按字面保留。 -function parseEnv(text) { - const env = {} - for (const rawLine of text.split(/\r?\n/)) { - const line = rawLine.trim() - if (line === '' || line.startsWith('#')) continue - const eq = line.indexOf('=') - if (eq === -1) continue - const key = line.slice(0, eq).trim() - if (!key) continue - let value = line.slice(eq + 1).trim() - if ( - value.length >= 2 && - ((value.startsWith("'") && value.endsWith("'")) || - (value.startsWith('"') && value.endsWith('"'))) - ) { - value = value.slice(1, -1) - } - env[key] = value - } - return env -} - -if (!existsSync(ENV_FILE)) { - console.error(`[setup-test-db] .env.local 不存在（${ENV_FILE}）`) - process.exit(1) -} - -const env = parseEnv(readFileSync(ENV_FILE, 'utf8')) - -const DB_HOST = env.DB_HOST ?? '' -const DB_PORT = env.DB_PORT ?? '3306' -const DB_USER = env.DB_USER ?? '' -const DB_PASSWORD = env.DB_PASSWORD ?? '' -const DB_SCHEMA = env.DB_SCHEMA ?? '' -const TEST_DB_ALLOW_REMOTE = env.TEST_DB_ALLOW_REMOTE ?? process.env.TEST_DB_ALLOW_REMOTE ?? '0' -const TEST_DB_ALLOW_PROD_NAME = - env.TEST_DB_ALLOW_PROD_NAME ?? process.env.TEST_DB_ALLOW_PROD_NAME ?? '0' - -// 防护 1：默认只允许本地 host（localhost / 127.0.0.1 / ::1）。 -// 额外允许的远程 host 在 .env.local 的 TEST_DB_ALLOWED_HOSTS 中（空格或逗号分隔）。 -const extraHosts = (env.TEST_DB_ALLOWED_HOSTS ?? '') - .split(/[\s,]+/) - .filter(Boolean) -const allowedHosts = ['localhost', '127.0.0.1', '::1', ...extraHosts] -if (!allowedHosts.includes(DB_HOST)) { - console.error(`[setup-test-db] 拒绝在非白名单 host (${DB_HOST}) 上执行 DROP DATABASE`) - console.error(` 当前白名单：${allowedHosts.join(' ')}`) - console.error(' 加入 host：在 .env.local 追加 TEST_DB_ALLOWED_HOSTS="<host1> <host2>"') - console.error(' 一次性绕过：在 .env.local 设 TEST_DB_ALLOW_REMOTE=1') - if (TEST_DB_ALLOW_REMOTE !== '1') process.exit(1) -} - -// 防护 2：schema 名需像测试/开发库（含 test / _dev / _local / _ci），否则要求显式确认。 -const schemaLooksLikeTest = - /test/.test(DB_SCHEMA) || /_dev$/.test(DB_SCHEMA) || /_local$/.test(DB_SCHEMA) || /_ci$/.test(DB_SCHEMA) -if (!schemaLooksLikeTest) { - console.error( - `[setup-test-db] schema '${DB_SCHEMA}' 不像测试库（期望命名含 test / _dev / _local / _ci）` - ) - console.error(' 如确为期望行为，请显式声明：在 .env.local 设 TEST_DB_ALLOW_PROD_NAME=1') - if (TEST_DB_ALLOW_PROD_NAME !== '1') process.exit(1) -} - -// 防护 3：显式 banner，让人看见自己在 drop 什么；远程 host 额外提示白名单内容。 -console.log(`[setup-test-db] 即将 DROP + CREATE \`${DB_SCHEMA}\` on ${DB_HOST}:${DB_PORT}`) -if (!['localhost', '127.0.0.1', '::1'].includes(DB_HOST)) { - console.log( - '[setup-test-db] 目标是 **远程** host（已在 TEST_DB_ALLOWED_HOSTS 白名单中，每次 test.mjs 都会 DROP）' - ) - console.log(`[setup-test-db] 当前白名单: ${allowedHosts.join(' ')}`) - console.log( - '[setup-test-db] 若不希望每次自动 DROP，从 .env.local 的 TEST_DB_ALLOWED_HOSTS 删掉此 host' - ) -} - -const sql = - `DROP DATABASE IF EXISTS \`${DB_SCHEMA}\`; ` + - `CREATE DATABASE \`${DB_SCHEMA}\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;` - -// 以 argv 数组调用 mysql（不经 shell）：密码不进 shell 解析，跨平台一致。 -const mysqlArgs = [ - `-h${DB_HOST}`, - `-P${DB_PORT}`, - `-u${DB_USER}`, - `-p${DB_PASSWORD}`, - '-e', - sql, -] -const res = spawnSync('mysql', mysqlArgs, { stdio: 'inherit' }) -if (res.error) { - console.error(`[setup-test-db] FATAL: 无法执行 mysql（请确认其在 PATH 中）: ${res.error.message}`) - process.exit(1) -} -if (res.status !== 0) { - console.error(`[setup-test-db] FAIL: mysql exit=${res.status}`) - process.exit(res.status === null ? 1 : res.status) -} - -console.log('[setup-test-db] done — schema will be applied by Flyway when Spring Boot starts') diff --git a/skills/plan/skeleton-gen/templates/scripts-test-template.mjs b/skills/plan/skeleton-gen/templates/scripts-test-template.mjs deleted file mode 100644 index 9f0ab8c..0000000 --- a/skills/plan/skeleton-gen/templates/scripts-test-template.mjs +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env node -// scripts/test.mjs —— 合并到默认分支（main / master）前的测试闸门。 -// 顺序：detect → setup-db → build → lint → unit+integration → e2e → reset-db -// 由 coding.mjs 的 test-gate stage（通过子会话）调用。 -// -// 跨平台：所有命令经 child_process.spawnSync(cmd, { shell:true }) 执行， -// 在 Windows 走 cmd.exe，在 *nix 走 /bin/sh，无需 WSL / Git-Bash。 -// 命令字符串来自 docs/04 §零（构建/lint/单测/e2e）——由 skeleton-gen 在 Plan 期填充。 - -import { spawnSync } from 'node:child_process' -import { existsSync } from 'node:fs' -import { dirname, join } from 'node:path' -import { fileURLToPath } from 'node:url' - -const PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..') - -// 在指定子目录下跑一条 shell 命令；非零退出码即终止整个闸门并透传该码。 -function run(label, command, cwd = PROJECT_ROOT) { - console.log(`[test.mjs] ${label}: ${command}`) - const res = spawnSync(command, { cwd, shell: true, stdio: 'inherit' }) - if (res.error) { - console.error(`[test.mjs] FATAL: 无法执行 (${label}): ${res.error.message}`) - process.exit(1) - } - if (res.status !== 0) { - console.error(`[test.mjs] FAIL (${label}) exit=${res.status}`) - process.exit(res.status === null ? 1 : res.status) - } -} - -// Stack detection (runtime, mode-agnostic) -const hasBackend = existsSync(join(PROJECT_ROOT, 'backend')) -const hasFrontend = existsSync(join(PROJECT_ROOT, 'frontend')) -if (!hasBackend && !hasFrontend) { - console.error('[test.mjs] FATAL: neither backend/ nor frontend/ exists') - process.exit(1) -} - -const backendDir = join(PROJECT_ROOT, 'backend') -const frontendDir = join(PROJECT_ROOT, 'frontend') - -console.log('[test.mjs] 1/6 setup test db') -run('setup-test-db', `node ${JSON.stringify(join('scripts', 'setup-test-db.mjs'))}`) - -console.log('[test.mjs] 2/6 build') -if (hasBackend) run('backend build', '{{backend_build}}', backendDir) -else console.log('[test.mjs] skip backend build') -if (hasFrontend) run('frontend build', '{{frontend_build}}', frontendDir) -else console.log('[test.mjs] skip frontend build') - -console.log('[test.mjs] 3/6 lint') -if (hasBackend) run('backend lint', '{{backend_lint}}', backendDir) -else console.log('[test.mjs] skip backend lint') -if (hasFrontend) run('frontend lint', '{{frontend_lint}}', frontendDir) -else console.log('[test.mjs] skip frontend lint') - -console.log('[test.mjs] 4/6 unit + integration') -if (hasBackend) run('backend test', '{{backend_test}}', backendDir) -else console.log('[test.mjs] skip backend test') -if (hasFrontend) run('frontend test', '{{frontend_test}}', frontendDir) -else console.log('[test.mjs] skip frontend test') - -console.log('[test.mjs] 5/6 E2E') -run('e2e', '{{e2e_cmd}}') - -console.log('[test.mjs] 6/6 reset test db') -run('reset-test-db', `node ${JSON.stringify(join('scripts', 'setup-test-db.mjs'))}`) - -console.log('[test.mjs] GREEN') diff --git a/skills/plan/skeleton-gen/templates/styles-tokens-template.css b/skills/plan/skeleton-gen/templates/styles-tokens-template.css deleted file mode 100644 index bc8a542..0000000 --- a/skills/plan/skeleton-gen/templates/styles-tokens-template.css +++ /dev/null @@ -1,43 +0,0 @@ -/* - * src/styles/tokens.css — Design Tokens - * 命名规范见 docs/04-技术规范.md § 2.5 - * 色值锁定见 docs/06-UI交互规范.md § 四 - * - * 命名格式：--color-<scope>-<role>-<state> - * <scope> 组件域：form / table-row / table-header / ... - * <role> 作用：bg（背景）/ fg（前景/字体）/ border - * <state> 状态：edit / readonly / hover / selected（无状态时省略） - * - * 约束： - * - 组件样式中只用 var(--color-xxx)，禁止硬编码 hex / rgba - * - 修改色值只改本文件，不允许在组件级覆盖 - * - 新增 token 须先登记到 docs/06 § 4.1 / 4.2，再补到此处 - */ - -:root { - /* === 1. 全局调色板（与 Ant Design 主题对齐） === */ - --color-primary: #1890ff; - --color-success: #52c41a; - --color-warning: #faad14; - --color-error: #ff4d4f; - --color-text: rgba(0, 0, 0, 0.85); - --color-text-secondary: rgba(0, 0, 0, 0.45); - --color-border: #d9d9d9; - --color-bg-base: #f0f2f5; - - /* === 2. 组件级状态色（与 docs/06 § 4.2 一一对应） === */ - - /* form：输入框 / 备注框 / 时间框 / 下拉框共用 */ - --color-form-bg-edit: #ffffff; - --color-form-bg-readonly: #f1f2f8; - --color-form-bg-hover: #f5f5f5; /* 仅下拉框使用 */ - --color-form-fg: #000000; - - /* table */ - --color-table-row-bg-selected: #86d5fb; - --color-table-row-bg-hover: #fff7e6; - --color-table-row-bg-readonly: #f1f2f8; /* = rgb(241, 242, 248) */ - --color-table-row-fg: #000000; - --color-table-header-bg: #f5f5f5; - --color-table-header-fg: rgba(0, 0, 0, 0.85); /* = #000000D9 */ -} diff --git a/skills/project-init/SKILL.md b/skills/project-init/SKILL.md new file mode 100644 index 0000000..d1aecf6 --- /dev/null +++ b/skills/project-init/SKILL.md @@ -0,0 +1,89 @@ +--- +name: project-init +description: A0 项目初始化——从插件模板幂等地复制 CLAUDE.md / docs/01-需求清单/index.md / docs/04-技术规范.md / docs/08-模块任务管理.md（已存在则跳过），并初始化 Git（如未初始化）。session-start 在 docs/08 缺失时派发本 skill。 +user-invocable: false +allowed-tools: Glob Edit Skill Bash(mkdir *) Bash(cp -n *) Bash(git init) Bash(command -v *) Bash(uname *) Bash(brew *) Bash(apt *) Bash(apt-get *) Bash(yum *) Bash(apk *) Bash(export PATH=*) Bash(echo *) Bash(cat *) +--- + +**所有输出必须使用中文。** + +你负责在项目目录中创建初始文件结构，已存在的文件不覆盖。 + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/project-init/banners/flow.txt" +``` + +### A. 幂等复制模板文件 + +用 `Bash` 一次性完成。`cp -n` 表示"不覆盖已存在的文件"： + +```bash +mkdir -p docs/01-需求清单 +cp -n "${CLAUDE_SKILL_DIR}/templates/CLAUDE-template.md" CLAUDE.md +cp -n "${CLAUDE_SKILL_DIR}/templates/docs-01-index-template.md" docs/01-需求清单/index.md +cp -n "${CLAUDE_SKILL_DIR}/templates/docs-04-stack-template.md" docs/04-技术规范.md +cp -n "${CLAUDE_SKILL_DIR}/templates/docs-08-initial-template.md" docs/08-模块任务管理.md +``` + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 项目文件骨架已创建（CLAUDE.md + docs/01-需求清单/index.md + docs/04-技术规范.md）` + +### B. 依赖检查 + 自动安装（命令行工具） + +对 **git、mysql** 两个工具依次执行以下流程。 + 1. 如果缺失，尝试自动安装。 + 2. 如果检测到不在 PATH，尝试添加进 PATH，并加载。 + +全部通过后打印单行汇总再进入步骤 C： + +``` +[project-init] 依赖检查: git ✓ mysql ✓ +``` + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 依赖检查通过` + +### C. 初始化 Git（如尚未初始化） + +用 `Glob` 检查 `.git/` 目录是否存在。 +- 不存在 → 用 `Bash` 执行 `git init`。 +- 已存在 → 跳过。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选（A0 子项 + A0 顶层）： +- ` - [ ] Git 已初始化` +- `- [ ] A0 项目初始化 — project-init` + +### D. 打印完成横幅并进入 A1 + +向用户输出： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [project-init] 项目初始化完成 + + 已创建： + ✓ CLAUDE.md（从插件模板复制） + ✓ docs/01-需求清单/index.md（待人工填写模块索引） + ✓ docs/04-技术规范.md（默认技术栈，A1 让用户确认） + ✓ docs/08-模块任务管理.md（全流程进度跟踪） + 已勾选：A0 项目初始化 + + 下一步：A1 scope-lock（填写项目概述 + 技术栈 + 需求索引 + REQ 卡片） +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +立即调用 `Skill(scope-lock)` 进入 A1，不等用户手动输入。 + +## 参考 + +- `${CLAUDE_SKILL_DIR}/templates/CLAUDE-template.md`（项目级 CLAUDE.md 模板） +- `${CLAUDE_SKILL_DIR}/templates/docs-01-index-template.md`（需求索引初稿） +- `${CLAUDE_SKILL_DIR}/templates/docs-04-stack-template.md`（默认技术栈） +- `${CLAUDE_SKILL_DIR}/templates/docs-08-initial-template.md`（A 阶段进度初始化） +- 下游：`scope-lock`（A1，自动派发） diff --git a/skills/project-init/banners/flow.txt b/skills/project-init/banners/flow.txt new file mode 100644 index 0000000..fd2e547 --- /dev/null +++ b/skills/project-init/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ ▶ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/project-init/templates/CLAUDE-template.md b/skills/project-init/templates/CLAUDE-template.md new file mode 100644 index 0000000..a048f68 --- /dev/null +++ b/skills/project-init/templates/CLAUDE-template.md @@ -0,0 +1,260 @@ +# CLAUDE.md — ERP项目 Claude Code 主指令文件 + +> 本文件是 Claude Code 的"操作手册"。Claude Code 启动时会自动读取此文件。 + +--- + +## 🎯 项目概述 + +- **项目名称**: 【人工填写：公司 + 项目名，例如"XX 公司 ERP 管理系统"】 +- **项目简述**: 【人工填写：一句话描述项目目标，例如"面向中小制造企业的全流程 ERP，涵盖采购/库存/生产/销售/财务"】 +- **目标用户**: 【人工填写：谁会用，例如"企业内部管理人员（采购员、仓管员、生产主管、销售员、财务人员、管理层）"】 +- **部署方式**: 【人工填写：私有化部署 / 云部署 / Docker 容器化 等】 + +--- + +## 🔄 B 阶段开发流程（后端模块循环 → 前端整体阶段） + +B 阶段分两段，**全部固化到 skills**。入口：`/erp-workflow:coding-start`。 + +### 阶段路由（coding-start 内，只做分发） + +`coding-start` 每次入口做两段完成性检查后真值表派发： + +- 后端完成性检查 → `backend_done`（扫 docs/08 § 二 里程碑字段 + `git tag -l`） +- 前端完成性检查 → `frontend_done`（扫 docs/08 § 三 整体里程碑 + `git tag -l`） + +| `backend_done` | `frontend_done` | 派发 | +|---|---|---| +| `false` | 任意 | `module-start`（写后端） | +| `true` | `false` | `frontend-start`（写前端） | +| `true` | `true` | "所有阶段已完成" | + +前端阶段前置（prototype/ 门禁）由 `frontend-start` 自带，不在 coding-start。`module-start` 与 `frontend-start` **互不感知对方**。 + +### 后端阶段（每模块一个里程碑 tag） + +- **模块循环（外）**：`module-start` → `test-gate(phase=backend)` → `module-report` → `milestone-tag`（本地 merge 进默认分支 + 打 `milestone/<id>` tag）→ 自动回调 coding-start 路由下一阶段（无人工介入） +- **功能循环（内，每 REQ-XXX-NNN 一遍）**：`feature-brainstorm` → `feature-plan` → `feature-tdd` → `feature-verify` → `feature-review` +- 后端阶段任务严格落在 `backend/` 路径下；docs/01 REQ 卡片的 UI 描述在此阶段忽略，UI 推迟到前端阶段。 + +### 前端阶段（整体一个里程碑 tag，所有后端模块打里程碑后启动） + +- **FE 清单（AI 自主推导，无审阅断点）**：`frontend-start` 进入时扫 prototype + docs/01 + docs/05 → AI 自主推导 FE 业务功能清单写入 `docs/08 § 三`（已有则加载）。**FE 是业务功能粒度，与 prototype HTML 文件数无关**——一个 HTML 可拆多个 FE，多个 HTML 也可合成一个 FE。FE 清单的合理性由 fe-feature-review / milestone-tag 在整体里程碑标记时一并校核（全程无人工介入）。 +- **FE 循环（外）**：`frontend-start` → fe-feature 循环 → `test-gate(phase=frontend)` → `module-report(phase=frontend)` → `milestone-tag`（分支 `frontend-phase`，docs/08 § 三 整体里程碑）。 +- **FE 功能循环（内，每个 FE-NN 一遍）**：`fe-feature-brainstorm` → `fe-feature-plan` → `fe-feature-tdd` → `fe-feature-verify` → `fe-feature-review`（专用 `fe-code-reviewer` agent，硬编码 7 维 review checklist） +- 前端阶段任务严格落在 `frontend/` 路径下；布局以 `prototype/` 为权威。 + +### 里程碑前测试闸门 + +- `test-gate`：后端阶段子会话跑 `scripts/test.sh`（含本模块新增 + 已合并模块回归）；前端阶段子会话跑 vitest + playwright。 +- `test-gate` 是打里程碑 tag 前唯一的硬测试门；红色不得跳过进入 `module-report` / `milestone-tag`。 + +--- + +## ✅ 阶段完成判定规则 + +`docs/08-模块任务管理.md` 分两段： +- `§ 二`：后端模块元数据表（每个模块一行 bullet，记录依赖 / 路径 / 里程碑 tag / 功能子项） +- `§ 三`：前端阶段元数据（整体里程碑 + FE 子项清单，由 `frontend-start` 在所有后端模块打里程碑后填入） + +**阶段完成判定**统一以 `里程碑:` 字段（§ 二 各模块） / `整体里程碑:` 字段（§ 三）+ 本地 `git tag -l 'milestone/<id>'` 判定；子项勾选只作可视化进度，不参与完成判定。 + +### 后端模块格式 + +每个后端模块在 docs/08 § 二 中长这样： + +```markdown +- module_0 系统管理 + - 依赖: — + - 路径: backend/module/sys/ + - 里程碑: — + - 功能: + - [ ] REQ-SYS-001 用户登录 + - [ ] REQ-SYS-002 用户注册 +``` + +- `里程碑:` 字段由 `milestone-tag` 在打里程碑 tag 时从 `—` 改为 `milestone/<module_id>`。 +- 每个 `REQ-*` 子项由 `feature-review` 在 `verdict=approve` 时自动勾选为 `[x]`。 +- 路径限定为后端目录（如 `backend/module/sys/`）；前端代码不在此阶段产生。 + +### 前端阶段格式（§ 三） + +```markdown +- 整体里程碑: — +- 功能: + - [ ] FE-01 用户登录与注册 ｜ 关联 REQ：REQ-SYS-001, REQ-SYS-002 ｜ 关联原型：prototype/auth.html + - [ ] FE-02 仪表盘总览 ｜ 关联 REQ：REQ-DASH-001 ｜ 关联原型：prototype/dashboard.html +``` + +- `整体里程碑:` 字段由 `milestone-tag` 在打前端里程碑 tag 时从 `—` 改为 `milestone/frontend-phase`。 +- "功能:" 列表由 `frontend-start` 进入时由 AI 自主推导写入（无人工审阅断点）。FE 是业务功能粒度，与 prototype HTML 文件数无关；合理性由 fe-feature-review / 整体里程碑标记时统一校核。 +- 每个 `FE-NN` 子项由 `fe-feature-review` 在 `verdict=approve` 时自动勾选为 `[x]`。 +- 进入前端阶段前 `frontend-start` 步骤 1 自带 prototype/ 门禁，强制检查项目根 `prototype/` 至少含 1 个 `*.html` mockup。 + +### 状态语义（后端模块 + 前端阶段共用） + +| `里程碑:` 字段 | `git tag -l` | 含义 | 你（Claude Code）的行为 | +|---|---|---|---| +| `—` | tag 不存在 | 该阶段未开始 / 进行中（未打里程碑） | ✅ 开始 / 继续该阶段开发 | +| `milestone/<id>` | tag 存在 | 阶段**已完成** | 🟢 后端：进入下一未完成模块；后端全完 → 前端阶段；前端已打里程碑 → 全部完成 | + +### 模块完成报告 + +由 `module-report` skill 产出，模板位于 由 module-report skill 持有（12 节标准化，含跨模块改动等 CLAUDE.md 软规则映射节）。CC 不手写模块报告，仅填模板。 + +--- + +## 🏷️ 占位符统一约定 + +项目文档里有 **2 种填写占位** + **1 种提示占位**： + +| 格式 | 谁填 | 使用阶段 | 说明 | +|------|-----|---------|------| +| `【人工填写：<简短说明>】` | 人 | 仅 A 阶段文档 | 密钥 / 账密 / 包名 / 命名约定 / 小版本号等人工才能决定的值；B 阶段 plan/spec 禁止出现，查不到真值时用 `AskUserQuestion` 问用户 | +| `TBD(<责任人>)` | CC 自动 | A 或 B | 后缀附带责任方（如 `TBD(A3 自动补)` / `TBD(A5 自动补)`）；由对应 skill 就地补填，`module-report` § ⑦ 检查 `TBD(CC 补)` 残留 | + +**HTML 注释 `<!-- ... -->`**：提示占位，是**插件内部大纲模板**里给 LLM 的**填空提示 / 章节引导**，指引 LLM 按结构填实际内容。skill 生成时会**剥除**这些注释，最终产物里注释不会保留。 + +--- + +## 📐 编码行为约束 + +### 你必须做的 ✅ + +1. **严格遵循** `docs/04-技术规范.md`——命名 / 编码 / 统一响应 / 异常处理 / 数据访问 / 配置与安全 等项目专属技术规约全部在此 +2. **严格遵循** `docs/09-项目目录结构.md`——文件放对位置 +3. **每个后端接口** 必须先在 `docs/05-API接口契约.md` 定义，再编码实现 +4. **每个功能可追溯到 `REQ-XXX-NNN`**——commit tag + 代码注释（如 `// REQ-SYS-001: 用户登录`）+ plan/spec 文件名均用此 tag +5. **遇到跨模块改动**（动到非当前模块的代码）——按 § 🟡 软规则 **S2** 执行（允许改，但必须留痕） +6. **遇到技术栈外组件引入**（`docs/04 § 零` 技术栈表外的框架 / 中间件 / 关键库），按 § 🟡 软规则 **S1** 执行（允许引入，但必须先 AskUserQuestion） + +### 你禁止做的 🚫 + +1. **主会话直接 `mysql -e` 跑业务 DDL**（只读查询 / 临时本地调试除外）——业务 schema 必须走 `sql/migrations/V_n__*.sql`，详见下方 Schema 演化规约 +2. **手动 Edit `docs/08 § 二/§ 三` 的 `里程碑:` / `整体里程碑:` 字段**，必须要由 `milestone-tag` 自动回写 + +### Schema 演化规约（Flyway migration） + +1. **文件命名**：`sql/migrations/V<n>__<snake_case_desc>.sql`，例：`V5__add_user_email_unique_index.sql` +2. **版本号分配**：建文件前 `ls sql/migrations/V*.sql` 查当前最大 n，新文件 `n_max + 1` +3. **Apply 方式**：Spring Boot 启动 / 测试启动时 Flyway 自动 apply（项目必须在 `pom.xml` 声明 `flyway-core` + `flyway-mysql` 依赖）。`scripts/setup-test-db.sh` 只负责清空库，不做 apply +4. **已合并的 migration 永不修改**：发现错了写一个补救 migration（如 `V7__fix_V5_index_name.sql`），旧 `V_n.sql` +5. **临时调试 DDL**：临时在本地试字段/索引可手动 `mysql -e`，但不写 migration；下次 `setup-test-db.sh` 会 drop+create 清掉 +6. **A4 生成的 V1**：`V1__initial_schema.sql` 是 A 阶段由 `db-init` 从 `docs/03-数据库设计文档.md`（A3 正向设计的 schema SSoT）翻译生成的初始版本；后续 V2/V3/... 由 B 阶段每个 REQ 按需写入，**同时**反向同步更新 docs/03 对应表小节以保持 SSoT 一致 + +--- + +## 🗂️ Git 提交规范 + +每次提交必须遵循以下格式： + +``` +<type>(<scope>): <subject> +``` + +- `scope`: 模块名，如 `user` / `inventory` / `order` +- `subject`: 简短描述；业务类（feat / fix / test）必须带 `REQ-XXX-NNN` 后缀 + +`type` 含义： + +| type | 看到它意味着 | +|-----|-------------| +| `feat` | **新能力上线**——用户多了一个功能、接口、页面或业务规则 | +| `fix` | **修 bug**——原来行为错了，这次改对 | +| `refactor` | **重构**——外部行为不变，只改代码结构 / 命名 / 抽象 | +| `docs` | **文档改动**——只动 Markdown / 代码注释，不动实现 | +| `style` | **格式调整**——空白 / 缩进 / import 顺序，逻辑 0 变化 | +| `test` | **只动测试代码**——补用例 / 修 fixture，不碰实现 | +| `chore` | **流程维护**——构建 / 依赖 / 工具 / 证据档案 / 里程碑元数据等非业务动作 | + +--- + +## 🚩 中断机制 + +功能循环（每个功能 REQ-XXX 的 Brainstorm → Plan → TDD → Verify → AI 自审）默认 **静默编程**，但触发以下任何一条必须**立刻停下、记录原因、等人决策**，不得自行绕过： + +| # | 中断 | 例子 | +| - | --- | --- | +| 1 | **测试反复失败** | 同一测试同一功能内连续 **10 次**修复失败 | +| 2 | **要改密钥 / 账密 / 包名** | `docs/07-环境配置.md` 里由人工标注必须填的字段 | +| 3 | **外部接口不可达** | 第三方 API 无法连接、证书失效等环境问题，并无法自行解决 | + +> 其余需要人类判断的场景一律走普通 `AskUserQuestion` Q&A，不中断、不写 Blocker 文件。 + +**触发中断时的固定动作：** + +1. 在当前功能的 plan 文件里追加一节 `## 🚩 Blocker`（报告格式由 `interrupt-check` 的 `interrupt-block-template.md` 持有） +2. 停止后续所有功能的静默执行 +3. 在主会话输出一句话摘要 + 指向 blocker 文件的路径，等人回复 + +--- + +## 🟡 软规则（允许继续，但有强制后续动作） + +以下情况 **不触发中断**，CC 可自行继续推进，但必须在约定位置留痕，模块完成时统一审计。 + +| # | 软规则 | 允许动作 | 强制后续 | +| - | ----- | ------- | ------- | +| S1 | **技术栈外组件引入** | 用 `AskUserQuestion` 给用户三选一：接受引入 / 换方案 / 拒绝 | ① **接受** → 同会话直接在 `docs/04 § 零` 追加一行 → 继续流程 ② **换方案 / 拒绝** → 视为常规歧义澄清，继续 Q&A 收敛 ③ 不写 Blocker、不中断流程 | +| S2 | **跨模块改动** | **默认不改**，仅为当前模块实现所必需时允许修改 | ① hook `log-cross-module.sh` 自动落存根 ② `module-report` 一次性调用 `cross-module-log` skill 批量补齐「原因 / 影响评估」+ 「跨模块改动」节完整贴入《模块完成报告》 | + +--- + +## 🧭 通用工作准则（General Principles） + +### 1. Think Before Coding + +**Don't assume. Don't hide confusion. Surface tradeoffs.** + +Before implementing: +- State your assumptions explicitly. If uncertain, ask. +- If multiple interpretations exist, present them - don't pick silently. +- If a simpler approach exists, say so. Push back when warranted. +- If something is unclear, stop. Name what's confusing. Ask. + +### 2. Simplicity First + +**Minimum code that solves the problem. Nothing speculative.** + +- No features beyond what was asked. +- No abstractions for single-use code. +- No "flexibility" or "configurability" that wasn't requested. +- No error handling for impossible scenarios. +- If you write 200 lines and it could be 50, rewrite it. + +Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. + +### 3. Surgical Changes + +**Touch only what you must. Clean up only your own mess.** + +When editing existing code: +- Don't "improve" adjacent code, comments, or formatting. +- Don't refactor things that aren't broken. +- Match existing style, even if you'd do it differently. +- If you notice unrelated dead code, mention it - don't delete it. + +When your changes create orphans: +- Remove imports/variables/functions that YOUR changes made unused. +- Don't remove pre-existing dead code unless asked. + +The test: Every changed line should trace directly to the user's request. + +### 4. Goal-Driven Execution + +**Define success criteria. Loop until verified.** + +Transform tasks into verifiable goals: +- "Add validation" → "Write tests for invalid inputs, then make them pass" +- "Fix the bug" → "Write a test that reproduces it, then make it pass" +- "Refactor X" → "Ensure tests pass before and after" + +For multi-step tasks, state a brief plan: +``` +1. [Step] → verify: [check] +2. [Step] → verify: [check] +3. [Step] → verify: [check] +``` + +Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification. diff --git a/skills/project-init/templates/docs-01-index-template.md b/skills/project-init/templates/docs-01-index-template.md new file mode 100644 index 0000000..08e326a --- /dev/null +++ b/skills/project-init/templates/docs-01-index-template.md @@ -0,0 +1,16 @@ +# 需求清单 + +> 本目录按模块组织所有功能需求。每个模块一个子目录，含 `_module.md`（模块头）和 `REQ-XXX-NNN.md`（每张 REQ 卡片一个文件）。下方核心功能点供 CC 拆分出 REQ 编号 + 标题 + 草拟规则；卡片内输入 / 输出的简述句和 N 张字段表由人工编辑。 + +## 模块索引 + +| 模块代码 | 模块名称 | 核心功能点（简要） | +|----------|----------|--------------------| +| 【人工填写：模块代码】 | 【人工填写：模块名称】 | 【人工填写：核心功能点】 | +| SYS | 系统管理 | 用户/角色/权限/部门/字典 等 | + +## 填写说明 + +1. 每个模块占一行，`模块代码` 用大写英文缩写（如 SYS / PUR / INV / SAL / FIN / HR） +2. `核心功能点` 只需列关键词，CC 会基于此拆分出 N 张 REQ 卡片骨架（卡片内输入 / 输出的简述句和字段表仍由人工编辑） +3. 填完后运行 `/erp-workflow:plan-start`，CC 会自动检测并进入需求生成阶段 diff --git a/skills/project-init/templates/docs-04-stack-template.md b/skills/project-init/templates/docs-04-stack-template.md new file mode 100644 index 0000000..234b200 --- /dev/null +++ b/skills/project-init/templates/docs-04-stack-template.md @@ -0,0 +1,32 @@ +# 04-技术规范 + +## 零、技术栈总览 + +| 分层模块 | 技术 | 版本要求 | 说明 | +|---|---|---|---| +| 前端基础框架 | React | 18.x | 构建前端应用 | +| 前端 UI 组件 | Ant Design | 5.x | 页面组件与交互控件 | +| 前端状态管理 | Redux Toolkit | 最新稳定版 | 管理全局状态 | +| 前端路由管理 | React Router | v6 | 页面路由与导航 | +| 前端工程化构建 | Vite | 最新稳定版 | 前端开发与打包构建 | +| 前端接口通信 | Axios | 最新稳定版 | 调用后端 API | +| 后端基础框架 | Spring Boot | 3.x | 构建后端服务 | +| 后端数据访问 | MyBatis-Plus | 最新稳定版 | 数据库访问与 ORM 增强 | +| 工作流引擎 | Activiti | 6.x | 审批流、流程流转 | +| 缓存服务 | Redis | 最新稳定版 | 缓存、会话、分布式能力 | +| 报表打印 | JXLS | 2.8.1 | 基于 Excel 模板生成报表 | +| Excel 导入导出 | EasyExcel | 4.0.3 | Excel 数据导入导出 | +| 关系型数据库 | MySQL | 8.x | 核心业务数据存储 | +| 数据库 schema 迁移 | Flyway (`flyway-core` + `flyway-mysql`) | 10.x / 最新稳定版 | `sql/migrations/V_n__*.sql` 顺序 apply；Spring Boot 启动时自动应用 | +| 接口风格 | RESTful API | 统一规范 | 前后端接口设计规范 | +| 权限认证 | Spring Security / JWT | 最新稳定版 | 登录认证、权限控制 | +| API 文档 | OpenAPI / Swagger | 最新稳定版 | 接口文档与调试 | +| 项目构建管理 | Maven | 3.9.x | Java 项目依赖与构建 | +| JDK 运行环境 | Java | 17 / 21 | Spring Boot 3 推荐版本 | +| 部署容器 | Docker | 最新稳定版 | 容器化部署 | +| Web 服务器 / 反向代理 | Nginx | 最新稳定版 | 前端托管、反向代理、负载分发 | +| 日志管理 | Logback | 默认集成 / 最新稳定版 | 应用日志输出 | +| 对象映射工具 | MapStruct | 最新稳定版 | DTO / VO / Entity 转换 | +| 工具类库 | Hutool / Apache Commons | 最新稳定版 | 常用工具方法支持 | + +> 本表由 scope-lock 锁定。后续所有规范基于此表推导。 diff --git a/skills/project-init/templates/docs-08-initial-template.md b/skills/project-init/templates/docs-08-initial-template.md new file mode 100644 index 0000000..092902c --- /dev/null +++ b/skills/project-init/templates/docs-08-initial-template.md @@ -0,0 +1,70 @@ +# 08-工作流进度 + +> 全流程进度跟踪。CC 每完成一项产出就勾选一项。 +> - **§ 一 Plan（A0~A5）**：`plan-start` 找第一个未勾 A 子项分发到对应 skill +> - **§ 二 Coding（模块）**：分发以 `docs/02-开发计划.md § 二 开发顺序清单` 为准；`coding-start` 按 docs/02 顺序扫描，对每个 REQ 所属模块查询本 § 二的 `里程碑:` 字段 + 本地 `git tag -l 'milestone/<id>'`，找第一个未打里程碑模块分发。本 § 二 行序无语义，仅作模块元数据表 + +## 一、Plan 阶段（一次性） + +- [ ] A0 项目初始化 — project-init + - [ ] 依赖检查通过 + - [ ] 项目文件骨架已创建（CLAUDE.md + docs/01-需求清单/index.md + docs/04-技术规范.md） + - [ ] Git 已初始化 + +- [ ] A1 范围锁定 — scope-lock + - [ ] 项目概述已填写（CLAUDE.md § 🎯 项目概述） + - [ ] 技术栈已确认（docs/04 § 零） + - [ ] 需求清单索引已填写（docs/01-需求清单/index.md） + - [ ] REQ 卡片骨架已生成（docs/01-需求清单/<module>/REQ-*.md，业务内容留待人工填写） + +- [ ] A2 骨架生成 — skeleton-gen + - [ ] 架构文档已生成（docs/04 § 一+、docs/06、docs/07、docs/09） + - [ ] 工具脚本已生成（scripts/*.sh、.env.local） + - [ ] .gitignore 已配置 + +- [ ] A3 DB 设计 + REQ 回填 — db-design-gen + - [ ] docs/03-数据库设计文档.md 已生成 + - [ ] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填 + +- [ ] A4 DB 初始化 — db-init + - [ ] sql/migrations/V1__initial_schema.sql 已生成 + - [ ] DDL 与 docs/03 全量一致 + - [ ] .env.local 凭据已验证（mysql -e "SELECT 1" OK） + - [ ] setup-test-db.sh 防护通过 + DROP+CREATE + apply V1 已执行 + - [ ] SHOW TABLES 行数 == docs/03 表数量 + +- [ ] A5 下游文档生成 — downstream-gen + - [ ] docs/02 开发计划已生成 + - [ ] docs/05 API 契约已生成 + - [ ] docs/06 § 三 页面清单已填入 + - [ ] docs/10 验收清单已生成 + - [ ] 下方模块列表已填入 + - [ ] REQ 卡片依赖接口已回填 + +## 二、Coding 阶段（后端模块循环） + +（A5 填入后，每行一个后端模块。每个模块的 `里程碑:` 字段在 `—` 和 `milestone/<id>` 之间变化，完成由本地 `git tag -l` 判定。`coding-start` 每次按 docs/02 REQ 序扫每模块的里程碑 tag 决定派发。后端模块全部打里程碑后自动进入 § 三 前端阶段。） + +<!-- 模块格式示例（由 A5 downstream-gen 追加；功能子项由 feature-review 在 approve 时勾选）： +- module_0 系统管理 + - 依赖: — + - 路径: backend/module/sys/ + - 里程碑: — + - 功能: + - [ ] REQ-SYS-001 用户登录 + - [ ] REQ-SYS-002 用户注册 +--> + +## 三、Coding 阶段（前端整体） + +（`frontend-start` 进入时扫 prototype/ + docs/01 + docs/05 → AI 自主推导 FE 业务功能清单写到下方"功能:"项（无人工审阅断点；合理性由整体里程碑标记时统一校核）。已有清单则直接加载。整个前端阶段 1 个里程碑 tag，分支 `frontend-phase`。） + +- 整体里程碑: — +- 功能: + <!-- AI 进入时按以下行格式写入（每行 1 个 FE，可关联多个 REQ / 多份原型）： + - [ ] FE-NN 功能名 ｜ 关联 REQ：REQ-A, REQ-B ｜ 关联原型：prototype/<file>.html, prototype/<other>.html + + 示例： + - [ ] FE-01 用户登录与注册 ｜ 关联 REQ：REQ-SYS-001, REQ-SYS-002 ｜ 关联原型：prototype/auth.html + - [ ] FE-02 仪表盘总览 ｜ 关联 REQ：REQ-DASH-001 ｜ 关联原型：prototype/dashboard.html + --> diff --git a/skills/scope-lock/SKILL.md b/skills/scope-lock/SKILL.md new file mode 100644 index 0000000..c5607c3 --- /dev/null +++ b/skills/scope-lock/SKILL.md @@ -0,0 +1,162 @@ +--- +name: scope-lock +description: A1 计划范围锁定——引导用户填写项目概述 + 技术栈 + 需求索引，并按模块子目录生成 REQ 卡片骨架（CC 推断 req_id/title/goal/rules/constraints/acceptance；输入/输出 各含一句简述 + N 张示例字段表全部原样复制由人工编辑；依赖表/依赖接口模板写死 `TBD(A3/A5 自动补)` 由后续 skill 回填）。 +user-invocable: false +allowed-tools: Read Edit Grep Skill AskUserQuestion Bash(mkdir *) Bash(cp *) Bash(sed *) Bash(bash *) Bash(cat *) +--- + +**所有输出必须使用中文。** + +# scope-lock + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/scope-lock/banners/flow.txt" +``` + +### A. 提示用户填写项目概述并等待 + +向用户输出： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [scope-lock] 请填写项目概述 + + 📄 文件位置: ./CLAUDE.md + 📌 编辑位置: § 🎯 项目概述 + + 请将以下占位符替换为实际值： + - 项目名称 + - 项目简述 + - 目标用户 + - 部署方式 + 改完后回来选择「继续」。 +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +用 `AskUserQuestion` 询问： +- **question**: `项目概述填写完毕了吗？` + - 用户选择「继续」→ 用 `Grep` 在 `CLAUDE.md` 搜索 `【人工填写：`（限定 § 🎯 项目概述 节）。命中 → 打印残留行 + 路径，重新弹出同样的 AskUserQuestion；0 命中 → 勾选并进入步骤 B。 + - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 + +0 命中后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 项目概述已填写（CLAUDE.md § 🎯 项目概述）` + +### B. 提示用户检查默认技术栈并等待 + +`docs/04-技术规范.md` 已由 A0 `project-init` 用模板复制（默认技术栈，见 `project-init/templates/docs-04-stack-template.md`）。本步骤让用户检查 / 调整 § 零。 + +向用户输出： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [scope-lock] 技术栈已保存 + + 📄 文件位置: ./docs/04-技术规范.md（由 A0 模板生成） + 📌 编辑位置: § 零、技术栈总览 + + 请检查技术栈表： + - 不需要的行直接删除（如纯后端项目删前端行） + - 需要替换的技术直接改 + - 需要新增的条目直接加行 + 改完后回来选择「继续」。 +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +用 `AskUserQuestion` 询问： +- **question**: `技术栈检查完毕了吗？` + - 用户选择「继续」→ 进入步骤 C。 + - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 技术栈已确认（docs/04 § 零）` + +### C. 提示用户填写需求清单并等待 + +`docs/01-需求清单/index.md` 已由 `project-init` 写入占位符模板，这里让用户补齐模块清单。 + +向用户输出： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [scope-lock] 请填写需求清单模块索引 + + 📄 文件位置: ./docs/01-需求清单/index.md + 📌 编辑位置: § 模块索引（表格） + + 请按业务列出所有模块： + - 每行一个模块（如 SYS 系统管理 / PUR 采购 / SAL 销售） + - 「核心功能点」只需关键词，CC 会拆分为 REQ 卡片 + 改完后回来选择「继续」。 +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +用 `AskUserQuestion` 询问： +- **question**: `需求清单模块索引填写完毕了吗？` + - 用户选择「继续」→ 进入步骤 D。 + - 用户选择「有疑问想先沟通」→ 回答用户问题后，再次弹出同样的 QA。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 需求清单索引已填写（docs/01-需求清单/index.md）` + +### D. 生成 REQ 卡片骨架并停下等人工审阅 + +1. 用 `Grep` 校验 `docs/01-需求清单/index.md` 无 `【人工填写：` 残留；有则回步骤 C。 +2. 用 `Read` 读 `index.md` 解析模块索引。 +3. **单次 Bash 写入所有文件**（替代 N×9 次 Edit）： + + - **每模块推断**：三元组 `{module_code, module_name, module_brief}` + N 个 REQ 的六元组 `{req_id, title, goal, rules, constraints, acceptance}`。`req_id`/`title` 从核心功能点拆分；`goal` 展开 `title`；`rules`/`constraints`/`acceptance` 起草业务语义。**不推断**输入 / 输出（模板原样保留示例）。 + - **单次 Bash**：调 `${CLAUDE_SKILL_DIR}/scripts/render.sh` 落盘所有文件（脚本内部完成模板读取 + 占位符替换 + HTML 注释剥离）。下面是**调用形态**示例，`<MOD>` / `<模块名>` / `<REQ-MOD-NNN>` 等尖括号位置 CC 按 `index.md` 实际值替换： + + ```bash + R="${CLAUDE_SKILL_DIR}/scripts/render.sh" + # 每个模块：mkdir + 1 个 render module + N 个 render req（每 REQ 一行） + mkdir -p "docs/01-需求清单/<MOD>-<模块名>" + bash "$R" module "docs/01-需求清单/<MOD>-<模块名>/_module.md" "<MOD>" "<模块名>" "<module_brief>" + bash "$R" req "docs/01-需求清单/<MOD>-<模块名>/<REQ-MOD-NNN>.md" "<REQ-MOD-NNN>" "<title>" "<goal>" "<rules>" "<constraints>" "<acceptance>" + ``` + + - **兜底**：值含字面 `$xxx` 或 `}}` 的 REQ 单独走 cp + Edit。 +4. 用 `Edit` 在 `docs/08-模块任务管理.md` 勾选（A1 子项 + A1 顶层）： + - ` - [ ] REQ 卡片骨架已生成（docs/01-需求清单/<module>/REQ-*.md，业务内容留待人工填写）` + - `- [ ] A1 范围锁定 — scope-lock` +5. 打印停下横幅并**停止**： + +``` +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + [scope-lock] ✅ A1 范围锁定完成 + + 产出： + ✓ CLAUDE.md § 🎯 项目概述 + ✓ docs/04 § 零 技术栈 + ✓ docs/01-需求清单/index.md 模块索引 + ✓ docs/01-需求清单/<module>/_module.md 模块头 + ✓ docs/01-需求清单/<module>/REQ-*.md REQ 卡片骨架 + + ⏸ 现在请你逐张打开 REQ 卡片： + - **必改**：输入 / 输出 两段 + · `表1` / `表2` 是模板示例，按本 REQ 业务**改字段 / 增删行 / 增删整张表** + - **审阅**：目标 / 跨字段规则 / 边界 / 验收（已起草，对照业务校正） + - **保留**：`TBD` 不要改，由之后流程自动回填 + + 审阅完成后，运行以下命令继续进入 A2： + /erp-workflow:plan-start + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +## 参考 + +- `CLAUDE.md` § 🎯 项目概述（写入目标） +- `docs/04-技术规范.md`（技术栈输出，供 skeleton-gen 读取使用） +- `docs/01-需求清单/index.md`（模块索引输入） +- `docs/01-需求清单/<module>/_module.md`（模块头输出） +- `docs/01-需求清单/<module>/REQ-*.md`（REQ 卡片骨架输出，A3 db-design-gen / A5 downstream-gen 会回填 TBD 字段） +- `${CLAUDE_SKILL_DIR}/templates/req-card-template.md` +- `${CLAUDE_SKILL_DIR}/templates/_module-template.md` +- `${CLAUDE_SKILL_DIR}/scripts/render.sh`（步骤 D 渲染助手，dispatch `module` / `req` 两种模式） diff --git a/skills/scope-lock/banners/flow.txt b/skills/scope-lock/banners/flow.txt new file mode 100644 index 0000000..e012667 --- /dev/null +++ b/skills/scope-lock/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ ▶ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/scope-lock/scripts/render.sh b/skills/scope-lock/scripts/render.sh new file mode 100644 index 0000000..8a83488 --- /dev/null +++ b/skills/scope-lock/scripts/render.sh @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# render.sh — scope-lock 步骤 D 渲染单个 _module.md 或 REQ-*.md +# +# 用法： +# bash render.sh module <out_path> <module_code> <module_name> <module_brief> +# bash render.sh req <out_path> <req_id> <title> <goal> <rules> <constraints> <acceptance> +# +# 模板路径自定位：脚本同级父目录下 templates/{_module-template.md, req-card-template.md} + +set -euo pipefail + +TYPE=${1:?missing type (module|req)} +shift + +SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) +TPL_DIR="$SCRIPT_DIR/../templates" + +case "$TYPE" in + module) + out=${1:?missing out_path}; code=${2:?}; name=${3:?}; brief=${4:?} + c=$(cat "$TPL_DIR/_module-template.md") + c="${c//\{\{module_code\}\}/$code}" + c="${c//\{\{module_name\}\}/$name}" + c="${c//\{\{module_brief\}\}/$brief}" + ;; + req) + out=${1:?missing out_path}; req_id=${2:?}; title=${3:?}; goal=${4:?}; rules=${5:?}; constraints=${6:?}; acceptance=${7:?} + c=$(sed '/^<!--$/,/^-->$/d' "$TPL_DIR/req-card-template.md") + c="${c//\{\{req_id\}\}/$req_id}" + c="${c//\{\{title\}\}/$title}" + c="${c//\{\{goal\}\}/$goal}" + c="${c//\{\{rules\}\}/$rules}" + c="${c//\{\{constraints\}\}/$constraints}" + c="${c//\{\{acceptance\}\}/$acceptance}" + ;; + *) + echo "render.sh: unknown type '$TYPE' (expect module|req)" >&2 + exit 1 + ;; +esac + +printf '%s\n' "$c" > "$out" diff --git a/skills/scope-lock/templates/_module-template.md b/skills/scope-lock/templates/_module-template.md new file mode 100644 index 0000000..5425b83 --- /dev/null +++ b/skills/scope-lock/templates/_module-template.md @@ -0,0 +1,5 @@ +# {{module_code}}-{{module_name}} + +- **模块简述**: {{module_brief}} +- **依赖模块**: TBD(A5 自动补) +- **涉及表**: TBD(A3 自动补) diff --git a/skills/scope-lock/templates/req-card-template.md b/skills/scope-lock/templates/req-card-template.md new file mode 100644 index 0000000..bb5a169 --- /dev/null +++ b/skills/scope-lock/templates/req-card-template.md @@ -0,0 +1,63 @@ +<!-- +req-card-template：单张 REQ 卡片骨架。每张卡片是 docs/01-需求清单/<module>/REQ-XXX-NNN.md 一个独立文件。 +渲染约定： +1) scope-lock 渲染时**只替换 6 个占位符**：{{req_id}} / {{title}} / {{goal}} / {{rules}} / {{constraints}} / {{acceptance}} + 这 6 项由 CC 根据 docs/01-需求清单/index.md 的「核心功能点」推断起草： + - req_id / title：从核心功能点拆分命名得来 + - goal：用一句话展开 title + - rules / constraints / acceptance：业务语义层面的合理起草，待人工审阅修订 +2) `**输入**` / `**输出**` 二级结构：每段先一句话总结（如「用户提交...」/「返回用户 id」），再跟「表1 / 表2 / ...」N 张平铺的字段表。CC 渲染时对**两段简述 + 所有表（含示例数据）全部原样复制**，不要根据 REQ 业务篡改示例字段、也不要换列结构： + - `输入` 的表：8 列（字段 / 类型 / 必填 / 输入方式 / 显示来源 / 预加载 / 默认值 / 业务规则），其中 `预加载` 取值为 `页面加载时` / `用户操作时` / `—`；模板内含示例数据（表1 6 行、表2 3 行） + - `输出` 的表：3 列（字段 / 类型 / 显示来源），模板内含示例数据（表1 / 表2 各 3 行） + - 表的数量是可变的：人工拿到卡片后按 REQ 实际情况增删表（删多余的 `表N` 整段 / 复制为 `表3 / 表4 / ...`）和编辑字段 +3) `**依赖表**: TBD(A3 自动补)` 和 `**依赖接口**: TBD(A5 自动补)` 是后续 skill 自动回填的占位，渲染时**保持原样**，不要替换为 `-` 也不要替换为 `{{...}}` +4) 渲染后这段 HTML 注释要**剥掉**，不进入最终卡片 +--> +### {{req_id}} {{title}} + +**目标**: {{goal}} + +- **输入**: 用户提交用户名（3-20 位字母数字下划线，系统内唯一）、姓名（2-50字符）、手机号（11 位数字，系统内唯一）、邮箱（标准邮箱格式，可选）、初始密码（8-20位含大小写字母和数字） + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 预加载 | 默认值 | 业务规则 | + | ---- | ---- | --- | ---- | ----- | --- | --- | ------------------- | + | 用户名 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 3-20 位字母数字下划线；系统内唯一 | + | 姓名 | 文本 | 是 | 下拉单选 | `职员表` | 用户操作时 | — | 2-50 个字符 | + | 手机号 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 11 位数字；系统内唯一 | + | 邮箱 | 文本 | 否 | 手工输入 | `职员表` | 否 | — | 标准邮箱格式 | + | 角色 | 文本 | 是 | 下拉单选 | 普通用户/超级管理员 | 页面加载时 | 普通用户 | 至少选择 1 个 | + | 初始密码 | 文本 | 是 | 手工输入 | — | — | — | 8-20 位；含大小写字母和数字；显示星号 | + + - **表2**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 预加载 | 默认值 | 业务规则 | + | --- | --- | --- | --- | --- | --- | --- | --- | + | 用户名 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 3-20 位字母数字下划线；系统内唯一 | + | 姓名 | 文本 | 是 | 下拉单选 | `职员表` | 用户操作时 | — | 2-50 个字符 | + | 手机号 | 文本 | 是 | 手工输入 | `职员表` | 否 | — | 11 位数字；系统内唯一 | + +- **输出**: 返回用户 id + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | --- | --- | --- | + | 用户名 | 文本 | `职员表` | + | 姓名 | 文本 | `职员表` | + | 角色 | 文本 | `职员表` | + + - **表2**： + + | 字段 | 类型 | 显示来源 | + | --- | --- | --- | + | 用户名 | 文本 | `职员表` | + | 姓名 | 文本 | `职员表` | + | 角色 | 文本 | `职员表` | + +- **跨字段规则**: {{rules}} +- **边界**: {{constraints}} +- **验收**: {{acceptance}} +- **依赖表**: TBD(A3 自动补) +- **依赖接口**: TBD(A5 自动补) diff --git a/skills/skeleton-gen/SKILL.md b/skills/skeleton-gen/SKILL.md new file mode 100644 index 0000000..8a177ca --- /dev/null +++ b/skills/skeleton-gen/SKILL.md @@ -0,0 +1,162 @@ +--- +name: skeleton-gen +description: A2 骨架生成——基于 docs/04 § 零 技术栈 + docs/01-需求清单/index.md 模块索引，生成项目专属的架构文档（docs/04 § 一+、docs/06、docs/07、docs/09）和工具脚本。固定工具文件走 cp，架构文档由 LLM 按大纲生成。 +user-invocable: false +allowed-tools: Read Write Edit Skill Grep Glob AskUserQuestion Bash(mkdir *) Bash(cp *) Bash(touch *) Bash(chmod *) Bash(cat *) Bash(bash *) +--- + +**所有输出必须使用中文。** + +# skeleton-gen + +## 执行步骤 + +### 步骤 0：打印当前位置流程图 + +用 `Bash` 执行 `cat` 命令向用户展示当前位置流程图（stdout 即 ASCII 框图）： + +```bash +cat "${CLAUDE_PLUGIN_ROOT}/skills/skeleton-gen/banners/flow.txt" +``` + +### A. 读取锁定的输入 + +用 `Read` 读取： +- `docs/04-技术规范.md` § 零 技术栈表 +- `docs/01-需求清单/index.md` 需求索引 +- `docs/01-需求清单/` 需求卡片 + +后续所有内容都基于它们推导。 + +### B.1 生成 3 个全新架构文档（docs/06 / 07 / 09） + +对下表每个目标文件： +1. 读取对应的大纲模板 +2. 基于步骤 A 的输入，按大纲生成项目专属内容 +3. 剥掉 HTML 注释（注释是给 LLM 的提示，不应出现在最终文档里） +4. 写入目标路径 + +| 目标文件 | 大纲模板 | +|---|---| +| `docs/06-UI交互规范.md`（§ 一 ~ 四，§ 五 占位） | `${CLAUDE_SKILL_DIR}/templates/docs-06-static-template.md` | +| `docs/07-环境配置.md` | `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md` | +| `docs/09-项目目录结构.md` | `${CLAUDE_SKILL_DIR}/templates/docs-09-structure-template.md` | + +项目专属标识（根包名 / 命名空间）保留 `【人工填写：<说明>】` 占位，等人工在 docs/09 顶部补填一次后，其他文件复用。 + +### B.2 追加 docs/04 § 一+（保留 § 零 不覆盖） + +docs/04 已由 scope-lock 写入 § 零。本步骤追加 § 一 ~ 三。 + +1. 读取 `docs/04-技术规范.md`（现有 § 零 完整内容）。 +2. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md`。 +3. 基于技术栈，按大纲生成 § 一 ~ 三 的项目专属内容，剥掉 HTML 注释。 +4. 拼接原有内容和新生成内容，写回 `docs/04-技术规范.md`。 + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 架构文档已生成（docs/04 § 一+、docs/06、docs/07、docs/09）` + +### C. 生成工具脚本 + +#### C.1 复制 + +```bash +mkdir -p scripts sql/migrations src/styles +touch sql/migrations/.gitkeep +cp "${CLAUDE_SKILL_DIR}/templates/env-local-template" .env.local +cp "${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.sh" scripts/setup-test-db.sh +cp "${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css" src/styles/tokens.css +``` + +#### C.2 渲染 scripts/test.sh + +读取 `${CLAUDE_SKILL_DIR}/templates/scripts-test-template.sh`，基于步骤 A 的技术栈（docs/04 § 零）为 7 个占位推断命令后写到 `scripts/test.sh`： + +- `{{backend_build}}` / `{{backend_lint}}` / `{{backend_test}}` 后端各 stage 命令 +- `{{frontend_build}}` / `{{frontend_lint}}` / `{{frontend_test}}` 前端各 stage 命令 +- `{{e2e_cmd}}` E2E（无 E2E 工具则填 `echo "[test.sh] e2e 略"`） + +> 推断规则：根据 `docs/04 § 零` 。 +> - 「后端*」存在 → 据后端技术栈推 backend 三槽（build / lint / test 命令） +> - 「前端*」存在 → 据前端技术栈推 frontend 三槽 +> - 缺席 stack → 三槽全填 `:`（运行期 `[ -d X ]` 守卫对接；语法合法即可） +> - `{{e2e_cmd}}` 通常仅前端，按上述前端规则或填 `echo "[test.sh] e2e 略"` +> +> 表结构异常（列名变更 / 无中文前缀）时停下，用 `AskUserQuestion` 让用户显式确认每 stack 命令。 + +#### C.3 赋权 + +```bash +chmod +x scripts/*.sh +``` + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] 工具脚本已生成（scripts/*.sh、.env.local）` +- ` - [ ] 样式 token 骨架已生成（src/styles/tokens.css）` + +### D. 追加 .gitignore 忽略项 + +调用脚本完成合并： + +```bash +bash "${CLAUDE_SKILL_DIR}/scripts/merge-gitignore.sh" "${CLAUDE_SKILL_DIR}/templates/gitignore-append-template" +``` + +完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- ` - [ ] .gitignore 已配置` + +### E. 占位符补填 + QA 闸门 + +#### E.1 扫描 + 分组 + +用 `Grep` 在以下 8 个路径扫 `【人工填写：`，记录命中（文件 / 行号 / 说明）： +- `docs/04-技术规范.md` / `docs/06-UI交互规范.md` / `docs/07-环境配置.md` / `docs/09-项目目录结构.md` +- `scripts/*.sh` / `.gitignore` +- `.env.local` + +分两组： +- **敏感组**：`.env.local` 路径命中（凭据 / 密钥）。**不弹 QA**（凭据不进会话），E.3 提示用户自填。 +- **非敏感组**：其余文件。按说明文字聚合为「根占位」（相同说明 = 同一值，多处共用）或「派生占位」（说明表达派生关系，如"后端 java 根包路径"派生自"根包名"）。 + +无命中 → 跳 E.4。 + +#### E.2 问根占位 + 推派生 + 批量 Edit + +- 每个根占位用 `AskUserQuestion` 问（给合理默认值 + 自由输入），用 `Edit` 批量替换所有命中位置 +- 派生占位**不问**，CC 基于根占位值推断后 `Edit`；不能可靠推断则回退当独立根占位问 + +#### E.3 敏感占位提示（不弹 QA） + +若敏感组非空：打印提示横幅，列出 `.env.local` 待填字段名 + 告诉用户"直接编辑文件，凭据不进会话"。 + +#### E.4 验证 + QA 闸门 + +循环直到两条件**同时**满足： +(a) `Grep` 重新扫 8 路径，0 命中 +(b) 用户 `AskUserQuestion` 选「继续」 + +每次弹 QA 前重扫；有残留则打印残留位置清单（文件:行号 — 说明）+ 再弹 QA。 + +QA 横幅涵盖：产出文件清单（docs/04 / 06 / 07 / 09 + scripts/*.sh + .env.local + .gitignore）、占位状态（N=0 或待填清单）、「继续」/「有疑问先沟通」两选项。 + +通过后（N=0 且用户选「继续」），用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： +- `- [ ] A2 骨架生成 — skeleton-gen` + +### F. 进入 A3 + +输出 `skeleton-gen: 完成`，立即调用 `Skill(db-design-gen)`。 + +## 参考 + +- `docs/04-技术规范.md` § 零（技术栈输入） +- `docs/01-需求清单/index.md`（模块索引输入） +- `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md`（大纲） +- `${CLAUDE_SKILL_DIR}/templates/docs-06-static-template.md`（大纲） +- `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md`（大纲） +- `${CLAUDE_SKILL_DIR}/templates/docs-09-structure-template.md`（大纲） +- `${CLAUDE_SKILL_DIR}/templates/scripts-test-template.sh`（推断命令填充 7 槽：backend/frontend × build/lint/test + e2e；缺席 stack 填 `:`） +- `${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.sh`（0 槽位） +- `${CLAUDE_SKILL_DIR}/templates/env-local-template`（0 槽位） +- `${CLAUDE_SKILL_DIR}/templates/gitignore-append-template`（0 槽位） +- `${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css`（0 槽位，样式 token 骨架） +- `${CLAUDE_SKILL_DIR}/scripts/merge-gitignore.sh`（.gitignore 逐行判重合并脚本） diff --git a/skills/skeleton-gen/banners/flow.txt b/skills/skeleton-gen/banners/flow.txt new file mode 100644 index 0000000..798f4a9 --- /dev/null +++ b/skills/skeleton-gen/banners/flow.txt @@ -0,0 +1,17 @@ +┌────────────────────────────────────────────────────────┐ +│ 📋 阶段 A：规划（一次性） │ +│ │ +│ A0 初始化项目 │ +│ ↓ │ +│ A1 锁范围（生成 REQ 卡片） → 人工审核 │ +│ ↓ │ +│ ▶ A2 生成骨架 │ +│ ↓ │ +│ A3 生成 DB 设计 → 人工审核 │ +│ ↓ │ +│ A4 初始化 DB │ +│ ↓ │ +│ A5 生成下游文档 │ +│ │ +│ 规划阶段到此结束 │ +└────────────────────────────────────────────────────────┘ diff --git a/skills/skeleton-gen/scripts/merge-gitignore.sh b/skills/skeleton-gen/scripts/merge-gitignore.sh new file mode 100755 index 0000000..cfff18c --- /dev/null +++ b/skills/skeleton-gen/scripts/merge-gitignore.sh @@ -0,0 +1,39 @@ +#!/usr/bin/env bash +# merge-gitignore.sh +# 把模板里的忽略规则合并到项目根的 .gitignore： +# - 若 .gitignore 不存在 → 直接 cp 模板（含注释头和结构） +# - 若已存在 → 逐行判重，只追加模板里缺失的规则行（跳过注释/空行） +# +# 用法：merge-gitignore.sh <template_path> [<target_gitignore_path>] +# template_path 模板文件绝对路径（由 skeleton-gen skill 传入） +# target_gitignore_path 目标 .gitignore 路径，默认为当前工作目录下的 .gitignore +# +# 判重：grep -xF 整行精确匹配 + 字面字符串（非正则），避免 .env 误匹配 .env.local， +# 也避免 *.class / *.iml 等通配符被当作 regex。 + +set -euo pipefail + +template="${1:?usage: merge-gitignore.sh <template_path> [<target_gitignore_path>]}" +target="${2:-.gitignore}" + +if [ ! -f "$template" ]; then + echo "[merge-gitignore] ERROR: template not found: $template" >&2 + exit 1 +fi + +if [ ! -f "$target" ]; then + cp "$template" "$target" + echo "[merge-gitignore] created $target from template" + exit 0 +fi + +added=0 +while IFS= read -r line; do + case "$line" in ""|"#"*) continue ;; esac + if ! grep -qxF "$line" "$target"; then + echo "$line" >> "$target" + added=$((added + 1)) + fi +done < "$template" + +echo "[merge-gitignore] $target updated (+$added rules)" diff --git a/skills/skeleton-gen/templates/docs-04-skeleton-template.md b/skills/skeleton-gen/templates/docs-04-skeleton-template.md new file mode 100644 index 0000000..7f2c116 --- /dev/null +++ b/skills/skeleton-gen/templates/docs-04-skeleton-template.md @@ -0,0 +1,69 @@ +<!-- +本文件是 docs/04-技术规范.md 的 § 一+ 大纲。 +skeleton-gen 读取 docs/04 § 零（技术栈表）和 docs/01-需求清单/index.md（模块索引）， +按下述大纲生成本项目专属的规范内容。LLM 不要原样拷贝提示文字，只保留 section 标题。 +--> + +## 一、后端规范 + +### 1.1 规则 +<!-- 后端通用约定：保留下方占位符不要代填，由人工在 skeleton-gen § E 填写；每条一个 bullet，按需复制本行新增更多。 --> +- 【人工填写：一条后端通用约定，按需复制本行新增更多；无则填「无」】 + +### 1.2 分层结构 +<!-- 按 § 零 的后端框架定层次：controller/service/mapper 等；每层职责一句话。 --> + +### 1.3 命名约定 +<!-- 包名（根包用【人工填写：根包名】占位）/ 类名 / 方法名 / 常量的大小写规则，含 2 个示例。 --> + +### 1.4 统一响应格式 +<!-- 成功/失败的 JSON 结构，错误码段位划分。 --> + +### 1.5 异常处理 +<!-- 全局异常处理器的使用方式；哪些异常要 catch，哪些禁止；**接口响应禁止回显后端异常堆栈**（返用户友好错误码 + 文案）。 --> + +### 1.6 事务 +<!-- 事务边界（通常 service 层）；跨服务调用的禁止/替代方案。 --> + +### 1.7 认证 +<!-- 基于 § 零 认证方案推导：token 生命周期、刷新机制、密钥管理。 --> + +## 二、前端规范 + +### 2.1 目录约定 +<!-- 基于 § 零 前端框架推导：api/components/pages/store/hooks/utils 的职责；**前端禁止直接写 SQL / 操作 DB**，所有数据访问走 api/ 层统一封装。 --> + +### 2.2 状态管理 +<!-- 基于 § 零 状态管理技术推导：全局 vs 局部、服务端数据的存放。 --> + +### 2.3 请求封装 +<!-- HTTP 客户端的拦截器、超时、错误重试、鉴权注入。 --> + +### 2.4 错误处理 +<!-- 网络错误 / 业务错误 / 页面级错误的分层处理。 --> + +### 2.5 样式与主题 +<!-- 基于 § 零 UI 库给出 CSS 变量约定： + - 命名格式 `--color-<scope>-<role>-<state>`（scope=form/table-row/...，role=bg/fg/border，state=edit/readonly/hover/selected） + - 文件位置 `src/styles/tokens.css`，由 skeleton-gen 生成空骨架，色值由 docs/06 § 四锁定后填入 + - 组件样式中只用 var(--color-xxx)，禁止硬编码 hex/rgba + - 与 UI 库主题对接（如 Ant Design ConfigProvider.theme.token）的映射方式 + 具体 token 表见 docs/06 § 四。 --> + +## 三、共同约定 + +### 3.1 Git 提交 +`<type>(<scope>): <subject> REQ-XXX-NNN` + +### 3.2 分页查询 +<!-- 后端分页对象 + 前端分页组件，入参出参约定。 --> + +### 3.3 日期与金额 +<!-- 后端类型（如 LocalDateTime / BigDecimal）+ 前端展示工具；金额精度约定。 --> + +### 3.4 数据访问规约 +<!-- 基于 § 零 数据访问技术（MyBatis-Plus / JPA 等）：SELECT 字段显式列举，**禁止 `SELECT *`**；循环中不得执行 DB 查询（**N+1 反模式**），改用批量查 / IN 子句 / JOIN；Mapper XML 里字段与表名用常量或引用，避免拼字符串。 --> + +### 3.5 配置与安全 +<!-- 配置：DB 连接 / 端口 / 密钥 / 第三方 URL 等一律放 `application.yml` + `.env.local`，代码里**禁止硬编码**。 + 前端安全：`localStorage` 不存敏感信息（token / 身份 / 个人数据），推荐 HttpOnly Cookie 或 内存 + 刷新 token 模式；接口响应禁止回显后端异常堆栈（与 § 1.5 一致）。 --> diff --git a/skills/skeleton-gen/templates/docs-06-static-template.md b/skills/skeleton-gen/templates/docs-06-static-template.md new file mode 100644 index 0000000..467bf32 --- /dev/null +++ b/skills/skeleton-gen/templates/docs-06-static-template.md @@ -0,0 +1,42 @@ +<!-- +本文件是 docs/06-UI交互规范.md 的 § 一~二 大纲（§ 三由 downstream-gen 追加）。 +skeleton-gen 读取 docs/04 § 零 和 docs/01 index，按下述大纲生成项目专属内容。 +布局/页面骨架以项目根的 prototype/ 静态 HTML mockup 为权威，本文件仅承载跨页面通用规则与 Design Tokens。 +--> + +# 06-UI交互规范 + +> 本项目所有页面布局以项目根 `prototype/` 目录下的静态 HTML mockup 为权威。前端阶段（fe-feature-*）实现时直接以 prototype/ HTML 推导组件树与样式。本文件仅承载跨页面通用规则与 Design Tokens。 + +## 一、通用交互规则 + +### 1.1 操作反馈 +<!-- 成功/失败消息；危险操作二次确认；长耗时按钮 loading 态。 --> + +### 1.2 数据展示 +<!-- 空状态 / 加载 / 异常 的统一组件与文案。 --> + +### 1.3 权限控制（前端） +<!-- 菜单级 / 按钮级 / 路由级的控制方式，关联后端 RBAC。 --> + +## 二、Design Tokens + +<!-- 所有色值统一以 CSS 变量定义于 src/styles/tokens.css；命名规范见 docs/04 § 2.5。 --> + +### 2.1 全局调色板 +<!-- 与 § 零 UI 库主题对齐：列名 = 语义 / 变量名 / 默认值 / 用途。 + 至少含：主色/成功/警告/错误/主文字/次文字/边框/背景。 --> + +### 2.2 组件级状态色 +<!-- 场景 × 状态映射表：列名 = 序号 / 组件 / 编辑bg / 只读bg / 悬浮bg / 编辑fg / 只读fg / 悬浮fg / 备注。 + 单元格写 token 名（var(--color-xxx) 形式），不写 hex；"—" 表示该状态不适用。 + 表后追加「Token 默认值」表，列出每个 --color-xxx 在 tokens.css 的默认值。 --> + +### 2.3 引用约定 +<!-- 一句话三条： + - 组件样式只用 var(--color-xxx)，禁止硬编码 + - 新增 token 须先登记到 § 2.1/2.2 再补 tokens.css + - 修改色值只改 tokens.css 一处，不允许组件覆盖 --> + +## 三、页面清单 +（由 `downstream-gen` 按模块追加段落） diff --git a/skills/skeleton-gen/templates/docs-07-env-template.md b/skills/skeleton-gen/templates/docs-07-env-template.md new file mode 100644 index 0000000..3a3306f --- /dev/null +++ b/skills/skeleton-gen/templates/docs-07-env-template.md @@ -0,0 +1,26 @@ +<!-- +本文件是 docs/07-环境配置.md 的大纲。 +skeleton-gen 基于 docs/04 § 零 技术栈表推导各节内容： + § 一 依赖清单 → 从技术栈的每一行技术推导运行时和构建依赖 + § 二 端口约定 → 从后端/前端/数据库/缓存/反向代理 各取默认端口 + § 四 常用命令 → 基于构建工具、包管理器给出开发者最常用命令 +--> + +# 07-环境配置 + +## 一、依赖清单 + +<!-- 表格：| 层 | 依赖 | 版本 | 说明 |；覆盖 运行时 / 构建 / 容器 / CLI 工具。 --> + +## 二、端口约定 + +<!-- 表格：| 服务 | 端口 | 说明 |；至少列 后端 HTTP / 前端 dev / 数据库 / 缓存 / 反代。 --> + +## 三、环境变量 + +运行时凭据（数据库连接、JWT 密钥等）全部放在仓库根的 `.env.local`，不入 git。 +字段清单与占位符见该文件，真实值由开发者本地填写。 + +## 四、常用命令 + +<!-- 表格：| 命令 | 说明 |；包含 启动后端 / 启动前端 / 打包 / 运行测试 / 重置测试数据。 --> diff --git a/skills/skeleton-gen/templates/docs-09-structure-template.md b/skills/skeleton-gen/templates/docs-09-structure-template.md new file mode 100644 index 0000000..d913c08 --- /dev/null +++ b/skills/skeleton-gen/templates/docs-09-structure-template.md @@ -0,0 +1,45 @@ +<!-- +本文件是 docs/09-项目目录结构.md 的大纲。 +skeleton-gen 基于 docs/04 § 零 技术栈推导目录树： + § 二 后端目录 → 按后端框架的惯例（如 Spring Boot 的 src/main/java） + § 三 前端目录 → 按前端框架的惯例（如 Vite + React 的 src/） + § 四 docs 目录 → 沿用插件标准 + § 五 命名约定 → 按后端语言的包/命名空间习惯 + +模块划分参考 docs/01-需求清单/index.md 的模块索引，将业务模块落到代码目录。 +--> + +# 09-项目目录结构 + +## 一、仓库顶层 + +<!-- 用代码块画出顶层目录树，含 CLAUDE.md / README.md / .env.local / scripts / docs / sql / backend / frontend 等。 --> + +## 二、后端目录 + +<!-- 基于后端框架的目录树；按 docs/01 index 的模块代码把业务模块列出（module/user/、module/order/ 等）。 --> + +## 三、前端目录 + +<!-- 基于前端框架的目录树；pages/ 下按业务模块建子目录。 --> + +## 四、docs/ 结构 + +``` +docs/ +├── 01-需求清单/ # 每模块一子目录（_module.md 模块头 + REQ-*.md 卡片） +├── 02-开发计划.md +├── 03-数据库设计文档.md +├── 04-技术规范.md +├── 05-API接口契约.md +├── 06-UI交互规范.md +├── 07-环境配置.md +├── 08-模块任务管理.md +├── 09-项目目录结构.md +├── 10-验收检查清单.md +└── superpowers/ # CC 运行时产物 +``` + +## 五、命名与放置约定 + +<!-- 根包 / 命名空间用【人工填写：】占位；Controller / Service / Mapper / DTO / VO / 前端组件 / 前端页面 的放置规则。 --> diff --git a/skills/skeleton-gen/templates/env-local-template b/skills/skeleton-gen/templates/env-local-template new file mode 100644 index 0000000..c16e67f --- /dev/null +++ b/skills/skeleton-gen/templates/env-local-template @@ -0,0 +1,25 @@ +# .env.local — 本地开发凭据（入 .gitignore，不提交） +# +# 规则： +# 1. 值含 `$`、反引号、空格、`!` 等 shell 特殊字符时，必须用单引号包裹： +# DB_PASSWORD='p@ss$w0rd!' +# 否则 `set -a; . .env.local; set +a` 会做变量展开导致密码错乱。 +# 2. DB_HOST 建议保持 localhost / 127.0.0.1；非本地 host 默认会被 scripts/setup-test-db.sh 防护拒绝。 +# 若必须用远程测试库，把 host 列入下方 TEST_DB_ALLOWED_HOSTS。 +# 3. DB_SCHEMA 建议命名含 test / _dev / _local / _ci，避免与生产库同名。 + +DB_HOST=【人工填写：MySQL host，推荐 localhost】 +DB_PORT=【人工填写：MySQL port，默认 3306】 +DB_USER=【人工填写：开发账号名】 +DB_PASSWORD=【人工填写：对应密码，含特殊字符时用单引号包裹】 +DB_SCHEMA=【人工填写：schema 名，推荐含 test/_dev/_local，例如 erp_dev】 +JWT_SECRET=【人工填写：JWT 签名密钥，256+ bit 随机串】 + +# 可选：额外允许 DROP CREATE 的远程 host（空格或逗号分隔）。仅当 DB_HOST 指向公司测试 MySQL 等 +# 非本地服务器时填写；留空表示只允许 localhost / 127.0.0.1 / ::1。 +# 示例：TEST_DB_ALLOWED_HOSTS="118.178.19.35 test-mysql.internal" +# +# ⚠️ 列入后该 host 每次 test.sh 都会被 DROP CREATE（无二次确认）。 +# 仅用于你完全可控的测试库；生产/共享库/多人共享的 staging 库**千万别列**。 +# （防护 2 还会检查 schema 名须含 test/_dev/_local/_ci，独立兜底。） +TEST_DB_ALLOWED_HOSTS= diff --git a/skills/skeleton-gen/templates/gitignore-append-template b/skills/skeleton-gen/templates/gitignore-append-template new file mode 100644 index 0000000..ac39aa6 --- /dev/null +++ b/skills/skeleton-gen/templates/gitignore-append-template @@ -0,0 +1,32 @@ +# ==== ERP 插件推荐忽略项（skeleton-gen 追加） ==== +# 本地运行时配置（含真实凭据，严禁入库） +.env.local +.env.*.local + +# Java / Maven +target/ +*.class + +# Node / 前端构建产物 +node_modules/ +dist/ +build/ +coverage/ + +# IDE +.idea/ +.vscode/ +*.iml + +# OS +.DS_Store +Thumbs.db + +# 日志 +*.log +logs/ + +# 插件运行时临时文件 +.tmp/ +*.raw +# ==== 结束 ==== diff --git a/skills/skeleton-gen/templates/scripts-setup-test-db-template.mjs b/skills/skeleton-gen/templates/scripts-setup-test-db-template.mjs new file mode 100644 index 0000000..ec56d45 --- /dev/null +++ b/skills/skeleton-gen/templates/scripts-setup-test-db-template.mjs @@ -0,0 +1,126 @@ +#!/usr/bin/env node +// scripts/setup-test-db.mjs — 数据库重置脚本：drop + create 空库。 +// schema apply 由 Flyway 在 Spring Boot 启动时自动处理（见 docs/04 技术栈 + sql/migrations/V*.sql）。 +// seed 数据由测试框架负责（Spring @Sql / Flyway R__seed.sql / data.sql）。 +// +// 使用场景： +// - scripts/test.mjs 开头：清空库，让 Spring 启动时 Flyway 从 V1 开始重放所有 migration +// - scripts/test.mjs 结尾：清空库，避免测试遗留污染下次运行 +// - 手动调试时：reset 到零状态 +// +// 跨平台：用纯 JS 解析 .env.local（dotenv 风格，逐行 KEY=VALUE），**绝不** shell-source， +// 因此 mac / Windows 原生 node 均可运行，且消除 shell 注入 / 变量展开隐患。 +// DROP/CREATE 通过 `mysql` 客户端以 argv 数组方式执行（不经 shell），密码不进命令行解析层。 +// +// 防护：本脚本只允许在本地 host + 测试库名上执行；非预期目标会被拒绝， +// 避免 .env.local 误指向 staging/prod 时触发不可逆 DROP。 + +import { spawnSync } from 'node:child_process' +import { existsSync, readFileSync } from 'node:fs' +import { dirname, join } from 'node:path' +import { fileURLToPath } from 'node:url' + +const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url)) +const ENV_FILE = join(SCRIPT_DIR, '..', '.env.local') + +// dotenv 风格解析：逐行 KEY=VALUE，跳过空行与 # 注释，去除两侧空白， +// 可选地剥离一层成对单/双引号。**不做**变量展开，特殊字符按字面保留。 +function parseEnv(text) { + const env = {} + for (const rawLine of text.split(/\r?\n/)) { + const line = rawLine.trim() + if (line === '' || line.startsWith('#')) continue + const eq = line.indexOf('=') + if (eq === -1) continue + const key = line.slice(0, eq).trim() + if (!key) continue + let value = line.slice(eq + 1).trim() + if ( + value.length >= 2 && + ((value.startsWith("'") && value.endsWith("'")) || + (value.startsWith('"') && value.endsWith('"'))) + ) { + value = value.slice(1, -1) + } + env[key] = value + } + return env +} + +if (!existsSync(ENV_FILE)) { + console.error(`[setup-test-db] .env.local 不存在（${ENV_FILE}）`) + process.exit(1) +} + +const env = parseEnv(readFileSync(ENV_FILE, 'utf8')) + +const DB_HOST = env.DB_HOST ?? '' +const DB_PORT = env.DB_PORT ?? '3306' +const DB_USER = env.DB_USER ?? '' +const DB_PASSWORD = env.DB_PASSWORD ?? '' +const DB_SCHEMA = env.DB_SCHEMA ?? '' +const TEST_DB_ALLOW_REMOTE = env.TEST_DB_ALLOW_REMOTE ?? process.env.TEST_DB_ALLOW_REMOTE ?? '0' +const TEST_DB_ALLOW_PROD_NAME = + env.TEST_DB_ALLOW_PROD_NAME ?? process.env.TEST_DB_ALLOW_PROD_NAME ?? '0' + +// 防护 1：默认只允许本地 host（localhost / 127.0.0.1 / ::1）。 +// 额外允许的远程 host 在 .env.local 的 TEST_DB_ALLOWED_HOSTS 中（空格或逗号分隔）。 +const extraHosts = (env.TEST_DB_ALLOWED_HOSTS ?? '') + .split(/[\s,]+/) + .filter(Boolean) +const allowedHosts = ['localhost', '127.0.0.1', '::1', ...extraHosts] +if (!allowedHosts.includes(DB_HOST)) { + console.error(`[setup-test-db] 拒绝在非白名单 host (${DB_HOST}) 上执行 DROP DATABASE`) + console.error(` 当前白名单：${allowedHosts.join(' ')}`) + console.error(' 加入 host：在 .env.local 追加 TEST_DB_ALLOWED_HOSTS="<host1> <host2>"') + console.error(' 一次性绕过：在 .env.local 设 TEST_DB_ALLOW_REMOTE=1') + if (TEST_DB_ALLOW_REMOTE !== '1') process.exit(1) +} + +// 防护 2：schema 名需像测试/开发库（含 test / _dev / _local / _ci），否则要求显式确认。 +const schemaLooksLikeTest = + /test/.test(DB_SCHEMA) || /_dev$/.test(DB_SCHEMA) || /_local$/.test(DB_SCHEMA) || /_ci$/.test(DB_SCHEMA) +if (!schemaLooksLikeTest) { + console.error( + `[setup-test-db] schema '${DB_SCHEMA}' 不像测试库（期望命名含 test / _dev / _local / _ci）` + ) + console.error(' 如确为期望行为，请显式声明：在 .env.local 设 TEST_DB_ALLOW_PROD_NAME=1') + if (TEST_DB_ALLOW_PROD_NAME !== '1') process.exit(1) +} + +// 防护 3：显式 banner，让人看见自己在 drop 什么；远程 host 额外提示白名单内容。 +console.log(`[setup-test-db] 即将 DROP + CREATE \`${DB_SCHEMA}\` on ${DB_HOST}:${DB_PORT}`) +if (!['localhost', '127.0.0.1', '::1'].includes(DB_HOST)) { + console.log( + '[setup-test-db] 目标是 **远程** host（已在 TEST_DB_ALLOWED_HOSTS 白名单中，每次 test.mjs 都会 DROP）' + ) + console.log(`[setup-test-db] 当前白名单: ${allowedHosts.join(' ')}`) + console.log( + '[setup-test-db] 若不希望每次自动 DROP，从 .env.local 的 TEST_DB_ALLOWED_HOSTS 删掉此 host' + ) +} + +const sql = + `DROP DATABASE IF EXISTS \`${DB_SCHEMA}\`; ` + + `CREATE DATABASE \`${DB_SCHEMA}\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;` + +// 以 argv 数组调用 mysql（不经 shell）：密码不进 shell 解析，跨平台一致。 +const mysqlArgs = [ + `-h${DB_HOST}`, + `-P${DB_PORT}`, + `-u${DB_USER}`, + `-p${DB_PASSWORD}`, + '-e', + sql, +] +const res = spawnSync('mysql', mysqlArgs, { stdio: 'inherit' }) +if (res.error) { + console.error(`[setup-test-db] FATAL: 无法执行 mysql（请确认其在 PATH 中）: ${res.error.message}`) + process.exit(1) +} +if (res.status !== 0) { + console.error(`[setup-test-db] FAIL: mysql exit=${res.status}`) + process.exit(res.status === null ? 1 : res.status) +} + +console.log('[setup-test-db] done — schema will be applied by Flyway when Spring Boot starts') diff --git a/skills/skeleton-gen/templates/scripts-test-template.mjs b/skills/skeleton-gen/templates/scripts-test-template.mjs new file mode 100644 index 0000000..9f0ab8c --- /dev/null +++ b/skills/skeleton-gen/templates/scripts-test-template.mjs @@ -0,0 +1,69 @@ +#!/usr/bin/env node +// scripts/test.mjs —— 合并到默认分支（main / master）前的测试闸门。 +// 顺序：detect → setup-db → build → lint → unit+integration → e2e → reset-db +// 由 coding.mjs 的 test-gate stage（通过子会话）调用。 +// +// 跨平台：所有命令经 child_process.spawnSync(cmd, { shell:true }) 执行， +// 在 Windows 走 cmd.exe，在 *nix 走 /bin/sh，无需 WSL / Git-Bash。 +// 命令字符串来自 docs/04 §零（构建/lint/单测/e2e）——由 skeleton-gen 在 Plan 期填充。 + +import { spawnSync } from 'node:child_process' +import { existsSync } from 'node:fs' +import { dirname, join } from 'node:path' +import { fileURLToPath } from 'node:url' + +const PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..') + +// 在指定子目录下跑一条 shell 命令；非零退出码即终止整个闸门并透传该码。 +function run(label, command, cwd = PROJECT_ROOT) { + console.log(`[test.mjs] ${label}: ${command}`) + const res = spawnSync(command, { cwd, shell: true, stdio: 'inherit' }) + if (res.error) { + console.error(`[test.mjs] FATAL: 无法执行 (${label}): ${res.error.message}`) + process.exit(1) + } + if (res.status !== 0) { + console.error(`[test.mjs] FAIL (${label}) exit=${res.status}`) + process.exit(res.status === null ? 1 : res.status) + } +} + +// Stack detection (runtime, mode-agnostic) +const hasBackend = existsSync(join(PROJECT_ROOT, 'backend')) +const hasFrontend = existsSync(join(PROJECT_ROOT, 'frontend')) +if (!hasBackend && !hasFrontend) { + console.error('[test.mjs] FATAL: neither backend/ nor frontend/ exists') + process.exit(1) +} + +const backendDir = join(PROJECT_ROOT, 'backend') +const frontendDir = join(PROJECT_ROOT, 'frontend') + +console.log('[test.mjs] 1/6 setup test db') +run('setup-test-db', `node ${JSON.stringify(join('scripts', 'setup-test-db.mjs'))}`) + +console.log('[test.mjs] 2/6 build') +if (hasBackend) run('backend build', '{{backend_build}}', backendDir) +else console.log('[test.mjs] skip backend build') +if (hasFrontend) run('frontend build', '{{frontend_build}}', frontendDir) +else console.log('[test.mjs] skip frontend build') + +console.log('[test.mjs] 3/6 lint') +if (hasBackend) run('backend lint', '{{backend_lint}}', backendDir) +else console.log('[test.mjs] skip backend lint') +if (hasFrontend) run('frontend lint', '{{frontend_lint}}', frontendDir) +else console.log('[test.mjs] skip frontend lint') + +console.log('[test.mjs] 4/6 unit + integration') +if (hasBackend) run('backend test', '{{backend_test}}', backendDir) +else console.log('[test.mjs] skip backend test') +if (hasFrontend) run('frontend test', '{{frontend_test}}', frontendDir) +else console.log('[test.mjs] skip frontend test') + +console.log('[test.mjs] 5/6 E2E') +run('e2e', '{{e2e_cmd}}') + +console.log('[test.mjs] 6/6 reset test db') +run('reset-test-db', `node ${JSON.stringify(join('scripts', 'setup-test-db.mjs'))}`) + +console.log('[test.mjs] GREEN') diff --git a/skills/skeleton-gen/templates/styles-tokens-template.css b/skills/skeleton-gen/templates/styles-tokens-template.css new file mode 100644 index 0000000..bc8a542 --- /dev/null +++ b/skills/skeleton-gen/templates/styles-tokens-template.css @@ -0,0 +1,43 @@ +/* + * src/styles/tokens.css — Design Tokens + * 命名规范见 docs/04-技术规范.md § 2.5 + * 色值锁定见 docs/06-UI交互规范.md § 四 + * + * 命名格式：--color-<scope>-<role>-<state> + * <scope> 组件域：form / table-row / table-header / ... + * <role> 作用：bg（背景）/ fg（前景/字体）/ border + * <state> 状态：edit / readonly / hover / selected（无状态时省略） + * + * 约束： + * - 组件样式中只用 var(--color-xxx)，禁止硬编码 hex / rgba + * - 修改色值只改本文件，不允许在组件级覆盖 + * - 新增 token 须先登记到 docs/06 § 4.1 / 4.2，再补到此处 + */ + +:root { + /* === 1. 全局调色板（与 Ant Design 主题对齐） === */ + --color-primary: #1890ff; + --color-success: #52c41a; + --color-warning: #faad14; + --color-error: #ff4d4f; + --color-text: rgba(0, 0, 0, 0.85); + --color-text-secondary: rgba(0, 0, 0, 0.45); + --color-border: #d9d9d9; + --color-bg-base: #f0f2f5; + + /* === 2. 组件级状态色（与 docs/06 § 4.2 一一对应） === */ + + /* form：输入框 / 备注框 / 时间框 / 下拉框共用 */ + --color-form-bg-edit: #ffffff; + --color-form-bg-readonly: #f1f2f8; + --color-form-bg-hover: #f5f5f5; /* 仅下拉框使用 */ + --color-form-fg: #000000; + + /* table */ + --color-table-row-bg-selected: #86d5fb; + --color-table-row-bg-hover: #fff7e6; + --color-table-row-bg-readonly: #f1f2f8; /* = rgb(241, 242, 248) */ + --color-table-row-fg: #000000; + --color-table-header-bg: #f5f5f5; + --color-table-header-fg: rgba(0, 0, 0, 0.85); /* = #000000D9 */ +} -- libgit2 0.22.2