From 9b8f6a2d7f49c37266bea53a4069ff122e37d366 Mon Sep 17 00:00:00 2001 From: zichun Date: Fri, 29 May 2026 14:43:27 +0800 Subject: [PATCH] remove docs/07 — env config folded into config-vars.yaml + docs/04 --- README.md | 3 +-- skills/plan/plan-start/SKILL.md | 2 +- skills/plan/project-init/templates/docs-08-initial-template.md | 2 +- skills/plan/scope-lock/templates/config-vars-template.yaml | 2 ++ skills/plan/skeleton-gen/SKILL.md | 23 ++++++++++------------- skills/plan/skeleton-gen/templates/docs-07-env-template.md | 20 -------------------- 6 files changed, 15 insertions(+), 37 deletions(-) delete mode 100644 skills/plan/skeleton-gen/templates/docs-07-env-template.md diff --git a/README.md b/README.md index 8033e81..0eabebc 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ erp-workflow-plugin/ |---|---|---|---| | A0 | `project-init` | • **依赖检查**：检测 git / mysql / node 是否在 PATH，缺失则按 OS 自动安装，装不上再停下提示用户
• 空目录初始化：用 Read/Write/Glob 工具拷模板创建 CLAUDE.md / docs/01/index.md / docs/08
• `git init` | `plan-start` | | A1 | `scope-lock` | • 引导填项目概述 / 技术栈 / 需求索引
• 按 `docs/01-需求清单//{_module.md, REQ-*.md}` 子目录结构生成 REQ 卡片（CC 据 index.md 填 `{{req_id/title/goal/rules/constraints/acceptance}}` 6 个占位，模板其余内容含输入/输出示例字段表原样复制）
• **A1 终结校验**：REQ 6 个占位均填真实数据、无 `{{` 残留、`config-vars.yaml` **全部配置**（包名 / 端口 / 初始账号 + DB 凭据 / 密钥占位）已锁、各 stack 的 build/lint/unit/e2e 命令写入 docs/04 § 零；缺失则在此（Plan 期）用 `AskUserQuestion` 问清（敏感凭据由用户自填，不进会话）
• 据模板直接 `Write` 生成 `_module.md` / `REQ-*.md`
• 终结校验通过后**自动**调用 `Skill(skeleton-gen)` 进入 A2（不停下） | A0 | -| A2 | `skeleton-gen` | • 生成架构文档：docs/04 § 一+ / docs/07
• 生成跨平台工具脚本：`scripts/*.mjs`（**无 chmod**；凭据 / 配置统一在 A1 产出的 config-vars.yaml）
• 据 `gitignore-append-template` 用 Read/Write 并入项目 .gitignore | `plan-start` | +| A2 | `skeleton-gen` | • 生成架构文档：docs/04 § 一+
• 生成跨平台工具脚本：`scripts/*.mjs`（**无 chmod**；凭据 / 配置统一在 A1 产出的 config-vars.yaml）
• 据 `gitignore-append-template` 用 Read/Write 并入项目 .gitignore | `plan-start` | | A3 | `db-design-gen` | • A3 起始用 `AskUserQuestion` 确认 ERP 约定（主键策略 / 租户列 / 列前缀规则，默认值可覆盖），结果写 docs/04 + CLAUDE.md
• 从 docs/01 REQ 卡片正向设计 `docs/03-数据库设计文档.md`（schema SSoT）
• 回填 REQ 卡片依赖表（`TBD(A3 自动补)` → 实际表名）
• **停下**等人工审阅 docs/03，审阅完毕用 `/plan-start` 续进 A4 | A2 | | A4 | `db-init` | • LLM 解析 docs/03 → `sql/migrations/V1__initial_schema.sql`（DDL only）
• `node ${CLAUDE_PLUGIN_ROOT}/lib/validate-ddl.mjs` 校验 DDL ↔ docs/03（5 维：表/列名/列类型/索引/FK），fail-closed
• `node ${CLAUDE_PLUGIN_ROOT}/lib/apply-ddl.mjs config-vars.yaml V1.sql`（解析 config-vars.yaml database: 段 + mysql2 apply，**无 shell-source**） | A3 | | A5 | `downstream-gen` | • 一次性生成 docs/02 / docs/05 / docs/10
• 回填 REQ 卡片依赖接口（`TBD(A5 自动补)` → 实际 endpoint）
• 追加模块清单到 docs/08 § 二
• **docs/05 + docs/02 评审闸**：用 `AskUserQuestion` 让用户确认 API 端点/字段无误 + 构建顺序可接受，未确认不勾 A5
• **prototype/ 门禁 + 推导 FE 清单写 docs/08 § 三**（原 A6 已并入；无 prototype 则问「无前端」→ § 三 留空）
• 最终占位符 + 结构残留扫描 | A4 | @@ -147,7 +147,6 @@ erp-workflow-plugin/ | scope-lock | `_module-template.md` | 模块子目录的 `_module.md` 模块头（模块代码-名 / 简述 / 依赖模块 TBD / 涉及表 TBD） | | scope-lock | `config-vars-template.yaml` | 仓库根 `config-vars.yaml` 骨架（跨栈中立）：项目**全部配置**——非敏感（包名/端口/前端包名/初始账号）+ 敏感凭据（database / admin_init.password / secrets）；A1 E.2 锁定，随项目提交 | | skeleton-gen | `docs-04-skeleton-template.md` | docs/04 § 一+ 编码规范大纲（HTML 注释引导 LLM） | -| skeleton-gen | `docs-07-env-template.md` | docs/07 环境配置大纲（只记规则/约定，不记具体值；配置值统一指向 config-vars.yaml） | | skeleton-gen | `scripts-setup-test-db-template.mjs` | 跨平台 drop + create 空库脚本（内联极简 YAML 读 config-vars.yaml database: 段，无 shell-source）；schema apply 交给 Flyway | | skeleton-gen | `scripts-test-template.mjs` | test.mjs 骨架（命令槽位按后端/前端/build/lint/test/e2e 分开，`spawnSync(shell:true)` 跨平台执行） | | skeleton-gen | `gitignore-append-template` | 插件推荐忽略项（`.tmp/`、构建产物等；config-vars.yaml 随项目提交，不忽略） | diff --git a/skills/plan/plan-start/SKILL.md b/skills/plan/plan-start/SKILL.md index 1562f76..1885096 100644 --- a/skills/plan/plan-start/SKILL.md +++ b/skills/plan/plan-start/SKILL.md @@ -50,7 +50,7 @@ A 阶段 checkbox 全部 `[x]` 后先跑下面 4 项前移闸门; 全过才放 2. **全部配置全锁**（来自 A1 写入 `config-vars.yaml` 的非敏感配置 + 敏感凭据，单一文件） - `Read` `config-vars.yaml`（项目全部配置，含敏感凭据，随项目提交）：校验所有字段均有真实值，无 `【人工填写`/`TBD`/空值——含非敏感项（`backend`/`frontend` 包名 / 端口、`admin_init.username`、`database.host/port/user/schema`）与敏感项（`database.password`、`admin_init.password`、`secrets.*`）。 - - 任一未填即缺口。（docs/07-环境配置.md 仅承载规则/约定，不参与值校验。） + - 任一未填即缺口。 3. **docs/04 §零 命令齐**（来自 A1 收集的每栈构建/lint/单测/e2e 命令） - `Read` `docs/04-技术规范.md`，定位 `§ 零` 命令区。 diff --git a/skills/plan/project-init/templates/docs-08-initial-template.md b/skills/plan/project-init/templates/docs-08-initial-template.md index 309dad0..56c5b16 100644 --- a/skills/plan/project-init/templates/docs-08-initial-template.md +++ b/skills/plan/project-init/templates/docs-08-initial-template.md @@ -16,7 +16,7 @@ - [ ] REQ 卡片骨架已生成（docs/01-需求清单//REQ-*.md，业务内容留待人工填写） - [ ] A2 骨架生成 — skeleton-gen - - [ ] 架构文档已生成（docs/04 § 一+、docs/07） + - [ ] 架构文档已生成（docs/04 § 一+） - [ ] 工具脚本已生成（scripts/*.mjs） - [ ] 样式 token 骨架已生成（src/styles/tokens.css） - [ ] .gitignore 已配置 diff --git a/skills/plan/scope-lock/templates/config-vars-template.yaml b/skills/plan/scope-lock/templates/config-vars-template.yaml index 75ba973..2d181d6 100644 --- a/skills/plan/scope-lock/templates/config-vars-template.yaml +++ b/skills/plan/scope-lock/templates/config-vars-template.yaml @@ -1,6 +1,8 @@ # config-vars.yaml — 项目全部配置（含敏感凭据）。随项目提交，内部 git 传播。 # 工具脚本（apply-ddl / setup-test-db）运行时按 2 层 map 解析此文件。 # 值含 : / # / 空格 / $ / 引号等特殊字符时，用单引号包裹整个值：password: 'p@ss: w0rd#1' +# 所有配置值（含敏感值）只在本文件，不得散落到 docs / 源码 / 日志。 +# base_package / 命名空间锁定后全项目复用，不各模块各写。 backend: base_package: com.xly.erp diff --git a/skills/plan/skeleton-gen/SKILL.md b/skills/plan/skeleton-gen/SKILL.md index 33d5f76..4d428af 100644 --- a/skills/plan/skeleton-gen/SKILL.md +++ b/skills/plan/skeleton-gen/SKILL.md @@ -1,6 +1,6 @@ --- name: skeleton-gen -description: A2 骨架生成——基于 docs/04 § 零 技术栈 + docs/01-需求清单/index.md 模块索引，生成项目专属的架构文档（docs/04 § 一+、docs/07）和工具脚本（.mjs，跨平台）。固定工具文件用 Read/Write 落盘，架构文档由 LLM 按大纲生成。 +description: A2 骨架生成——基于 docs/04 § 零 技术栈 + docs/01-需求清单/index.md 模块索引，生成项目专属的架构文档（docs/04 § 一+）和工具脚本（.mjs，跨平台）。固定工具文件用 Read/Write 落盘，架构文档由 LLM 按大纲生成。 user-invocable: false allowed-tools: Read Write Edit Skill Grep Glob AskUserQuestion --- @@ -18,24 +18,22 @@ allowed-tools: Read Write Edit Skill Grep Glob AskUserQuestion 后续所有内容都基于它们推导。 -### B.1 生成 docs/07 环境配置 +### B. 追加 docs/04 § 一+（架构文档；保留 § 零 不覆盖） -读取 `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md`，基于步骤 A 的输入按大纲生成项目专属内容（剥掉 HTML 注释——注释是给 LLM 的提示，不应出现在最终文档里），`Write` 到 `docs/07-环境配置.md`。 - -> **项目目录布局不单独出文档**（原 docs/09 已并入）：后端/前端目录布局写进 **docs/04 § 1.2 分层结构 / § 2.1 目录约定**（见 B.2）；跨模块「路径→模块」由 docs/08 § 二 模块行的 `路径:` 字段承担。 -> **前端 UI/交互/布局不出文档**：项目根 `prototype/` 是完整前端 demo（页面 + 布局 + 交互的权威）；Design Tokens 在 `src/styles/tokens.css`（**色值冲突时 tokens.css 优先于 prototype**）；前端编码规范在 docs/04 § 二。 - -### B.2 追加 docs/04 § 一+（保留 § 零 不覆盖） - -docs/04 已由 scope-lock 写入 § 零。本步骤追加 § 一 ~ 三。 +docs/04 已由 scope-lock 写入 § 零。本步骤追加 § 一 ~ 三： 1. 读取 `docs/04-技术规范.md`（现有 § 零 完整内容）。 2. 读取 `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md`。 3. 基于技术栈，按大纲生成 § 一 ~ 三 的项目专属内容，剥掉 HTML 注释。**§ 1.2 分层结构 / § 2.1 目录约定要写清后端/前端的实际目录布局**（原 docs/09 内容并入此处，供 Coding 阶段落盘 + 跨模块判定参照）。 4. 拼接原有内容和新生成内容，写回 `docs/04-技术规范.md`。 +> **A2 不再单独出 docs/06 / 07 / 09**——它们的内容各有归属： +> - 环境 / 配置值（含凭据） → `config-vars.yaml`（A1 产出）；构建 / 测试命令 → docs/04 § 零。 +> - 项目目录布局 → docs/04 § 1.2 分层结构 / § 2.1 目录约定；跨模块「路径→模块」→ docs/08 § 二 模块行 `路径:`。 +> - 前端 UI / 交互 / 布局 → 项目根 `prototype/`（完整 demo，权威）；Design Tokens → `src/styles/tokens.css`（**色值冲突时 tokens.css 优先于 prototype**）；前端编码规范 → docs/04 § 二。 + 完成后，用 `Edit` 在 `docs/08-模块任务管理.md` 中勾选： -- ` - [ ] 架构文档已生成（docs/04 § 一+、docs/07）` +- ` - [ ] 架构文档已生成（docs/04 § 一+）` ### C. 生成工具脚本 @@ -81,7 +79,7 @@ docs/04 已由 scope-lock 写入 § 零。本步骤追加 § 一 ~ 三。 #### E.1 扫描 + 分组 用 `Grep` 在以下路径扫 `【人工填写：`，记录命中（文件 / 行号 / 说明）： -- `docs/04-技术规范.md` / `docs/07-环境配置.md` +- `docs/04-技术规范.md` - `config-vars.yaml`（A1 留下的未填字段） - `scripts/*.mjs` / `.gitignore` @@ -122,7 +120,6 @@ QA 横幅涵盖：产出文件清单（docs/04 / 07 + scripts/*.mjs + .gitignore - `docs/04-技术规范.md` § 零 - `docs/01-需求清单/index.md` - `${CLAUDE_SKILL_DIR}/templates/docs-04-skeleton-template.md` -- `${CLAUDE_SKILL_DIR}/templates/docs-07-env-template.md` - `${CLAUDE_SKILL_DIR}/templates/scripts-test-template.mjs` - `${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.mjs` - `config-vars.yaml`（A1 产出，含 DB 凭据；setup-test-db.mjs 运行时读取） 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 b187012..0000000 --- a/skills/plan/skeleton-gen/templates/docs-07-env-template.md +++ /dev/null @@ -1,20 +0,0 @@ -# 07-环境配置 - -## 一、依赖清单 - -## 二、端口约定 - -## 三、配置与凭据规则 - -项目**全部配置**（含敏感凭据）统一存放在仓库根 `config-vars.yaml`，结构化 YAML，随项目提交（内部 git 传播）。**本文档只记规则、不记具体值**： - -- **非敏感、项目级配置**（根包名 / 命名空间、应用端口、前端包名、管理员初始账号等）→ `config-vars.yaml` 对应段。 -- **敏感凭据**（数据库密码、JWT / 签名密钥、Redis 密码、第三方 key/secret、管理员初始密码等）→ `config-vars.yaml` 的 `database` / `admin_init.password` / `secrets` 段，直接填真实值。 - -规则： -- 根包名 / 命名空间一经在 `config-vars.yaml` 锁定，全项目复用，不得各模块各写。 -- 端口遵循 § 二 约定；调整时改 `config-vars.yaml`，本文档不写具体端口。 -- 任何配置值（含敏感值）只允许出现在 `config-vars.yaml`，不得散落在 docs、源码或日志中。 -- 工具脚本（apply-ddl / setup-test-db）运行时按 2 层 map 解析 `config-vars.yaml`；值含特殊字符时用单引号包裹。 - -## 四、常用命令 -- libgit2 0.22.2