@agile-team/wl-skills-kit 2.3.4 → 2.3.6

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 (96) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/README.md +16 -10
  3. package/files/.cursor/mcp.json +8 -8
  4. package/files/.github/guides/README.md +13 -13
  5. package/files/.github/guides/architecture.md +555 -555
  6. package/files/.github/guides/mcp-setup.md +109 -109
  7. package/files/.github/guides/usage.md +184 -184
  8. package/files/.github/reports/README.md +65 -65
  9. package/files/.github/reports/SYS_DICT_INFO.md +50 -50
  10. package/files/.github/reports/SYS_MENU_INFO.md +247 -247
  11. package/files/.github/reports/SYS_PERMISSION_INFO.md +20 -20
  12. package/files/.github/reports//347/273/204/344/273/266/346/217/220/345/217/226/345/273/272/350/256/256.md +33 -33
  13. package/files/.github/reports//350/247/204/350/214/203/345/256/241/346/237/245/346/212/245/345/221/212.md +44 -44
  14. package/files/.github/skills/_compat/README.md +108 -108
  15. package/files/.github/skills/_compat/headers/agents.txt +8 -8
  16. package/files/.github/skills/_compat/headers/claude-code.txt +7 -7
  17. package/files/.github/skills/_compat/headers/cline.txt +7 -7
  18. package/files/.github/skills/_compat/headers/cursor-mdc.txt +16 -16
  19. package/files/.github/skills/_compat/headers/cursor-rules.txt +7 -7
  20. package/files/.github/skills/_compat/headers/github-copilot.txt +1 -1
  21. package/files/.github/skills/_compat/headers/kiro.txt +10 -10
  22. package/files/.github/skills/_compat/headers/qoder.txt +8 -8
  23. package/files/.github/skills/_compat/headers/trae.txt +11 -11
  24. package/files/.github/skills/_compat/headers/windsurf.txt +7 -7
  25. package/files/.github/skills/_registry.md +81 -81
  26. package/files/.github/skills/core/api-contract/SKILL.md +344 -344
  27. package/files/.github/skills/core/api-contract/USAGE.md +110 -110
  28. package/files/.github/skills/core/convention-audit/SKILL.md +189 -189
  29. package/files/.github/skills/core/convention-audit/USAGE.md +99 -99
  30. package/files/.github/skills/core/page-codegen/SKILL.md +973 -973
  31. package/files/.github/skills/core/page-codegen/USAGE.md +102 -102
  32. package/files/.github/skills/core/page-codegen/templates/_index.md +46 -46
  33. package/files/.github/skills/core/page-codegen/templates/domains/_CONTRIBUTING.md +107 -107
  34. package/files/.github/skills/core/page-codegen/templates/domains/produce/TPL-OPERATION-STATION.md +442 -442
  35. package/files/.github/skills/core/page-codegen/templates/domains/sale/README.md +26 -26
  36. package/files/.github/skills/core/page-codegen/templates/universal/TPL-CHANGE-HISTORY.md +276 -276
  37. package/files/.github/skills/core/page-codegen/templates/universal/TPL-DETAIL-TABS.md +1145 -1145
  38. package/files/.github/skills/core/page-codegen/templates/universal/TPL-DRIVEN.md +309 -309
  39. package/files/.github/skills/core/page-codegen/templates/universal/TPL-FORM-ROUTE.md +436 -436
  40. package/files/.github/skills/core/page-codegen/templates/universal/TPL-LIST.md +191 -191
  41. package/files/.github/skills/core/page-codegen/templates/universal/TPL-MASTER-DETAIL.md +148 -148
  42. package/files/.github/skills/core/page-codegen/templates/universal/TPL-RECORD-FORM.md +376 -376
  43. package/files/.github/skills/core/page-codegen/templates/universal/TPL-TREE-LIST.md +186 -186
  44. package/files/.github/skills/core/prototype-scan/SKILL.md +498 -498
  45. package/files/.github/skills/core/prototype-scan/USAGE.md +95 -95
  46. package/files/.github/skills/core/template-extract/SKILL.md +139 -139
  47. package/files/.github/skills/core/template-extract/USAGE.md +93 -93
  48. package/files/.github/skills/domain/README.md +51 -51
  49. package/files/.github/skills/sync/env.local.json +0 -5
  50. package/files/.github/skills/sync/menu-sync/SKILL.md +263 -263
  51. package/files/.github/skills/sync/menu-sync/USAGE.md +104 -104
  52. package/files/.github/skills/sync/menu-sync/env/env.local.json +7 -7
  53. package/files/.github/skills/sync/menu-sync/env/guide.md +99 -99
  54. package/files/.github/skills/sync/permission-sync/SKILL.md +239 -0
  55. package/files/.github/skills/sync/permission-sync/USAGE.md +93 -0
  56. package/files/.github/standards/01-toolchain.md +57 -57
  57. package/files/.github/standards/02-code-structure.md +111 -111
  58. package/files/.github/standards/03-comments.md +53 -53
  59. package/files/.github/standards/04-coding-basics.md +33 -33
  60. package/files/.github/standards/05-logging.md +38 -38
  61. package/files/.github/standards/06-security.md +44 -44
  62. package/files/.github/standards/07-config.md +52 -52
  63. package/files/.github/standards/08-git.md +60 -60
  64. package/files/.github/standards/09-typescript.md +71 -71
  65. package/files/.github/standards/10-pinia.md +57 -57
  66. package/files/.github/standards/11-form-validation.md +81 -81
  67. package/files/.github/standards/12-base-table.md +153 -153
  68. package/files/.github/standards/13-platform-components.md +123 -123
  69. package/files/.github/standards/index.md +89 -89
  70. package/files/.kiro/settings/mcp.json +8 -8
  71. package/files/.mcp.json +8 -8
  72. package/files/.vscode/mcp.json +9 -9
  73. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/data.ts +196 -196
  74. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.scss +150 -150
  75. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.vue +79 -79
  76. package/files/docs/jh-date-range.md +257 -257
  77. package/files/docs/jh-date.md +222 -222
  78. package/files/docs/jh-dept-picker.md +190 -190
  79. package/files/docs/jh-drag-row.md +590 -590
  80. package/files/docs/jh-file-upload.md +216 -216
  81. package/files/docs/jh-picker.md +218 -218
  82. package/files/docs/jh-select.md +148 -148
  83. package/files/docs/jh-text.md +248 -248
  84. package/files/docs/jh-user-picker.md +197 -197
  85. package/files/src/components/global/C_RightToolbar/data.ts +228 -228
  86. package/files/src/components/global/C_RightToolbar/index.scss +44 -44
  87. package/files/src/components/global/C_Splitter/index.scss +61 -61
  88. package/files/src/components/global/C_SvgIcon/index.scss +15 -15
  89. package/files/src/components/global/C_TagStatus/index.scss +20 -20
  90. package/files/src/components/global/C_Tree/data.ts +61 -61
  91. package/files/src/components/local/c_listModal/index.scss +4 -4
  92. package/mcp/api/roleApi.js +60 -0
  93. package/mcp/server.js +125 -5
  94. package/mcp/tools/permissionSync.js +321 -0
  95. package/package.json +1 -1
  96. package/files/.github/skills/sync/permission-sync/SKILL.draft.md +0 -91
