@agile-team/wl-skills-kit 2.3.7 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/CHANGELOG.md +495 -404
  2. package/README.md +286 -261
  3. package/bin/wl-skills.js +796 -503
  4. package/docs/ai/345/205/250/346/231/257/345/210/206/346/236/220.md +144 -0
  5. package/docs/input-spec-api.md +263 -0
  6. package/docs/input-spec-detailed-design.md +238 -0
  7. package/docs/input-spec-page-spec.md +371 -0
  8. package/docs/input-spec-prototype.md +176 -0
  9. package/docs//345/205/250/347/233/230/345/210/206/346/236/220/344/270/216/346/231/272/350/203/275/344/275/223/346/220/255/345/273/272/346/214/207/345/215/227.md +267 -0
  10. package/files/.github/copilot-instructions.md +3 -3
  11. package/files/.github/guides/architecture.md +11 -11
  12. package/files/.github/guides/usage.md +5 -4
  13. package/files/.github/skills/_compat/headers/cursor-mdc.txt +1 -1
  14. package/files/.github/skills/_compat/headers/kiro.txt +1 -1
  15. package/files/.github/skills/_compat/headers/trae.txt +1 -1
  16. package/files/.github/skills/_pipeline.md +91 -0
  17. package/files/.github/skills/_registry.md +4 -2
  18. package/files/.github/skills/core/convention-audit/SKILL.md +241 -65
  19. package/files/.github/skills/core/page-codegen/SKILL.md +3 -3
  20. package/files/.github/skills/core/page-codegen/USAGE.md +1 -1
  21. package/files/.github/skills/core/page-codegen/templates/domains/_CONTRIBUTING.md +1 -1
  22. package/files/.github/skills/core/template-extract/SKILL.md +1 -1
  23. package/files/.github/skills/sync/env.local.json +20 -18
  24. package/files/.github/standards/02-code-structure.md +34 -4
  25. package/files/.github/standards/08-git.md +24 -0
  26. package/files/.github/standards/12-base-table.md +44 -0
  27. package/files/.github/standards/index.md +2 -2
  28. package/mcp/server.js +411 -330
  29. package/mcp/tools/projectTools.js +228 -0
  30. package/package.json +40 -39
