SKILL.md 8.88 KB

name: skeleton-gen description: A2 骨架生成——基于 docs/04 § 零 技术栈 + docs/01-需求清单/index.md 模块索引,生成项目专属的架构文档(docs/04 § 一+、docs/06、docs/07、docs/09)和工具脚本(.mjs,跨平台)。固定工具文件用 Read/Write 落盘,架构文档由 LLM 按大纲生成。 user-invocable: false

allowed-tools: Read Write Edit Skill Grep Glob AskUserQuestion Bash(node *)

所有输出必须使用中文。

skeleton-gen

执行步骤

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(§ 一 ~ 三;FE 决策表由 A6 frontend-scope-lock 追加到 § 三之后) ${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/07 只记规则,不记具体配置值:端口 / 包名 / 库名 / 初始账号等真实值在 config-vars.yaml(A1 scope-lock 已锁)与 .env.local(敏感)里,docs/07 只写命名约定、端口约定、安全规则,并指向这两个文件。

项目专属标识(根包名 / 命名空间)保留 【人工填写:<说明>】 占位,等人工在 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

完成后,用 Editdocs/08-模块任务管理.md 中勾选:

  • - [ ] 架构文档已生成(docs/04 § 一+、docs/06、docs/07、docs/09)

C. 生成工具脚本

C.1 复制固定模板文件(用 Read + Write,跨平台无 shell)

对下表每个文件:用 Read 读模板内容,用 Write 原样写到目标路径(Write 会自动创建缺失的父目录,无需 mkdir)。.gitkeepWrite 写空文件。

模板 目标路径
${CLAUDE_SKILL_DIR}/templates/env-local-template .env.local
${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.mjs scripts/setup-test-db.mjs
${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css src/styles/tokens.css
(空文件) sql/migrations/.gitkeep

.env.local 须与 config-vars.yamlsecrets_ref 对齐:写完 .env.local 后用 Read 读仓库根 config-vars.yamlsecrets_ref 列表,逐个核对键名。env-local-template 已含 DB_* / JWT_SECRETsecrets_ref 里其余项目专属键(如 REDIS_PASSWORD / ADMIN_INIT_PASSWORD / 第三方凭证)用 Edit 追加到 .env.local,值统一为 【人工填写:<说明>】

C.2 渲染 scripts/test.mjs

Read 读取 ${CLAUDE_SKILL_DIR}/templates/scripts-test-template.mjs,基于步骤 A 的技术栈(docs/04 § 零)为 7 个占位推断命令后用 Write 写到 scripts/test.mjs

  • {{backend_build}} / {{backend_lint}} / {{backend_test}} 后端各 stage 命令
  • {{frontend_build}} / {{frontend_lint}} / {{frontend_test}} 前端各 stage 命令
  • {{e2e_cmd}} E2E(无 E2E 工具则填 echo "[test.mjs] e2e 略"

占位是普通 shell 命令字符串,模板在运行期用 spawnSync(cmd, { shell:true }) 跨平台执行(Windows 走 cmd.exe,*nix 走 /bin/sh),缺席 stack 由模板内的 existsSync('backend') / existsSync('frontend') 守卫跳过。 推断规则:根据 docs/04 § 零

  • 「后端*」存在 → 据后端技术栈推 backend 三槽(build / lint / test 命令)
  • 「前端*」存在 → 据前端技术栈推 frontend 三槽
  • 缺席 stack → 三槽全填 echo skip(该 stack 目录不存在时模板不会执行,但占位须为合法命令)
  • {{e2e_cmd}} 通常仅前端,按上述前端规则或填 echo "[test.mjs] e2e 略"

表结构异常(列名变更 / 无中文前缀)时停下,用 AskUserQuestion 让用户显式确认每 stack 命令。

注:生成的 scripts/*.mjsnode 直接执行,无需 chmod +x(跨平台无文件权限位概念)。

完成后,用 Editdocs/08-模块任务管理.md 中勾选:

  • - [ ] 工具脚本已生成(scripts/*.mjs、.env.local)
  • - [ ] 样式 token 骨架已生成(src/styles/tokens.css)

D. 追加 .gitignore 忽略项

${CLAUDE_PLUGIN_ROOT}/lib/merge-gitignore.mjs(跨平台纯 Node,逐行判重并集合并,把 append 模板内容并入项目 .gitignore,原地写回第一个参数):

node "${CLAUDE_PLUGIN_ROOT}/lib/merge-gitignore.mjs" .gitignore "${CLAUDE_SKILL_DIR}/templates/gitignore-append-template"

.gitignore 不存在时先用 Write 建一个空文件再调用(merge-gitignore.mjs 的第一个参数须可读)。

完成后,用 Editdocs/08-模块任务管理.md 中勾选:

  • - [ ] .gitignore 已配置

E. 占位符补填 + QA 闸门

E.1 扫描 + 分组

Grep 在以下路径扫 【人工填写:,记录命中(文件 / 行号 / 说明):

  • docs/04-技术规范.md / docs/06-UI交互规范.md / docs/07-环境配置.md / docs/09-项目目录结构.md
  • config-vars.yaml(A1 留下的未推断字段,如包名 / 端口)
  • scripts/*.mjs / .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 重新扫 E.1 全部路径,0 命中 (b) 用户 AskUserQuestion 选「继续」

每次弹 QA 前重扫;有残留则打印残留位置清单(文件:行号 — 说明)+ 再弹 QA。

QA 横幅涵盖:产出文件清单(docs/04 / 06 / 07 / 09 + config-vars.yaml + scripts/*.mjs + .env.local + .gitignore)、占位状态(N=0 或待填清单)、「继续」/「有疑问先沟通」两选项。

通过后(N=0 且用户选「继续」),用 Editdocs/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.mjs(推断命令填充 7 槽:backend/frontend × build/lint/test + e2e;缺席 stack 填 echo skip
  • ${CLAUDE_SKILL_DIR}/templates/scripts-setup-test-db-template.mjs(0 槽位,跨平台 .env.local 解析 + DROP/CREATE)
  • ${CLAUDE_SKILL_DIR}/templates/env-local-template(0 槽位;C.1 据 config-vars.yamlsecrets_ref 追加项目专属 secret 键)
  • config-vars.yaml(A1 scope-lock 输出,仓库根;C.1 读其 secrets_ref 对齐 .env.local,E.1 扫其残留 【人工填写:
  • ${CLAUDE_SKILL_DIR}/templates/gitignore-append-template(0 槽位)
  • ${CLAUDE_SKILL_DIR}/templates/styles-tokens-template.css(0 槽位,样式 token 骨架)
  • ${CLAUDE_PLUGIN_ROOT}/lib/merge-gitignore.mjs(.gitignore 逐行判重并集合并,跨平台纯 Node)