@@ -1,109 +1,109 @@
1
- # MCP Server 配置指南
2
-
3
- `wl-skills init` 已自动为以下编辑器生成项目级 MCP 配置:
4
-
5
- | 编辑器 | 自动生成的配置文件 |
6
- | ---- | --------------- |
7
- | Cursor | `.cursor/mcp.json` |
8
- | Claude Code | `.mcp.json` |
9
- | VS Code / GitHub Copilot | `.vscode/mcp.json` |
10
- | Kiro | `.kiro/settings/mcp.json` |
11
-
12
- 以下编辑器仅支持全局配置,需手动添加一次(添加后对所有项目生效,无需重复操作):
13
-
14
- ---
15
-
16
- ## Windsurf
17
-
18
- 编辑全局文件 `~/.codeium/windsurf/mcp_config.json`,在 `mcpServers` 中追加:
19
-
20
- ```json
21
- {
22
- "mcpServers": {
23
- "wl-skills": {
24
- "command": "node",
25
- "args": ["/你的项目绝对路径/node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
26
- }
27
- }
28
- }
29
- ```
30
-
31
- > 提示:Windsurf 不支持 `${workspaceFolder}` 变量,需填写绝对路径;或使用相对路径 `node_modules/...`(Windsurf 会从工作区根目录解析)。
32
-
33
- ---
34
-
35
- ## Cline(VS Code 插件)
36
-
37
- 打开 VS Code 设置(`Ctrl+,`),搜索 `cline mcpServers`,或直接编辑 `settings.json` 追加:
38
-
39
- ```json
40
- {
41
- "cline.mcpServers": {
42
- "wl-skills": {
43
- "command": "node",
44
- "args": ["${workspaceFolder}/node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
45
- }
46
- }
47
- }
48
- ```
49
-
50
- 也可通过 Cline 侧边栏 → **MCP Servers** → **Edit Config** 进行图形化配置。
51
-
52
- ---
53
-
54
- ## Trae IDE
55
-
56
- 1. 打开 **Trae 设置**(`Ctrl+Shift+,`)→ **MCP**
57
- 2. 点击 **+** 新增服务器
58
- 3. 在弹出的 JSON 中填入:
59
-
60
- ```json
61
- {
62
- "mcpServers": {
63
- "wl-skills": {
64
- "command": "node",
65
- "args": ["node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
66
- }
67
- }
68
- }
69
- ```
70
-
71
- 4. 保存后重启 Trae,MCP 工具即可使用。
72
-
73
- ---
74
-
75
- ## Qoder IDE
76
-
77
- 1. 打开 **Qoder 设置**(`Ctrl+Shift+,`)→ **MCP**
78
- 2. 切换到 **我的服务器** 标签 → 点击右上角 **+** 新增
79
- 3. 在弹出的 JSON 中填入:
80
-
81
- ```json
82
- {
83
- "mcpServers": {
84
- "wl-skills": {
85
- "command": "node",
86
- "args": ["node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
87
- }
88
- }
89
- }
90
- ```
91
-
92
- 4. 关闭并保存,链接图标变绿表示连接成功。
93
-
94
- ---
95
-
96
- ## 配置完成后
97
-
98
- 确保已在 `.github/skills/sync/env.local.json` 中填写:
99
-
100
- ```json
101
- {
102
- "gatewayPath": "https://你的网关域名/api",
103
- "token": "Bearer 你的Token",
104
- "menu": { "domainId": 1 },
105
- "dict": {}
106
- }
107
- ```
108
-
109
- 配置完成后重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用 MCP 工具完成同步。
1
+ # MCP Server 配置指南
2
+
3
+ `wl-skills init` 已自动为以下编辑器生成项目级 MCP 配置:
4
+
5
+ | 编辑器 | 自动生成的配置文件 |
6
+ | ---- | --------------- |
7
+ | Cursor | `.cursor/mcp.json` |
8
+ | Claude Code | `.mcp.json` |
9
+ | VS Code / GitHub Copilot | `.vscode/mcp.json` |
10
+ | Kiro | `.kiro/settings/mcp.json` |
11
+
12
+ 以下编辑器仅支持全局配置,需手动添加一次(添加后对所有项目生效,无需重复操作):
13
+
14
+ ---
15
+
16
+ ## Windsurf
17
+
18
+ 编辑全局文件 `~/.codeium/windsurf/mcp_config.json`,在 `mcpServers` 中追加:
19
+
20
+ ```json
21
+ {
22
+ "mcpServers": {
23
+ "wl-skills": {
24
+ "command": "node",
25
+ "args": ["/你的项目绝对路径/node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
26
+ }
27
+ }
28
+ }
29
+ ```
30
+
31
+ > 提示:Windsurf 不支持 `${workspaceFolder}` 变量,需填写绝对路径;或使用相对路径 `node_modules/...`(Windsurf 会从工作区根目录解析)。
32
+
33
+ ---
34
+
35
+ ## Cline(VS Code 插件)
36
+
37
+ 打开 VS Code 设置(`Ctrl+,`),搜索 `cline mcpServers`,或直接编辑 `settings.json` 追加:
38
+
39
+ ```json
40
+ {
41
+ "cline.mcpServers": {
42
+ "wl-skills": {
43
+ "command": "node",
44
+ "args": ["${workspaceFolder}/node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
45
+ }
46
+ }
47
+ }
48
+ ```
49
+
50
+ 也可通过 Cline 侧边栏 → **MCP Servers** → **Edit Config** 进行图形化配置。
51
+
52
+ ---
53
+
54
+ ## Trae IDE
55
+
56
+ 1. 打开 **Trae 设置**(`Ctrl+Shift+,`)→ **MCP**
57
+ 2. 点击 **+** 新增服务器
58
+ 3. 在弹出的 JSON 中填入:
59
+
60
+ ```json
61
+ {
62
+ "mcpServers": {
63
+ "wl-skills": {
64
+ "command": "node",
65
+ "args": ["node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
66
+ }
67
+ }
68
+ }
69
+ ```
70
+
71
+ 4. 保存后重启 Trae,MCP 工具即可使用。
72
+
73
+ ---
74
+
75
+ ## Qoder IDE
76
+
77
+ 1. 打开 **Qoder 设置**(`Ctrl+Shift+,`)→ **MCP**
78
+ 2. 切换到 **我的服务器** 标签 → 点击右上角 **+** 新增
79
+ 3. 在弹出的 JSON 中填入:
80
+
81
+ ```json
82
+ {
83
+ "mcpServers": {
84
+ "wl-skills": {
85
+ "command": "node",
86
+ "args": ["node_modules/@agile-team/wl-skills-kit/mcp/server.js"]
87
+ }
88
+ }
89
+ }
90
+ ```
91
+
92
+ 4. 关闭并保存,链接图标变绿表示连接成功。
93
+
94
+ ---
95
+
96
+ ## 配置完成后
97
+
98
+ 确保已在 `.github/skills/sync/env.local.json` 中填写:
99
+
100
+ ```json
101
+ {
102
+ "gatewayPath": "https://你的网关域名/api",
103
+ "token": "Bearer 你的Token",
104
+ "menu": { "domainId": 1 },
105
+ "dict": {}
106
+ }
107
+ ```
108
+
109
+ 配置完成后重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用 MCP 工具完成同步。
@@ -1,184 +1,184 @@
1
- # wl-skills-kit 使用指南
2
-
3
- > **目标读者**:使用 `@agile-team/wl-skills-kit` 的 Vue 3 业务项目团队成员。
4
- > **适用版本**:v2.0+
5
- > **维护者**:CHENY(工号 409322)
6
-
7
- ---
8
-
9
- ## 5 分钟上手
10
-
11
- ### 第 1 步:安装工具链
12
-
13
- ```bash
14
- # 进入你的 Vue 3 项目根目录
15
- cd your-vue3-project
16
-
17
- # 安装工程化规范(强制前置)
18
- npx @robot-admin/git-standards init
19
-
20
- # 安装 AI Skill 体系
21
- npx @agile-team/wl-skills-kit
22
- ```
23
-
24
- ### 第 2 步:确认编辑器
25
-
26
- 推荐使用以下任一 AI 编辑器:
27
-
28
- - VS Code + GitHub Copilot
29
- - Cursor
30
- - Windsurf
31
- - Claude Code
32
- - Cline
33
- - Kiro
34
- - Trae
35
- - Qoder
36
-
37
- 打开项目后,AI 会自动加载 `.github/copilot-instructions.md`,你不用做任何配置。
38
-
39
- ### 第 3 步:开始使用
40
-
41
- 在 AI 对话中直接说出需求即可:
42
-
43
- ```
44
- "帮我生成一个客户管理列表页"
45
- "扫描这份原型 HTML"
46
- "审计 src/views/sale 这个目录的代码规范"
47
- "提取 mmwr-rolling-management 这个页面作为模板"
48
- "同步菜单到后端"
49
- ```
50
-
51
- AI 会自动识别意图,触发对应的 Skill。
52
-
53
- ---
54
-
55
- ## 8 个 Skill 速览
56
-
57
- | Skill | 触发关键词 | 用途 |
58
- | ------------------ | ------------------------------ | ---------------------------- |
59
- | `prototype-scan` | 扫描原型 / 解析原型 / 口述需求 | 原型 / 详设 → page-spec JSON |
60
- | `api-contract` | 接口约定 / api.md / 字段定义 | 生成接口约定文档 |
61
- | `page-codegen` | 生成页面 / 帮我生成 | 生成 4 文件 + 菜单注册 |
62
- | `menu-sync` | 创建菜单 / 同步菜单 | 菜单数据同步到后端(MCP 自动 / prompt 手动两种模式) |
63
- | `dict-sync` | 同步字典 / 创建字典 / 字典审计 | 字典基线同步到后端(MCP 自动 / prompt 手动两种模式) |
64
- | `convention-audit` | 规范审计 / 代码审计 | 13 条规范扫描 + 偏差报告 |
65
- | `template-extract` | 提取模板 / 抄取模板 | 从现有页面沉淠领域专属模板 |
66
- | `code-fix` | 自动修复 / 整改偏差 / 规范整改 | 受控自动修复审计报告中的偏差 |
67
-
68
- 完整调度规则见 `.github/skills/_registry.md`。
69
-
70
- ---
71
-
72
- ## 项目目录结构
73
-
74
- 安装后业务项目得到的关键目录:
75
-
76
- ```
77
- 你的项目/
78
- ├── .github/
79
- │ ├── copilot-instructions.md AI 主入口
80
- │ ├── standards/ 13 条模块化规范
81
- │ ├── skills/ 8 个 Skill + 1 个 PLANNED 草稿
82
- │ ├── guides/ 使用指南 + 架构设计
83
- │ └── reports/ AI 生成报告(SYS_MENU_INFO 等)
84
- ├── docs/ 12 个组件 API 文档(jh-* / request 等)
85
- ├── demo/ 13 个领域样例(生产 + 销售)
86
- └── src/
87
- ├── components/ 全局/局部/远程组件
88
- └── types/
89
- ```
90
-
91
- ---
92
-
93
- ## 完整流水线(从原型到上线)
94
-
95
- ```
96
- 1. 原型/详设 → prototype-scan → page-spec JSON
97
- 2. page-spec → api-contract → api.md
98
- 3. api.md → page-codegen → 4 文件 + reports/SYS_MENU_INFO.md
99
- 4. SYS_MENU_INFO → menu-sync → 后端菜单表
100
- 5. 代码完成 → dict-sync → 字典基线同步到后端字典表
101
- 6. 完成 → convention-audit → 偏差报告(reports/规范审查报告.md)
102
- 7. 报告 → code-fix → 受控自动修复 🟡/🟢 偏差,逐条 diff 确认
103
- 8. 沉淀 → template-extract → 从标杆页面提取领域专属模板
104
- ```
105
-
106
- > **说明**:每一步都可以单独触发,也可以按用户意图自动接续。
107
- > - `dict-sync`:首次使用先跑 **pull 模式**(「刷新字典基线」)建立本地基线,再跑 push 模式同步差异。
108
- > - `code-fix`:只修复 🟡/🟢 偏差;🔴 严重偏差必须人工或 page-codegen 处理。每条修复前强制 diff 预览确认。
109
-
110
- ---
111
-
112
- ## 常见问题
113
-
114
- **Q: AI 生成的代码不符合规范怎么办?**
115
- A: 触发 `convention-audit`,输出偏差报告到 `reports/规范审查报告.md`,按 🔴 严重 → 🟡 轻微的优先级修复。
116
-
117
- **Q: 工具链检测一直失败?**
118
- A: 检查 `.prettierrc.js` / `eslint.config.ts` / `.husky/` 是否齐全。重新执行 `npx @robot-admin/git-standards init`,或联系 CHENY(工号 409322)。
119
-
120
- **Q: 本团队有特殊的页面模式,通用模板不适用?**
121
- A: 触发 `template-extract`,从现有标杆页面提取为领域专属模板,沉淀到 `templates/domains/{你的领域}/`。
122
-
123
- **Q: 多个 AI 编辑器之间会冲突吗?**
124
- A: 不会。`bin/wl-skills.js` 已自动生成 9 种主流 AI 编辑器配置文件(含 Qoder),所有内容来自同一份 `copilot-instructions.md`,保持一致。
125
-
126
- **Q: MCP Server 是什么?需要额外配置吗?**
127
- A: `wl-skills init` 会自动为 **Cursor**(`.cursor/mcp.json`)、**Claude Code**(`.mcp.json`)、**VS Code / GitHub Copilot**(`.vscode/mcp.json`)、**Kiro**(`.kiro/settings/mcp.json`)生成项目级 MCP 配置文件。
128
-
129
- Windsurf、Cline、Trae、Qoder 仅支持全局配置,需手动操作一次,详见 `.github/guides/mcp-setup.md`。
130
-
131
- 配置完成后在 `.github/skills/sync/env.local.json` 中填好 `token`、`gatewayPath`、`menu.domainId`,重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用 MCP 工具完成同步,无需手动粘贴接口响应。
132
-
133
- **Q: 部署到生产环境前如何清理 AI 文件?**
134
- A: 执行 `npx @agile-team/wl-skills-kit clean`。会移除所有 AI 辅助文件,保留 `src/components/` 和 `src/types/`。
135
-
136
- ---
137
-
138
- ## 升级与维护
139
-
140
- ### 增量更新
141
-
142
- ```bash
143
- npx @agile-team/wl-skills-kit@latest update
144
- # 仅覆盖有变化的文件,未变文件不动
145
- ```
146
-
147
- ### 预览模式
148
-
149
- 任何命令都可加 `--dry-run` 预览变更:
150
-
151
- ```bash
152
- npx @agile-team/wl-skills-kit update --dry-run
153
- npx @agile-team/wl-skills-kit clean --dry-run
154
- ```
155
-
156
- ---
157
-
158
- ## Pre-flight 声明阅读指南
159
-
160
- 每次 AI 触发 Skill 时会输出"Pre-flight 声明",告诉你它读取了哪些文件、做了哪些前置检查:
161
-
162
- ```
163
- 🚀 已触发技能 page-codegen/SKILL.md → 页面代码生成
164
- ✅ 已读取 standards/13-platform-components.md → 平台组件对照表
165
- ✅ 工具链检测:.prettierrc.js ✓ eslint.config.ts ✓ .husky/ ✓
166
- ✅ cid 已生成:cl-745831
167
- ```
168
-
169
- 如果 AI 没输出此声明,说明它跳过了前置检查,**请提示它"补 Pre-flight 声明"**,或重新触发。
170
-
171
- ---
172
-
173
- ## 反馈与贡献
174
-
175
- - 使用问题 / Bug:联系 CHENY(工号 409322)
176
- - 模板贡献:使用 `template-extract` Skill 自动提取并 PR
177
- - 规范修改:在 `standards/` 编辑后,团队评审通过后合入
178
-
179
- ---
180
-
181
- ## 进一步阅读
182
-
183
- - 架构与决策记录:[architecture.md](architecture.md)
184
- - 编辑器适配说明:`.github/skills/_compat/README.md`
1
+ # wl-skills-kit 使用指南
2
+
3
+ > **目标读者**:使用 `@agile-team/wl-skills-kit` 的 Vue 3 业务项目团队成员。
4
+ > **适用版本**:v2.0+
5
+ > **维护者**:CHENY(工号 409322)
6
+
7
+ ---
8
+
9
+ ## 5 分钟上手
10
+
11
+ ### 第 1 步:安装工具链
12
+
13
+ ```bash
14
+ # 进入你的 Vue 3 项目根目录
15
+ cd your-vue3-project
16
+
17
+ # 安装工程化规范(强制前置)
18
+ npx @robot-admin/git-standards init
19
+
20
+ # 安装 AI Skill 体系
21
+ npx @agile-team/wl-skills-kit
22
+ ```
23
+
24
+ ### 第 2 步:确认编辑器
25
+
26
+ 推荐使用以下任一 AI 编辑器:
27
+
28
+ - VS Code + GitHub Copilot
29
+ - Cursor
30
+ - Windsurf
31
+ - Claude Code
32
+ - Cline
33
+ - Kiro
34
+ - Trae
35
+ - Qoder
36
+
37
+ 打开项目后,AI 会自动加载 `.github/copilot-instructions.md`,你不用做任何配置。
38
+
39
+ ### 第 3 步:开始使用
40
+
41
+ 在 AI 对话中直接说出需求即可:
42
+
43
+ ```
44
+ "帮我生成一个客户管理列表页"
45
+ "扫描这份原型 HTML"
46
+ "审计 src/views/sale 这个目录的代码规范"
47
+ "提取 mmwr-rolling-management 这个页面作为模板"
48
+ "同步菜单到后端"
49
+ ```
50
+
51
+ AI 会自动识别意图,触发对应的 Skill。
52
+
53
+ ---
54
+
55
+ ## 8 个 Skill 速览
56
+
57
+ | Skill | 触发关键词 | 用途 |
58
+ | ------------------ | ------------------------------ | ---------------------------- |
59
+ | `prototype-scan` | 扫描原型 / 解析原型 / 口述需求 | 原型 / 详设 → page-spec JSON |
60
+ | `api-contract` | 接口约定 / api.md / 字段定义 | 生成接口约定文档 |
61
+ | `page-codegen` | 生成页面 / 帮我生成 | 生成 4 文件 + 菜单注册 |
62
+ | `menu-sync` | 创建菜单 / 同步菜单 | 菜单数据同步到后端(MCP 自动 / prompt 手动两种模式) |
63
+ | `dict-sync` | 同步字典 / 创建字典 / 字典审计 | 字典基线同步到后端(MCP 自动 / prompt 手动两种模式) |
64
+ | `convention-audit` | 规范审计 / 代码审计 | 13 条规范扫描 + 偏差报告 |
65
+ | `template-extract` | 提取模板 / 抄取模板 | 从现有页面沉淠领域专属模板 |
66
+ | `code-fix` | 自动修复 / 整改偏差 / 规范整改 | 受控自动修复审计报告中的偏差 |
67
+
68
+ 完整调度规则见 `.github/skills/_registry.md`。
69
+
70
+ ---
71
+
72
+ ## 项目目录结构
73
+
74
+ 安装后业务项目得到的关键目录:
75
+
76
+ ```
77
+ 你的项目/
78
+ ├── .github/
79
+ │ ├── copilot-instructions.md AI 主入口
80
+ │ ├── standards/ 13 条模块化规范
81
+ │ ├── skills/ 8 个 Skill + 1 个 PLANNED 草稿
82
+ │ ├── guides/ 使用指南 + 架构设计
83
+ │ └── reports/ AI 生成报告(SYS_MENU_INFO 等)
84
+ ├── docs/ 12 个组件 API 文档(jh-* / request 等)
85
+ ├── demo/ 13 个领域样例(生产 + 销售)
86
+ └── src/
87
+ ├── components/ 全局/局部/远程组件
88
+ └── types/
89
+ ```
90
+
91
+ ---
92
+
93
+ ## 完整流水线(从原型到上线)
94
+
95
+ ```
96
+ 1. 原型/详设 → prototype-scan → page-spec JSON
97
+ 2. page-spec → api-contract → api.md
98
+ 3. api.md → page-codegen → 4 文件 + reports/SYS_MENU_INFO.md
99
+ 4. SYS_MENU_INFO → menu-sync → 后端菜单表
100
+ 5. 代码完成 → dict-sync → 字典基线同步到后端字典表
101
+ 6. 完成 → convention-audit → 偏差报告(reports/规范审查报告.md)
102
+ 7. 报告 → code-fix → 受控自动修复 🟡/🟢 偏差,逐条 diff 确认
103
+ 8. 沉淀 → template-extract → 从标杆页面提取领域专属模板
104
+ ```
105
+
106
+ > **说明**:每一步都可以单独触发,也可以按用户意图自动接续。
107
+ > - `dict-sync`:首次使用先跑 **pull 模式**(「刷新字典基线」)建立本地基线,再跑 push 模式同步差异。
108
+ > - `code-fix`:只修复 🟡/🟢 偏差;🔴 严重偏差必须人工或 page-codegen 处理。每条修复前强制 diff 预览确认。
109
+
110
+ ---
111
+
112
+ ## 常见问题
113
+
114
+ **Q: AI 生成的代码不符合规范怎么办?**
115
+ A: 触发 `convention-audit`,输出偏差报告到 `reports/规范审查报告.md`,按 🔴 严重 → 🟡 轻微的优先级修复。
116
+
117
+ **Q: 工具链检测一直失败?**
118
+ A: 检查 `.prettierrc.js` / `eslint.config.ts` / `.husky/` 是否齐全。重新执行 `npx @robot-admin/git-standards init`,或联系 CHENY(工号 409322)。
119
+
120
+ **Q: 本团队有特殊的页面模式,通用模板不适用?**
121
+ A: 触发 `template-extract`,从现有标杆页面提取为领域专属模板,沉淀到 `templates/domains/{你的领域}/`。
122
+
123
+ **Q: 多个 AI 编辑器之间会冲突吗?**
124
+ A: 不会。`bin/wl-skills.js` 已自动生成 9 种主流 AI 编辑器配置文件(含 Qoder),所有内容来自同一份 `copilot-instructions.md`,保持一致。
125
+
126
+ **Q: MCP Server 是什么?需要额外配置吗?**
127
+ A: `wl-skills init` 会自动为 **Cursor**(`.cursor/mcp.json`)、**Claude Code**(`.mcp.json`)、**VS Code / GitHub Copilot**(`.vscode/mcp.json`)、**Kiro**(`.kiro/settings/mcp.json`)生成项目级 MCP 配置文件。
128
+
129
+ Windsurf、Cline、Trae、Qoder 仅支持全局配置,需手动操作一次,详见 `.github/guides/mcp-setup.md`。
130
+
131
+ 配置完成后在 `.github/skills/sync/env.local.json` 中填好 `token`、`gatewayPath`、`menu.domainId`,重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用 MCP 工具完成同步,无需手动粘贴接口响应。
132
+
133
+ **Q: 部署到生产环境前如何清理 AI 文件?**
134
+ A: 执行 `npx @agile-team/wl-skills-kit clean`。会移除所有 AI 辅助文件,保留 `src/components/` 和 `src/types/`。
135
+
136
+ ---
137
+
138
+ ## 升级与维护
139
+
140
+ ### 增量更新
141
+
142
+ ```bash
143
+ npx @agile-team/wl-skills-kit@latest update
144
+ # 仅覆盖有变化的文件,未变文件不动
145
+ ```
146
+
147
+ ### 预览模式
148
+
149
+ 任何命令都可加 `--dry-run` 预览变更:
150
+
151
+ ```bash
152
+ npx @agile-team/wl-skills-kit update --dry-run
153
+ npx @agile-team/wl-skills-kit clean --dry-run
154
+ ```
155
+
156
+ ---
157
+
158
+ ## Pre-flight 声明阅读指南
159
+
160
+ 每次 AI 触发 Skill 时会输出"Pre-flight 声明",告诉你它读取了哪些文件、做了哪些前置检查:
161
+
162
+ ```
163
+ 🚀 已触发技能 page-codegen/SKILL.md → 页面代码生成
164
+ ✅ 已读取 standards/13-platform-components.md → 平台组件对照表
165
+ ✅ 工具链检测:.prettierrc.js ✓ eslint.config.ts ✓ .husky/ ✓
166
+ ✅ cid 已生成:cl-745831
167
+ ```
168
+
169
+ 如果 AI 没输出此声明,说明它跳过了前置检查,**请提示它"补 Pre-flight 声明"**,或重新触发。
170
+
171
+ ---
172
+
173
+ ## 反馈与贡献
174
+
175
+ - 使用问题 / Bug:联系 CHENY(工号 409322)
176
+ - 模板贡献:使用 `template-extract` Skill 自动提取并 PR
177
+ - 规范修改:在 `standards/` 编辑后,团队评审通过后合入
178
+
179
+ ---
180
+
181
+ ## 进一步阅读
182
+
183
+ - 架构与决策记录:[architecture.md](architecture.md)
184
+ - 编辑器适配说明:`.github/skills/_compat/README.md`