package/README.md CHANGED
@@ -1,261 +1,286 @@
1
- # @agile-team/wl-skills-kit
2
-
3
- **AI Skill 模板包 v2.3** — 一条命令将 13 条编码规范、8 个 AI Skill、组件文档、领域样例导入 Vue 3 项目。
4
-
5
- 让 AI 编辑器(Copilot / Cursor / Windsurf / Claude Code / Cline / Kiro / Trae / Qoder / 通用 Agents)**真正理解项目规范**,从原型/详设到完整页面代码全流程自动化。
6
-
7
- ---
8
-
9
- ## TL;DR
10
-
11
- ```bash
12
- npx @robot-admin/git-standards init # 工程化前置(必须)
13
- npx @agile-team/wl-skills-kit # 安装 AI 体系
14
- # 在 AI 对话中:
15
- "扫描 docs/prototypes/ 下的原型生成页面清单"
16
- "基于上一步生成所有 api.md,再 codegen 出页面"
17
- ```
18
-
19
- ---
20
-
21
- ## 这个包到底干什么?
22
-
23
- ```
24
- 原型/口述需求
25
-
26
- ▼ [Skill: prototype-scan] ← 可跳过(直接口述需求时)
27
- 《页面清单》(reports/PROTOTYPE_SCAN_*.md)
28
-
29
- ▼ [Skill: api-contract]
30
- api.md(页面级前后端契约)
31
-
32
- ▼ [Skill: page-codegen]
33
- data.ts + index.vue + index.scss(13 条 standards 自动满足)
34
-
35
- ▼ [Skill: convention-audit] ← 也可对存量代码单独触发
36
- reports/AUDIT_AI_*.md + AUDIT_HUMAN_*.md
37
-
38
- ├─▶ [Skill: menu-sync] ← 可单独运行
39
- │ 线上菜单注册完毕,UI 可访问
40
-
41
- └─▶ [Skill: dict-sync] ← 可单独运行,与 menu-sync 互不依赖
42
- 线上字典同步完毕
43
- ```
44
-
45
- > **灵活组合原则**:每个 Skill 都可以单独触发,也可以串联使用。哪一步结果不满意,重跑哪步即可,不需要从头来过。
46
-
47
- ---
48
-
49
- ## ⚠️ 仓库结构 vs 业务项目安装结构(**必看**)
50
-
51
- `wl-skills-kit` 是一个 **npm 模板包**:仓库本身的结构 ≠ 你 `npx` 之后业务项目里看到的结构。两者**严格区分**:
52
-
53
- ### A. 本仓库结构(开发/维护 wl-skills-kit 时)
54
-
55
- ```
56
- wl-skills-kit/ ← 你正看的这个仓库
57
- ├── README.md 本文档(业务方 + 维护者都看)
58
- ├── CHANGELOG.md
59
- ├── package.json name: @agile-team/wl-skills-kit
60
-
61
- ├── bin/
62
- │ └── wl-skills.js CLI 实现(init / update / clean)
63
-
64
- ├── files/ ★★★ 真正会被打包并复制到业务项目的内容 ★★★
65
- │ └── .github/
66
- │ ├── copilot-instructions.md 源 AI 主入口(编辑这里,不要编辑业务项目里的副本)
67
- │ ├── standards/ 13 条规范
68
- │ ├── skills/ Skill 目录(含 _compat/ 多编辑器适配源)
69
- │ ├── guides/ 人读指南
70
- │ └── reports/ 领域基线模板(菜单/字典/权限)
71
- │ ├── docs/ 组件 API 文档
72
- │ └── demo/ 领域样例
73
-
74
- ├── kit-internal/ ★★ 仅仓库可见,不会安装到业务项目 ★★
75
- │ ├── README.md 维护者首页
76
- │ ├── architecture.md 架构总览
77
- │ ├── CONTRIBUTING.md 贡献流程
78
- │ ├── standards.MAINTAIN.md standards 维护要点
79
- │ ├── templates.MAINTAIN.md templates 维护要点
80
- │ ├── jenkins-pipeline.md Jenkins CI 参考模板(不强加业务项目)
81
- │ ├── skills/ 各 Skill 的 *.MAINTAIN.md
82
- │ └── history/ 归档:旧版 ARCHITECTURE-PLAN 等
83
-
84
- └── .npmignore 排除 kit-internal/ 等不发布的内容
85
- ```
86
-
87
- > **维护准则**:
88
- > - 业务规范要改 → 改 `files/.github/standards/*.md`
89
- > - Skill 流程要改 → 改 `files/.github/skills/<scope>/<name>/SKILL.md`
90
- > - 多 AI 编辑器适配要改 → 改 `files/.github/skills/_compat/`(**不是**改业务项目里的根配置文件)
91
- > - 维护文档要写 → 进 `kit-internal/`(不会污染业务项目)
92
-
93
- ### B. 业务项目结构(执行 `npx @agile-team/wl-skills-kit` 之后)
94
-
95
- ```
96
- 你的业务项目/
97
-
98
- ├── .github/ ← 来自本包 files/.github/
99
- │ ├── copilot-instructions.md Copilot 主入口(精简 ~320 行)
100
- │ ├── standards/ 13 条模块化规范 + index.md 门控
101
- │ │ ├── 01-toolchain.md
102
- │ │ ├── 02-code-structure.md
103
- │ │ ├── ... (共 13 条)
104
- │ │ └── 13-platform-components.md
105
- │ ├── skills/ 9 个启用 Skill(全部激活)
106
- │ │ ├── _registry.md ★ 触发词 → SKILL 路径单一数据源
107
- │ │ ├── _compat/ 多 AI 编辑器适配(配置 + headers)
108
- │ │ ├── core/ 核心通用 Skill
109
- │ │ │ ├── prototype-scan/ { SKILL.md, USAGE.md }
110
- │ │ │ ├── api-contract/ { SKILL.md, USAGE.md }
111
- │ │ │ ├── page-codegen/ { SKILL.md, USAGE.md, templates/ }
112
- │ │ │ ├── convention-audit/ { SKILL.md, USAGE.md }
113
- │ │ │ └── template-extract/ { SKILL.md, USAGE.md }
114
- │ │ ├── sync/ 数据同步类
115
- │ │ │ ├── menu-sync/ { SKILL.md, USAGE.md, env/ }
116
- │ │ │ ├── dict-sync/ { SKILL.md } 已启用
117
- │ │ │ └── permission-sync/ { SKILL.md, USAGE.md } 已启用(角色+授权+动作+v-permission)
118
- │ │ ├── ops/ 运维类
119
- │ │ │ └── code-fix/ { SKILL.md } 已启用
120
- │ │ └── domain/ 领域专属(按需创建)
121
- │ ├── guides/ 人读指南(usage.md / architecture.md)
122
- │ └── reports/ AI 生成报告(追加不覆盖)
123
- │ ├── SYS_MENU_INFO.md 线上菜单基线
124
- │ ├── SYS_DICT_INFO.md 线上字典基线
125
- │ ├── SYS_PERMISSION_INFO.md 线上权限基线
126
- │ └── AUDIT_*.md / PAGE_CODEGEN_*.md / ... (随用随生成)
127
-
128
- ├── 多 AI 编辑器配置(解耦:可单独删除任意一个不影响其他)
129
- ├── CLAUDE.md Claude Code
130
- ├── AGENTS.md 通用 Agents
131
- ├── .cursorrules Cursor 旧版
132
- ├── .cursor/rules/conventions.mdc Cursor 新版(含 mdc frontmatter)
133
- ├── .windsurfrules Windsurf
134
- ├── .clinerules Cline
135
- ├── .kiro/steering/conventions.md Kiro(含 inclusion frontmatter)
136
- ├── .trae/rules/conventions.md Trae(含 alwaysApply frontmatter)
137
-
138
- ├── docs/ 12 个组件 API 文档
139
- ├── demo/ 13 个领域样例
140
- └── src/
141
- ├── components/ 全局/局部/远程组件
142
- └── types/ 类型桶文件
143
- ```
144
-
145
- > **业务项目方准则**:
146
- > - 主入口是 `.github/copilot-instructions.md`(Copilot 用),**其他 9 个根配置文件是它的拷贝 + 各自特化 frontmatter**
147
- > - 修改规范 → **不要**改业务项目里的副本,**升级 wl-skills-kit 包 + `update`** 才不会被覆盖
148
- > - reports/ 里的内容是团队累积数据,`update` 不会覆盖,可放心 commit
149
-
150
- ---
151
-
152
- ## CLI 命令
153
-
154
- ```bash
155
- # 全量安装(默认)
156
- npx @agile-team/wl-skills-kit
157
-
158
- # 增量更新(仅覆盖有变化的文件,自动保护 reports/)
159
- npx @agile-team/wl-skills-kit update
160
-
161
- # 构建前清理(保留 src/components + src/types
162
- npx @agile-team/wl-skills-kit clean
163
-
164
- # 清理但保留 reports/(菜单/字典/权限累积数据)
165
- npx @agile-team/wl-skills-kit clean --keep-reports
166
-
167
- # 任何命令都可加 --dry-run 预览
168
- npx @agile-team/wl-skills-kit update --dry-run
169
- ```
170
-
171
- > 全局安装后也可直接用 `wl-skills` 命令(如 `wl-skills update`)。
172
-
173
- ---
174
-
175
- ## 从早期版本升级
176
-
177
- > **适用场景**:已安装 v1.x 或 v2.0 的业务项目,希望升级到当前版本。
178
-
179
- ```bash
180
- # 执行增量更新即可
181
- npx @agile-team/wl-skills-kit update
182
- ```
183
-
184
- `update` 命令会自动完成:
185
- 1. **写入新文件** — 新结构下的所有文件覆盖写入
186
- 2. **迁移清理** — 检测并移除旧版遗留文件(如 `skills/prototype-scan/`、`docs/menu-sync-design.md` 等),避免新旧路径并存产生歧义
187
- 3. **保护累积数据** `reports/*.md` 已存在则跳过,团队累积的菜单/字典数据不丢失
188
-
189
- > **注意**:如果项目在旧的 `.github/skills/menu-sync/env/env.local.json` 中有自定义配置,`update` 会将其迁移位置(删旧、新路径文件由 `init` 写入默认模板)。**请在 `update` 前备份** 或 `update` 后手动迁移到 `.github/skills/sync/menu-sync/env/env.local.json`。
190
-
191
- ---
192
-
193
- ## Skill 概览
194
-
195
- | Skill | 状态 | 路径 | 核心用途 |
196
- | ------------------ | --------- | ---------------------------------------- | ----------------------------- |
197
- | `prototype-scan` | ✅ 启用 | `skills/core/prototype-scan/` | 原型/详设/口述 → 页面清单 |
198
- | `api-contract` | ✅ 启用 | `skills/core/api-contract/` | 生成 api.md 前后端契约 |
199
- | `page-codegen` | ✅ 启用 | `skills/core/page-codegen/` | 4 文件骨架生成 + 模板调度 |
200
- | `convention-audit` | ✅ 启用 | `skills/core/convention-audit/` | 13 条规范扫描 + 双报告 |
201
- | `template-extract` | ✅ 启用 | `skills/core/template-extract/` | 现有页面 → 领域模板 |
202
- | `menu-sync` | 启用 | `skills/sync/menu-sync/` | 菜单基线 ↔ 后端接口 |
203
- | `dict-sync` | ✅ 启用 | `skills/sync/dict-sync/` | 字典基线 ↔ 后端接口 |
204
- | `permission-sync` | ✅ 启用 | `skills/sync/permission-sync/` | 角色管理 + 角色授权 + 挂动作 + v-permission |
205
- | `code-fix` | ✅ 启用 | `skills/ops/code-fix/` | 受控自动修复偏差 |
206
-
207
- 每个启用 Skill 同目录都有 **`SKILL.md`(AI 触发用)+ `USAGE.md`(团队成员阅读)**。
208
-
209
- ---
210
-
211
- ## AI 编辑器适配(解耦设计)
212
-
213
- `init` / `update` 读取 `files/.github/skills/_compat/editors.json` 生成对应配置:
214
-
215
- | 编辑器 | 输出路径 | Frontmatter |
216
- | -------------- | ----------------------------------- | ----------------------- |
217
- | GitHub Copilot | `.github/copilot-instructions.md` | - |
218
- | Claude Code | `CLAUDE.md` | - |
219
- | Cursor (rules) | `.cursorrules` | - |
220
- | Cursor (mdc) | `.cursor/rules/conventions.mdc` | description+globs+alwaysApply |
221
- | Windsurf | `.windsurfrules` | - |
222
- | Cline | `.clinerules` | - |
223
- | Kiro | `.kiro/steering/conventions.md` | inclusion: always |
224
- | Trae | `.trae/rules/conventions.md` | description+globs+alwaysApply |
225
- | 通用 Agent | `AGENTS.md` | - |
226
- | Qoder | `.qoder/rules/conventions.md` | description |
227
-
228
- **解耦验证**:在 `editors.json` 中将任意编辑器 `enabled: false`,重新 `update` —— 该编辑器配置不再生成,其他编辑器**完全不受影响**。
229
-
230
- ---
231
-
232
- ## 受保护路径
233
-
234
- | 命令 | 保护路径 | 说明 |
235
- | ------------------------ | --------------------------------- | -------------------------- |
236
- | `init` / `update` | `.github/reports/*.md` | 已存在则跳过,不覆盖累积 |
237
- | `clean`(默认) | `src/components/` + `src/types/` | 业务代码必需,永不删除 |
238
- | `clean --keep-reports` | + `.github/reports/` | 保留菜单/字典/权限基线 |
239
-
240
- ---
241
-
242
- ## 进一步阅读
243
-
244
- - 📚 业务方使用指南:`.github/guides/usage.md`(业务项目内)
245
- - 🏗️ 架构与决策:`.github/guides/architecture.md`(业务项目内)
246
- - 🔧 维护者文档:[kit-internal/README.md](kit-internal/README.md)(仅本仓库)
247
- - 🤖 多编辑器适配机制:[files/.github/skills/_compat/README.md](files/.github/skills/_compat/README.md)
248
- - 🛠️ Jenkins 流水线参考:[kit-internal/jenkins-pipeline.md](kit-internal/jenkins-pipeline.md)
249
-
250
- ---
251
-
252
- ## 反馈与贡献
253
-
254
- - 使用问题 / Bug:联系 CHENY(工号 409322)
255
- - 仓库贡献:见 [kit-internal/CONTRIBUTING.md](kit-internal/CONTRIBUTING.md)
256
-
257
- ---
258
-
259
- ## 许可证
260
-
261
- UNLICENSED 内部使用
1
+ # @agile-team/wl-skills-kit
2
+
3
+ **AI Skill 模板包 v2.4.0** — 一条命令将 13 条编码规范、9 个 AI Skill、14 个 MCP Tool、组件文档、领域样例导入 Vue 3 项目。
4
+
5
+ 让 AI 编辑器(Copilot / Cursor / Windsurf / Claude Code / Cline / Kiro / Trae / Qoder / 通用 Agents)**真正理解项目规范**,从原型/详设到完整页面代码全流程自动化。
6
+
7
+ ---
8
+
9
+ ## TL;DR
10
+
11
+ ```bash
12
+ npx @robot-admin/git-standards init # 工程化前置(必须)
13
+ npx @agile-team/wl-skills-kit # 安装 AI 体系
14
+ # 在 AI 对话中:
15
+ "扫描 docs/prototypes/ 下的原型生成页面清单"
16
+ "基于上一步生成所有 api.md,再 codegen 出页面"
17
+ ```
18
+
19
+ ---
20
+
21
+ ## 这个包到底干什么?
22
+
23
+ ```
24
+ 原型/口述需求
25
+
26
+ ▼ [Skill: prototype-scan] ← 可跳过(直接口述需求时)
27
+ 《页面清单》(reports/PROTOTYPE_SCAN_*.md)
28
+
29
+ ▼ [Skill: api-contract]
30
+ api.md(页面级前后端契约)
31
+
32
+ ▼ [Skill: page-codegen]
33
+ data.ts + index.vue + index.scss(13 条 standards 自动满足)
34
+
35
+ ▼ [Skill: convention-audit] ← 也可对存量代码单独触发
36
+ reports/AUDIT_AI_*.md + AUDIT_HUMAN_*.md
37
+
38
+ ├─▶ [Skill: menu-sync] ← 可单独运行
39
+ │ 线上菜单注册完毕,UI 可访问
40
+
41
+ └─▶ [Skill: dict-sync] ← 可单独运行,与 menu-sync 互不依赖
42
+ 线上字典同步完毕
43
+ ```
44
+
45
+ > **灵活组合原则**:每个 Skill 都可以单独触发,也可以串联使用。哪一步结果不满意,重跑哪步即可,不需要从头来过。
46
+
47
+ ---
48
+
49
+ ## ⚠️ 仓库结构 vs 业务项目安装结构(**必看**)
50
+
51
+ `wl-skills-kit` 是一个 **npm 模板包**:仓库本身的结构 ≠ 你 `npx` 之后业务项目里看到的结构。两者**严格区分**:
52
+
53
+ ### A. 本仓库结构(开发/维护 wl-skills-kit 时)
54
+
55
+ ```
56
+ wl-skills-kit/ ← 你正看的这个仓库
57
+ ├── README.md 本文档(业务方 + 维护者都看)
58
+ ├── CHANGELOG.md
59
+ ├── package.json name: @agile-team/wl-skills-kit
60
+
61
+ ├── bin/
62
+ │ └── wl-skills.js CLI 实现(init / update / clean / check / diff / validate / export
63
+
64
+ ├── files/ ★★★ 真正会被打包并复制到业务项目的内容 ★★★
65
+ │ └── .github/
66
+ │ ├── copilot-instructions.md 源 AI 主入口(编辑这里,不要编辑业务项目里的副本)
67
+ │ ├── standards/ 13 条规范
68
+ │ ├── skills/ Skill 目录(含 _compat/ 多编辑器适配源)
69
+ │ ├── guides/ 人读指南
70
+ │ └── reports/ 领域基线模板(菜单/字典/权限)
71
+ │ ├── docs/ 组件 API 文档
72
+ │ └── demo/ 领域样例
73
+
74
+ ├── kit-internal/ ★★ 仅仓库可见,不会安装到业务项目 ★★
75
+ │ ├── README.md 维护者首页
76
+ │ ├── architecture.md 架构总览
77
+ │ ├── CONTRIBUTING.md 贡献流程
78
+ │ ├── standards.MAINTAIN.md standards 维护要点
79
+ │ ├── templates.MAINTAIN.md templates 维护要点
80
+ │ ├── jenkins-pipeline.md Jenkins CI 参考模板(不强加业务项目)
81
+ │ ├── skills/ 各 Skill 的 *.MAINTAIN.md
82
+ │ └── history/ 归档:旧版 ARCHITECTURE-PLAN 等
83
+
84
+ └── .npmignore 排除 kit-internal/ 等不发布的内容
85
+ ```
86
+
87
+ > **维护准则**:
88
+ > - 业务规范要改 → 改 `files/.github/standards/*.md`
89
+ > - Skill 流程要改 → 改 `files/.github/skills/<scope>/<name>/SKILL.md`
90
+ > - 多 AI 编辑器适配要改 → 改 `files/.github/skills/_compat/`(**不是**改业务项目里的根配置文件)
91
+ > - 维护文档要写 → 进 `kit-internal/`(不会污染业务项目)
92
+
93
+ ### B. 业务项目结构(执行 `npx @agile-team/wl-skills-kit` 之后)
94
+
95
+ ```
96
+ 你的业务项目/
97
+
98
+ ├── .github/ ← 来自本包 files/.github/
99
+ │ ├── copilot-instructions.md Copilot 主入口(精简 ~320 行)
100
+ │ ├── standards/ 13 条模块化规范 + index.md 门控
101
+ │ │ ├── 01-toolchain.md
102
+ │ │ ├── 02-code-structure.md
103
+ │ │ ├── ... (共 13 条)
104
+ │ │ └── 13-platform-components.md
105
+ │ ├── skills/ 9 个启用 Skill(全部激活)
106
+ │ │ ├── _registry.md ★ 触发词 → SKILL 路径单一数据源
107
+ │ │ ├── _compat/ 多 AI 编辑器适配(配置 + headers)
108
+ │ │ ├── core/ 核心通用 Skill
109
+ │ │ │ ├── prototype-scan/ { SKILL.md, USAGE.md }
110
+ │ │ │ ├── api-contract/ { SKILL.md, USAGE.md }
111
+ │ │ │ ├── page-codegen/ { SKILL.md, USAGE.md, templates/ }
112
+ │ │ │ ├── convention-audit/ { SKILL.md, USAGE.md }
113
+ │ │ │ └── template-extract/ { SKILL.md, USAGE.md }
114
+ │ │ ├── sync/ 数据同步类
115
+ │ │ │ ├── menu-sync/ { SKILL.md, USAGE.md, env/ }
116
+ │ │ │ ├── dict-sync/ { SKILL.md } 已启用
117
+ │ │ │ └── permission-sync/ { SKILL.md, USAGE.md } 已启用(角色+授权+动作+v-permission)
118
+ │ │ ├── ops/ 运维类
119
+ │ │ │ └── code-fix/ { SKILL.md } 已启用
120
+ │ │ └── domain/ 领域专属(按需创建)
121
+ │ ├── guides/ 人读指南(usage.md / architecture.md)
122
+ │ └── reports/ AI 生成报告(追加不覆盖)
123
+ │ ├── SYS_MENU_INFO.md 线上菜单基线
124
+ │ ├── SYS_DICT_INFO.md 线上字典基线
125
+ │ ├── SYS_PERMISSION_INFO.md 线上权限基线
126
+ │ └── AUDIT_*.md / PAGE_CODEGEN_*.md / ... (随用随生成)
127
+
128
+ ├── 多 AI 编辑器配置(解耦:可单独删除任意一个不影响其他)
129
+ ├── CLAUDE.md Claude Code
130
+ ├── AGENTS.md 通用 Agents
131
+ ├── .cursorrules Cursor 旧版
132
+ ├── .cursor/rules/conventions.mdc Cursor 新版(含 mdc frontmatter)
133
+ ├── .windsurfrules Windsurf
134
+ ├── .clinerules Cline
135
+ ├── .kiro/steering/conventions.md Kiro(含 inclusion frontmatter)
136
+ ├── .trae/rules/conventions.md Trae(含 alwaysApply frontmatter)
137
+
138
+ ├── docs/ 12 个组件 API 文档
139
+ ├── demo/ 13 个领域样例
140
+ └── src/
141
+ ├── components/ 全局/局部/远程组件
142
+ └── types/ 类型桶文件
143
+ ```
144
+
145
+ > **业务项目方准则**:
146
+ > - 主入口是 `.github/copilot-instructions.md`(Copilot 用),**其他 9 个根配置文件是它的拷贝 + 各自特化 frontmatter**
147
+ > - 修改规范 → **不要**改业务项目里的副本,**升级 wl-skills-kit 包 + `update`** 才不会被覆盖
148
+ > - reports/ 里的内容是团队累积数据,`update` 不会覆盖,可放心 commit
149
+
150
+ ---
151
+
152
+ ## CLI 命令
153
+
154
+ ```bash
155
+ # 全量安装(默认)
156
+ npx @agile-team/wl-skills-kit
157
+
158
+ # 增量更新(仅覆盖有变化的文件,自动保护 reports/)
159
+ npx @agile-team/wl-skills-kit update
160
+
161
+ # 环境预检(Node / 工具链 / MCP 配置 / manifest
162
+ npx @agile-team/wl-skills-kit check
163
+
164
+ # 对比已安装文件与当前 kit 版本差异
165
+ npx @agile-team/wl-skills-kit diff
166
+
167
+ # 静态检查 src/views 页面文件完整性
168
+ npx @agile-team/wl-skills-kit validate
169
+
170
+ # 导出菜单/字典/权限基线为 xlsx
171
+ npx @agile-team/wl-skills-kit export
172
+
173
+ # 构建前清理(保留 src/components + src/types)
174
+ npx @agile-team/wl-skills-kit clean
175
+
176
+ # 清理但保留 reports/(菜单/字典/权限累积数据)
177
+ npx @agile-team/wl-skills-kit clean --keep-reports
178
+
179
+ # 任何命令都可加 --dry-run 预览
180
+ npx @agile-team/wl-skills-kit update --dry-run
181
+ ```
182
+
183
+ > 全局安装后也可直接用 `wl-skills` 命令(如 `wl-skills update`)。
184
+
185
+ ---
186
+
187
+ ## MCP Tools 概览
188
+
189
+ | 类别 | Tools |
190
+ | --- | --- |
191
+ | 菜单 | `wls_menu_query` / `wls_menu_upsert` |
192
+ | 字典 | `wls_dict_query` / `wls_dict_upsert` |
193
+ | 权限 | `wls_role_query` / `wls_role_upsert` / `wls_assignable_menus_query` / `wls_role_assign_menus` / `wls_action_query` / `wls_action_upsert` |
194
+ | 项目感知 | `wls_code_scan` / `wls_route_check` / `wls_git_log_extract` / `wls_audit_report_push` |
195
+
196
+ `wls_code_scan`、`wls_route_check`、`wls_git_log_extract` 不依赖后端 token,可用于 Agent Pipeline 前置感知项目结构。
197
+
198
+ ---
199
+
200
+ ## 从早期版本升级
201
+
202
+ > **适用场景**:已安装 v1.x v2.0 的业务项目,希望升级到当前版本。
203
+
204
+ ```bash
205
+ # 执行增量更新即可
206
+ npx @agile-team/wl-skills-kit update
207
+ ```
208
+
209
+ `update` 命令会自动完成:
210
+ 1. **写入新文件** — 新结构下的所有文件覆盖写入
211
+ 2. **迁移清理** 检测并移除旧版遗留文件(如 `skills/prototype-scan/`、`docs/menu-sync-design.md` 等),避免新旧路径并存产生歧义
212
+ 3. **保护累积数据** — `reports/*.md` 已存在则跳过,团队累积的菜单/字典数据不丢失
213
+
214
+ > **注意**:如果项目在旧的 `.github/skills/menu-sync/env/env.local.json` 中有自定义配置,`update` 会将其迁移位置(删旧、新路径文件由 `init` 写入默认模板)。**请在 `update` 前备份** 或 `update` 后手动迁移到 `.github/skills/sync/menu-sync/env/env.local.json`。
215
+
216
+ ---
217
+
218
+ ## Skill 概览
219
+
220
+ | Skill | 状态 | 路径 | 核心用途 |
221
+ | ------------------ | --------- | ---------------------------------------- | ----------------------------- |
222
+ | `prototype-scan` | ✅ 启用 | `skills/core/prototype-scan/` | 原型/详设/口述 → 页面清单 |
223
+ | `api-contract` | ✅ 启用 | `skills/core/api-contract/` | 生成 api.md 前后端契约 |
224
+ | `page-codegen` | ✅ 启用 | `skills/core/page-codegen/` | 页面骨架生成 + 模板调度 |
225
+ | `convention-audit` | ✅ 启用 | `skills/core/convention-audit/` | 13 条规范扫描 + 双报告 |
226
+ | `template-extract` | ✅ 启用 | `skills/core/template-extract/` | 现有页面 → 领域模板 |
227
+ | `menu-sync` | ✅ 启用 | `skills/sync/menu-sync/` | 菜单基线 ↔ 后端接口 |
228
+ | `dict-sync` | 启用 | `skills/sync/dict-sync/` | 字典基线 后端接口 |
229
+ | `permission-sync` | ✅ 启用 | `skills/sync/permission-sync/` | 角色管理 + 角色授权 + 挂动作 + v-permission |
230
+ | `code-fix` | ✅ 启用 | `skills/ops/code-fix/` | 受控自动修复偏差 |
231
+
232
+ 每个启用 Skill 同目录都有 **`SKILL.md`(AI 触发用)+ `USAGE.md`(团队成员阅读)**。
233
+
234
+ ---
235
+
236
+ ## AI 编辑器适配(解耦设计)
237
+
238
+ `init` / `update` 读取 `files/.github/skills/_compat/editors.json` 生成对应配置:
239
+
240
+ | 编辑器 | 输出路径 | Frontmatter |
241
+ | -------------- | ----------------------------------- | ----------------------- |
242
+ | GitHub Copilot | `.github/copilot-instructions.md` | - |
243
+ | Claude Code | `CLAUDE.md` | - |
244
+ | Cursor (rules) | `.cursorrules` | - |
245
+ | Cursor (mdc) | `.cursor/rules/conventions.mdc` | description+globs+alwaysApply |
246
+ | Windsurf | `.windsurfrules` | - |
247
+ | Cline | `.clinerules` | - |
248
+ | Kiro | `.kiro/steering/conventions.md` | inclusion: always |
249
+ | Trae | `.trae/rules/conventions.md` | description+globs+alwaysApply |
250
+ | 通用 Agent | `AGENTS.md` | - |
251
+ | Qoder | `.qoder/rules/conventions.md` | description |
252
+
253
+ **解耦验证**:在 `editors.json` 中将任意编辑器 `enabled: false`,重新 `update` —— 该编辑器配置不再生成,其他编辑器**完全不受影响**。
254
+
255
+ ---
256
+
257
+ ## 受保护路径
258
+
259
+ | 命令 | 保护路径 | 说明 |
260
+ | ------------------------ | --------------------------------- | -------------------------- |
261
+ | `init` / `update` | `.github/reports/*.md` | 已存在则跳过,不覆盖累积 |
262
+ | `clean`(默认) | `src/components/` + `src/types/` | 业务代码必需,永不删除 |
263
+ | `clean --keep-reports` | + `.github/reports/` | 保留菜单/字典/权限基线 |
264
+
265
+ ---
266
+
267
+ ## 进一步阅读
268
+
269
+ - 📚 业务方使用指南:`.github/guides/usage.md`(业务项目内)
270
+ - 🏗️ 架构与决策:`.github/guides/architecture.md`(业务项目内)
271
+ - 🔧 维护者文档:[kit-internal/README.md](kit-internal/README.md)(仅本仓库)
272
+ - 🤖 多编辑器适配机制:[files/.github/skills/_compat/README.md](files/.github/skills/_compat/README.md)
273
+ - 🛠️ Jenkins 流水线参考:[kit-internal/jenkins-pipeline.md](kit-internal/jenkins-pipeline.md)
274
+
275
+ ---
276
+
277
+ ## 反馈与贡献
278
+
279
+ - 使用问题 / Bug:联系 CHENY(工号 409322)
280
+ - 仓库贡献:见 [kit-internal/CONTRIBUTING.md](kit-internal/CONTRIBUTING.md)
281
+
282
+ ---
283
+
284
+ ## 许可证
285
+
286
+ UNLICENSED — 内部使用