@agile-team/wl-skills-kit 2.3.0 → 2.3.1

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 (93) hide show
  1. package/CHANGELOG.md +33 -63
  2. package/README.md +15 -148
  3. package/bin/wl-skills.js +2 -100
  4. package/files/.github/guides/README.md +13 -13
  5. package/files/.github/guides/architecture.md +555 -576
  6. package/files/.github/guides/usage.md +176 -176
  7. package/files/.github/reports/README.md +65 -65
  8. package/files/.github/reports/SYS_DICT_INFO.md +50 -50
  9. package/files/.github/reports/SYS_MENU_INFO.md +247 -247
  10. package/files/.github/reports/SYS_PERMISSION_INFO.md +20 -20
  11. 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
  12. 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
  13. package/files/.github/skills/_compat/README.md +108 -108
  14. package/files/.github/skills/_compat/headers/agents.txt +8 -8
  15. package/files/.github/skills/_compat/headers/claude-code.txt +7 -7
  16. package/files/.github/skills/_compat/headers/cline.txt +7 -7
  17. package/files/.github/skills/_compat/headers/cursor-mdc.txt +16 -16
  18. package/files/.github/skills/_compat/headers/cursor-rules.txt +7 -7
  19. package/files/.github/skills/_compat/headers/github-copilot.txt +1 -1
  20. package/files/.github/skills/_compat/headers/kiro.txt +10 -10
  21. package/files/.github/skills/_compat/headers/trae.txt +11 -11
  22. package/files/.github/skills/_compat/headers/windsurf.txt +7 -7
  23. package/files/.github/skills/_registry.md +81 -81
  24. package/files/.github/skills/core/api-contract/SKILL.md +344 -344
  25. package/files/.github/skills/core/api-contract/USAGE.md +110 -110
  26. package/files/.github/skills/core/convention-audit/SKILL.md +189 -189
  27. package/files/.github/skills/core/convention-audit/USAGE.md +99 -99
  28. package/files/.github/skills/core/page-codegen/SKILL.md +973 -973
  29. package/files/.github/skills/core/page-codegen/USAGE.md +102 -102
  30. package/files/.github/skills/core/page-codegen/templates/_index.md +46 -46
  31. package/files/.github/skills/core/page-codegen/templates/domains/_CONTRIBUTING.md +107 -107
  32. package/files/.github/skills/core/page-codegen/templates/domains/produce/TPL-OPERATION-STATION.md +442 -442
  33. package/files/.github/skills/core/page-codegen/templates/domains/sale/README.md +26 -26
  34. package/files/.github/skills/core/page-codegen/templates/universal/TPL-CHANGE-HISTORY.md +276 -276
  35. package/files/.github/skills/core/page-codegen/templates/universal/TPL-DETAIL-TABS.md +1145 -1145
  36. package/files/.github/skills/core/page-codegen/templates/universal/TPL-DRIVEN.md +124 -124
  37. package/files/.github/skills/core/page-codegen/templates/universal/TPL-FORM-ROUTE.md +436 -436
  38. package/files/.github/skills/core/page-codegen/templates/universal/TPL-LIST.md +191 -191
  39. package/files/.github/skills/core/page-codegen/templates/universal/TPL-MASTER-DETAIL.md +148 -148
  40. package/files/.github/skills/core/page-codegen/templates/universal/TPL-RECORD-FORM.md +376 -376
  41. package/files/.github/skills/core/page-codegen/templates/universal/TPL-TREE-LIST.md +186 -186
  42. package/files/.github/skills/core/prototype-scan/SKILL.md +498 -498
  43. package/files/.github/skills/core/prototype-scan/USAGE.md +95 -95
  44. package/files/.github/skills/core/template-extract/SKILL.md +139 -139
  45. package/files/.github/skills/core/template-extract/USAGE.md +93 -93
  46. package/files/.github/skills/domain/README.md +51 -51
  47. package/files/.github/skills/sync/menu-sync/SKILL.md +263 -263
  48. package/files/.github/skills/sync/menu-sync/USAGE.md +104 -104
  49. package/files/.github/skills/sync/menu-sync/env/env.local.json +7 -7
  50. package/files/.github/skills/sync/menu-sync/env/guide.md +99 -99
  51. package/files/.github/skills/sync/permission-sync/SKILL.draft.md +91 -91
  52. package/files/.github/standards/01-toolchain.md +57 -57
  53. package/files/.github/standards/02-code-structure.md +111 -111
  54. package/files/.github/standards/03-comments.md +53 -53
  55. package/files/.github/standards/04-coding-basics.md +33 -33
  56. package/files/.github/standards/05-logging.md +38 -38
  57. package/files/.github/standards/06-security.md +44 -44
  58. package/files/.github/standards/07-config.md +52 -52
  59. package/files/.github/standards/08-git.md +60 -60
  60. package/files/.github/standards/09-typescript.md +71 -71
  61. package/files/.github/standards/10-pinia.md +57 -57
  62. package/files/.github/standards/11-form-validation.md +81 -81
  63. package/files/.github/standards/12-base-table.md +153 -153
  64. package/files/.github/standards/13-platform-components.md +123 -123
  65. package/files/.github/standards/index.md +89 -89
  66. package/files/demo/produce/aiflow/mmwr-customer-apply-add/api.md +1 -1
  67. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/data.ts +196 -196
  68. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.scss +150 -150
  69. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.vue +79 -79
  70. package/files/docs/jh-date-range.md +257 -257
  71. package/files/docs/jh-date.md +222 -222
  72. package/files/docs/jh-dept-picker.md +190 -190
  73. package/files/docs/jh-drag-row.md +590 -590
  74. package/files/docs/jh-file-upload.md +216 -216
  75. package/files/docs/jh-picker.md +218 -218
  76. package/files/docs/jh-select.md +148 -148
  77. package/files/docs/jh-text.md +248 -248
  78. package/files/docs/jh-user-picker.md +197 -197
  79. package/files/docs/request.md +24 -9
  80. package/files/src/components/global/C_RightToolbar/data.ts +228 -0
  81. package/files/src/components/global/C_RightToolbar/index.scss +44 -0
  82. package/files/src/components/global/C_RightToolbar/index.vue +34 -336
  83. package/files/src/components/global/C_Splitter/index.scss +61 -0
  84. package/files/src/components/global/C_Splitter/index.vue +2 -64
  85. package/files/src/components/global/C_SvgIcon/index.scss +15 -0
  86. package/files/src/components/global/C_SvgIcon/index.vue +20 -50
  87. package/files/src/components/global/C_TagStatus/index.scss +20 -0
  88. package/files/src/components/global/C_TagStatus/index.vue +1 -22
  89. package/files/src/components/global/C_Tree/data.ts +61 -0
  90. package/files/src/components/global/C_Tree/index.vue +12 -53
  91. package/files/src/components/local/c_listModal/index.scss +4 -0
  92. package/files/src/components/local/c_listModal/index.vue +1 -1
  93. package/package.json +5 -9
@@ -1,176 +1,176 @@
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
-
33
- 打开项目后,AI 会自动加载 `.github/copilot-instructions.md`,你不用做任何配置。
34
-
35
- ### 第 3 步:开始使用
36
-
37
- 在 AI 对话中直接说出需求即可:
38
-
39
- ```
40
- "帮我生成一个客户管理列表页"
41
- "扫描这份原型 HTML"
42
- "审计 src/views/sale 这个目录的代码规范"
43
- "提取 mmwr-rolling-management 这个页面作为模板"
44
- "同步菜单到后端"
45
- ```
46
-
47
- AI 会自动识别意图,触发对应的 Skill。
48
-
49
- ---
50
-
51
- ## 8 个 Skill 速览
52
-
53
- | Skill | 触发关键词 | 用途 |
54
- | ------------------ | ------------------------------ | ---------------------------- |
55
- | `prototype-scan` | 扫描原型 / 解析原型 / 口述需求 | 原型 / 详设 → page-spec JSON |
56
- | `api-contract` | 接口约定 / api.md / 字段定义 | 生成接口约定文档 |
57
- | `page-codegen` | 生成页面 / 帮我生成 | 生成 4 文件 + 菜单注册 |
58
- | `menu-sync` | 创建菜单 / 同步菜单 | 菜单数据同步到后端(MCP 自动 / prompt 手动两种模式) |
59
- | `dict-sync` | 同步字典 / 创建字典 / 字典审计 | 字典基线同步到后端(MCP 自动 / prompt 手动两种模式) |
60
- | `convention-audit` | 规范审计 / 代码审计 | 13 条规范扫描 + 偏差报告 |
61
- | `template-extract` | 提取模板 / 抄取模板 | 从现有页面沉淠领域专属模板 |
62
- | `code-fix` | 自动修复 / 整改偏差 / 规范整改 | 受控自动修复审计报告中的偏差 |
63
-
64
- 完整调度规则见 `.github/skills/_registry.md`。
65
-
66
- ---
67
-
68
- ## 项目目录结构
69
-
70
- 安装后业务项目得到的关键目录:
71
-
72
- ```
73
- 你的项目/
74
- ├── .github/
75
- │ ├── copilot-instructions.md AI 主入口
76
- │ ├── standards/ 13 条模块化规范
77
- │ ├── skills/ 8 个 Skill + 1 个 PLANNED 草稿
78
- │ ├── guides/ 使用指南 + 架构设计
79
- │ └── reports/ AI 生成报告(SYS_MENU_INFO 等)
80
- ├── docs/ 12 个组件 API 文档(jh-* / request 等)
81
- ├── demo/ 13 个领域样例(生产 + 销售)
82
- └── src/
83
- ├── components/ 全局/局部/远程组件
84
- └── types/
85
- ```
86
-
87
- ---
88
-
89
- ## 完整流水线(从原型到上线)
90
-
91
- ```
92
- 1. 原型/详设 → prototype-scan → page-spec JSON
93
- 2. page-spec → api-contract → api.md
94
- 3. api.md → page-codegen → 4 文件 + reports/SYS_MENU_INFO.md
95
- 4. SYS_MENU_INFO → menu-sync → 后端菜单表
96
- 5. 代码完成 → dict-sync → 字典基线同步到后端字典表
97
- 6. 完成 → convention-audit → 偏差报告(reports/规范审查报告.md)
98
- 7. 报告 → code-fix → 受控自动修复 🟡/🟢 偏差,逐条 diff 确认
99
- 8. 沉淀 → template-extract → 从标杆页面提取领域专属模板
100
- ```
101
-
102
- > **说明**:每一步都可以单独触发,也可以按用户意图自动接续。
103
- > - `dict-sync`:首次使用先跑 **pull 模式**(「刷新字典基线」)建立本地基线,再跑 push 模式同步差异。
104
- > - `code-fix`:只修复 🟡/🟢 偏差;🔴 严重偏差必须人工或 page-codegen 处理。每条修复前强制 diff 预览确认。
105
-
106
- ---
107
-
108
- ## 常见问题
109
-
110
- **Q: AI 生成的代码不符合规范怎么办?**
111
- A: 触发 `convention-audit`,输出偏差报告到 `reports/规范审查报告.md`,按 🔴 严重 → 🟡 轻微的优先级修复。
112
-
113
- **Q: 工具链检测一直失败?**
114
- A: 检查 `.prettierrc.js` / `eslint.config.ts` / `.husky/` 是否齐全。重新执行 `npx @robot-admin/git-standards init`,或联系 CHENY(工号 409322)。
115
-
116
- **Q: 本团队有特殊的页面模式,通用模板不适用?**
117
- A: 触发 `template-extract`,从现有标杆页面提取为领域专属模板,沉淀到 `templates/domains/{你的领域}/`。
118
-
119
- **Q: 多个 AI 编辑器之间会冲突吗?**
120
- A: 不会。`bin/wl-skills.js` 已自动生成 8 种主流 AI 编辑器配置文件,所有内容来自同一份 `copilot-instructions.md`,保持一致。
121
-
122
- **Q: MCP Server 是什么?需要额外配置吗?**
123
- A: `wl-skills init` 会自动生成 `.cursor/mcp.json`(Cursor 用)和 `.claude/settings.json`(Claude Code 用)。只需在 `.github/skills/sync/env.local.json` 里填好 `token`、`gatewayPath`、`menu.domainId` 即可。填写后重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用接口完成同步,无需手动粘贴接口响应。
124
-
125
- **Q: 部署到生产环境前如何清理 AI 文件?**
126
- A: 执行 `npx @agile-team/wl-skills-kit clean`。会移除所有 AI 辅助文件,保留 `src/components/` 和 `src/types/`。
127
-
128
- ---
129
-
130
- ## 升级与维护
131
-
132
- ### 增量更新
133
-
134
- ```bash
135
- npx @agile-team/wl-skills-kit@latest update
136
- # 仅覆盖有变化的文件,未变文件不动
137
- ```
138
-
139
- ### 预览模式
140
-
141
- 任何命令都可加 `--dry-run` 预览变更:
142
-
143
- ```bash
144
- npx @agile-team/wl-skills-kit update --dry-run
145
- npx @agile-team/wl-skills-kit clean --dry-run
146
- ```
147
-
148
- ---
149
-
150
- ## Pre-flight 声明阅读指南
151
-
152
- 每次 AI 触发 Skill 时会输出"Pre-flight 声明",告诉你它读取了哪些文件、做了哪些前置检查:
153
-
154
- ```
155
- 🚀 已触发技能 page-codegen/SKILL.md → 页面代码生成
156
- ✅ 已读取 standards/13-platform-components.md → 平台组件对照表
157
- ✅ 工具链检测:.prettierrc.js ✓ eslint.config.ts ✓ .husky/ ✓
158
- ✅ cid 已生成:cl-745831
159
- ```
160
-
161
- 如果 AI 没输出此声明,说明它跳过了前置检查,**请提示它"补 Pre-flight 声明"**,或重新触发。
162
-
163
- ---
164
-
165
- ## 反馈与贡献
166
-
167
- - 使用问题 / Bug:联系 CHENY(工号 409322)
168
- - 模板贡献:使用 `template-extract` Skill 自动提取并 PR
169
- - 规范修改:在 `standards/` 编辑后,团队评审通过后合入
170
-
171
- ---
172
-
173
- ## 进一步阅读
174
-
175
- - 架构与决策记录:[architecture.md](architecture.md)
176
- - 编辑器适配说明:`.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
+
33
+ 打开项目后,AI 会自动加载 `.github/copilot-instructions.md`,你不用做任何配置。
34
+
35
+ ### 第 3 步:开始使用
36
+
37
+ 在 AI 对话中直接说出需求即可:
38
+
39
+ ```
40
+ "帮我生成一个客户管理列表页"
41
+ "扫描这份原型 HTML"
42
+ "审计 src/views/sale 这个目录的代码规范"
43
+ "提取 mmwr-rolling-management 这个页面作为模板"
44
+ "同步菜单到后端"
45
+ ```
46
+
47
+ AI 会自动识别意图,触发对应的 Skill。
48
+
49
+ ---
50
+
51
+ ## 8 个 Skill 速览
52
+
53
+ | Skill | 触发关键词 | 用途 |
54
+ | ------------------ | ------------------------------ | ---------------------------- |
55
+ | `prototype-scan` | 扫描原型 / 解析原型 / 口述需求 | 原型 / 详设 → page-spec JSON |
56
+ | `api-contract` | 接口约定 / api.md / 字段定义 | 生成接口约定文档 |
57
+ | `page-codegen` | 生成页面 / 帮我生成 | 生成 4 文件 + 菜单注册 |
58
+ | `menu-sync` | 创建菜单 / 同步菜单 | 菜单数据同步到后端(MCP 自动 / prompt 手动两种模式) |
59
+ | `dict-sync` | 同步字典 / 创建字典 / 字典审计 | 字典基线同步到后端(MCP 自动 / prompt 手动两种模式) |
60
+ | `convention-audit` | 规范审计 / 代码审计 | 13 条规范扫描 + 偏差报告 |
61
+ | `template-extract` | 提取模板 / 抄取模板 | 从现有页面沉淠领域专属模板 |
62
+ | `code-fix` | 自动修复 / 整改偏差 / 规范整改 | 受控自动修复审计报告中的偏差 |
63
+
64
+ 完整调度规则见 `.github/skills/_registry.md`。
65
+
66
+ ---
67
+
68
+ ## 项目目录结构
69
+
70
+ 安装后业务项目得到的关键目录:
71
+
72
+ ```
73
+ 你的项目/
74
+ ├── .github/
75
+ │ ├── copilot-instructions.md AI 主入口
76
+ │ ├── standards/ 13 条模块化规范
77
+ │ ├── skills/ 8 个 Skill + 1 个 PLANNED 草稿
78
+ │ ├── guides/ 使用指南 + 架构设计
79
+ │ └── reports/ AI 生成报告(SYS_MENU_INFO 等)
80
+ ├── docs/ 12 个组件 API 文档(jh-* / request 等)
81
+ ├── demo/ 13 个领域样例(生产 + 销售)
82
+ └── src/
83
+ ├── components/ 全局/局部/远程组件
84
+ └── types/
85
+ ```
86
+
87
+ ---
88
+
89
+ ## 完整流水线(从原型到上线)
90
+
91
+ ```
92
+ 1. 原型/详设 → prototype-scan → page-spec JSON
93
+ 2. page-spec → api-contract → api.md
94
+ 3. api.md → page-codegen → 4 文件 + reports/SYS_MENU_INFO.md
95
+ 4. SYS_MENU_INFO → menu-sync → 后端菜单表
96
+ 5. 代码完成 → dict-sync → 字典基线同步到后端字典表
97
+ 6. 完成 → convention-audit → 偏差报告(reports/规范审查报告.md)
98
+ 7. 报告 → code-fix → 受控自动修复 🟡/🟢 偏差,逐条 diff 确认
99
+ 8. 沉淀 → template-extract → 从标杆页面提取领域专属模板
100
+ ```
101
+
102
+ > **说明**:每一步都可以单独触发,也可以按用户意图自动接续。
103
+ > - `dict-sync`:首次使用先跑 **pull 模式**(「刷新字典基线」)建立本地基线,再跑 push 模式同步差异。
104
+ > - `code-fix`:只修复 🟡/🟢 偏差;🔴 严重偏差必须人工或 page-codegen 处理。每条修复前强制 diff 预览确认。
105
+
106
+ ---
107
+
108
+ ## 常见问题
109
+
110
+ **Q: AI 生成的代码不符合规范怎么办?**
111
+ A: 触发 `convention-audit`,输出偏差报告到 `reports/规范审查报告.md`,按 🔴 严重 → 🟡 轻微的优先级修复。
112
+
113
+ **Q: 工具链检测一直失败?**
114
+ A: 检查 `.prettierrc.js` / `eslint.config.ts` / `.husky/` 是否齐全。重新执行 `npx @robot-admin/git-standards init`,或联系 CHENY(工号 409322)。
115
+
116
+ **Q: 本团队有特殊的页面模式,通用模板不适用?**
117
+ A: 触发 `template-extract`,从现有标杆页面提取为领域专属模板,沉淀到 `templates/domains/{你的领域}/`。
118
+
119
+ **Q: 多个 AI 编辑器之间会冲突吗?**
120
+ A: 不会。`bin/wl-skills.js` 已自动生成 8 种主流 AI 编辑器配置文件,所有内容来自同一份 `copilot-instructions.md`,保持一致。
121
+
122
+ **Q: MCP Server 是什么?需要额外配置吗?**
123
+ A: `wl-skills init` 会自动生成 `.cursor/mcp.json`(Cursor 用)和 `.claude/settings.json`(Claude Code 用)。只需在 `.github/skills/sync/env.local.json` 里填好 `token`、`gatewayPath`、`menu.domainId` 即可。填写后重启编辑器,对 AI 说「扩展菜单」或「加字典」,AI 会自动调用接口完成同步,无需手动粘贴接口响应。
124
+
125
+ **Q: 部署到生产环境前如何清理 AI 文件?**
126
+ A: 执行 `npx @agile-team/wl-skills-kit clean`。会移除所有 AI 辅助文件,保留 `src/components/` 和 `src/types/`。
127
+
128
+ ---
129
+
130
+ ## 升级与维护
131
+
132
+ ### 增量更新
133
+
134
+ ```bash
135
+ npx @agile-team/wl-skills-kit@latest update
136
+ # 仅覆盖有变化的文件,未变文件不动
137
+ ```
138
+
139
+ ### 预览模式
140
+
141
+ 任何命令都可加 `--dry-run` 预览变更:
142
+
143
+ ```bash
144
+ npx @agile-team/wl-skills-kit update --dry-run
145
+ npx @agile-team/wl-skills-kit clean --dry-run
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Pre-flight 声明阅读指南
151
+
152
+ 每次 AI 触发 Skill 时会输出"Pre-flight 声明",告诉你它读取了哪些文件、做了哪些前置检查:
153
+
154
+ ```
155
+ 🚀 已触发技能 page-codegen/SKILL.md → 页面代码生成
156
+ ✅ 已读取 standards/13-platform-components.md → 平台组件对照表
157
+ ✅ 工具链检测:.prettierrc.js ✓ eslint.config.ts ✓ .husky/ ✓
158
+ ✅ cid 已生成:cl-745831
159
+ ```
160
+
161
+ 如果 AI 没输出此声明,说明它跳过了前置检查,**请提示它"补 Pre-flight 声明"**,或重新触发。
162
+
163
+ ---
164
+
165
+ ## 反馈与贡献
166
+
167
+ - 使用问题 / Bug:联系 CHENY(工号 409322)
168
+ - 模板贡献:使用 `template-extract` Skill 自动提取并 PR
169
+ - 规范修改:在 `standards/` 编辑后,团队评审通过后合入
170
+
171
+ ---
172
+
173
+ ## 进一步阅读
174
+
175
+ - 架构与决策记录:[architecture.md](architecture.md)
176
+ - 编辑器适配说明:`.github/skills/_compat/README.md`
@@ -1,65 +1,65 @@
1
- # Reports 目录
2
-
3
- 本目录存放 AI 生成的报告类文件。**所有写入均为追加模式,不覆盖历史。**
4
-
5
- ---
6
-
7
- ## 文件分类
8
-
9
- ### A. 系统数据文件
10
-
11
- 由生成类 Skill 写入,由同步类 Skill 读取。
12
-
13
- | 文件 | 写入方 | 读取方 | 说明 |
14
- | ---------------------------------- | ------------------ | --------------- | ---------------------- |
15
- | `SYS_MENU_INFO.md` | page-codegen | menu-sync | 页面生成时追加菜单条目 |
16
- | `SYS_DICT_INFO.md` [PLANNED] | dict-collect | dict-sync | 字典数据汇总 |
17
- | `SYS_PERMISSION_INFO.md` [PLANNED] | permission-collect | permission-sync | 权限数据汇总 |
18
-
19
- **写入规则**:每条数据带生成时间戳;新条目追加到末尾;不删除历史。
20
-
21
- ### B. 审计偏差报告
22
-
23
- | 文件 | 写入方 | 读取方 | 说明 |
24
- | ----------------- | ---------------- | ---------------------- | ----------------------- |
25
- | `规范审查报告.md` | convention-audit | 人工 review → code-fix | 不合规项清单 + 整改建议 |
26
-
27
- **写入规则**:每次审计追加**新章节在顶部**(最新在最上),时间戳分节,历史自然下沉。
28
-
29
- ### C. 提取建议报告
30
-
31
- | 文件 | 写入方 | 读取方 | 说明 |
32
- | ----------------- | ---------------- | ------------------------------ | ---------------------------- |
33
- | `组件提取建议.md` | convention-audit | 人工 review → template-extract | 跨页面复用但未封装的模式清单 |
34
-
35
- **写入规则**:同 B。
36
-
37
- ---
38
-
39
- ## 为什么追加不覆盖
40
-
41
- 1. **历史可追溯**:通过 git diff 可看到团队每次审计的变化趋势
42
- 2. **多次执行幂等**:开发者可重复触发,不丢失数据
43
- 3. **多人并行**:多人协作时不会互相覆盖
44
- 4. **数据闭环**:菜单/字典/权限同步类 Skill 依赖累积数据
45
-
46
- ---
47
-
48
- ## 安装与升级行为
49
-
50
- `bin/wl-skills.js` 对本目录的特殊处理:
51
-
52
- | 命令 | 行为 |
53
- | -------- | ---------------------------------------------------------------- |
54
- | `init` | 文件不存在时创建空模板;**已存在则跳过**(避免覆盖团队累积数据) |
55
- | `update` | 同 `init`:已存在的文件**不覆盖** |
56
- | `clean` | 默认删除(视为 AI 辅助文件);可加 `--keep-reports` 保留 |
57
-
58
- ---
59
-
60
- ## Git 管理建议
61
-
62
- - ✅ `SYS_MENU_INFO.md`、`SYS_DICT_INFO.md`、`SYS_PERMISSION_INFO.md` 提交到仓库(团队共享数据)
63
- - ⚠️ `规范审查报告.md`、`组件提取建议.md` 视团队偏好选择:
64
- - 提交:可见整改进度,PR review 时直观
65
- - 不提交:避免污染 git 历史,加入 `.gitignore`
1
+ # Reports 目录
2
+
3
+ 本目录存放 AI 生成的报告类文件。**所有写入均为追加模式,不覆盖历史。**
4
+
5
+ ---
6
+
7
+ ## 文件分类
8
+
9
+ ### A. 系统数据文件
10
+
11
+ 由生成类 Skill 写入,由同步类 Skill 读取。
12
+
13
+ | 文件 | 写入方 | 读取方 | 说明 |
14
+ | ---------------------------------- | ------------------ | --------------- | ---------------------- |
15
+ | `SYS_MENU_INFO.md` | page-codegen | menu-sync | 页面生成时追加菜单条目 |
16
+ | `SYS_DICT_INFO.md` [PLANNED] | dict-collect | dict-sync | 字典数据汇总 |
17
+ | `SYS_PERMISSION_INFO.md` [PLANNED] | permission-collect | permission-sync | 权限数据汇总 |
18
+
19
+ **写入规则**:每条数据带生成时间戳;新条目追加到末尾;不删除历史。
20
+
21
+ ### B. 审计偏差报告
22
+
23
+ | 文件 | 写入方 | 读取方 | 说明 |
24
+ | ----------------- | ---------------- | ---------------------- | ----------------------- |
25
+ | `规范审查报告.md` | convention-audit | 人工 review → code-fix | 不合规项清单 + 整改建议 |
26
+
27
+ **写入规则**:每次审计追加**新章节在顶部**(最新在最上),时间戳分节,历史自然下沉。
28
+
29
+ ### C. 提取建议报告
30
+
31
+ | 文件 | 写入方 | 读取方 | 说明 |
32
+ | ----------------- | ---------------- | ------------------------------ | ---------------------------- |
33
+ | `组件提取建议.md` | convention-audit | 人工 review → template-extract | 跨页面复用但未封装的模式清单 |
34
+
35
+ **写入规则**:同 B。
36
+
37
+ ---
38
+
39
+ ## 为什么追加不覆盖
40
+
41
+ 1. **历史可追溯**:通过 git diff 可看到团队每次审计的变化趋势
42
+ 2. **多次执行幂等**:开发者可重复触发,不丢失数据
43
+ 3. **多人并行**:多人协作时不会互相覆盖
44
+ 4. **数据闭环**:菜单/字典/权限同步类 Skill 依赖累积数据
45
+
46
+ ---
47
+
48
+ ## 安装与升级行为
49
+
50
+ `bin/wl-skills.js` 对本目录的特殊处理:
51
+
52
+ | 命令 | 行为 |
53
+ | -------- | ---------------------------------------------------------------- |
54
+ | `init` | 文件不存在时创建空模板;**已存在则跳过**(避免覆盖团队累积数据) |
55
+ | `update` | 同 `init`:已存在的文件**不覆盖** |
56
+ | `clean` | 默认删除(视为 AI 辅助文件);可加 `--keep-reports` 保留 |
57
+
58
+ ---
59
+
60
+ ## Git 管理建议
61
+
62
+ - ✅ `SYS_MENU_INFO.md`、`SYS_DICT_INFO.md`、`SYS_PERMISSION_INFO.md` 提交到仓库(团队共享数据)
63
+ - ⚠️ `规范审查报告.md`、`组件提取建议.md` 视团队偏好选择:
64
+ - 提交:可见整改进度,PR review 时直观
65
+ - 不提交:避免污染 git 历史,加入 `.gitignore`
@@ -1,50 +1,50 @@
1
- # SYS_DICT_INFO — 字典数据基线
2
-
3
- > **写入方**:`dict-sync pull` 模式从线上拉取后覆盖;`dict-sync push` 完成后追加新增字典
4
- > **读取方**:`dict-sync push / audit` 模式对比本地 vs 线上差异
5
- > **格式约定**:每个字典码一个二级标题块,字典项以表格形式列出
6
-
7
- ---
8
-
9
- ## 字典码命名规范
10
-
11
- ```
12
- 全大写 + 下划线分隔,例如:ORDER_STATUS / SALES_COMPANY / PRODUCT_NAME
13
- ```
14
-
15
- data.ts 中引用方式:
16
- ```typescript
17
- { logicType: BusLogicDataType.dict, logicValue: "ORDER_STATUS" }
18
- ```
19
-
20
- ---
21
-
22
- ## 字典数据
23
-
24
- > ⚠️ 基线为空。请执行以下任一方式初始化:
25
- >
26
- > 1. **从线上拉取**:对 AI 说「刷新字典基线」→ dict-sync pull 模式自动填充此文件
27
- > 2. **手动维护**:按以下格式手动添加,后续 push 模式以此为数据源
28
-
29
- ---
30
-
31
- <!-- 以下为示例格式,执行 pull 后将被真实数据替换 -->
32
-
33
- <!--
34
- ## ORDER_STATUS(订单状态)
35
-
36
- | 值(value) | 显示名称(label) | 排序 | 备注 |
37
- | ---------- | ---------------- | ---- | ---- |
38
- | 0 | 草稿 | 1 | |
39
- | 1 | 待审核 | 2 | |
40
- | 2 | 审核通过 | 3 | |
41
- | 3 | 已驳回 | 4 | |
42
-
43
- ## SALES_COMPANY(销售公司)
44
-
45
- | 值(value) | 显示名称(label) | 排序 | 备注 |
46
- | ---------- | ---------------- | ---- | ---- |
47
- | 01 | 华北公司 | 1 | |
48
- | 02 | 华南公司 | 2 | |
49
- -->
50
-
1
+ # SYS_DICT_INFO — 字典数据基线
2
+
3
+ > **写入方**:`dict-sync pull` 模式从线上拉取后覆盖;`dict-sync push` 完成后追加新增字典
4
+ > **读取方**:`dict-sync push / audit` 模式对比本地 vs 线上差异
5
+ > **格式约定**:每个字典码一个二级标题块,字典项以表格形式列出
6
+
7
+ ---
8
+
9
+ ## 字典码命名规范
10
+
11
+ ```
12
+ 全大写 + 下划线分隔,例如:ORDER_STATUS / SALES_COMPANY / PRODUCT_NAME
13
+ ```
14
+
15
+ data.ts 中引用方式:
16
+ ```typescript
17
+ { logicType: BusLogicDataType.dict, logicValue: "ORDER_STATUS" }
18
+ ```
19
+
20
+ ---
21
+
22
+ ## 字典数据
23
+
24
+ > ⚠️ 基线为空。请执行以下任一方式初始化:
25
+ >
26
+ > 1. **从线上拉取**:对 AI 说「刷新字典基线」→ dict-sync pull 模式自动填充此文件
27
+ > 2. **手动维护**:按以下格式手动添加,后续 push 模式以此为数据源
28
+
29
+ ---
30
+
31
+ <!-- 以下为示例格式,执行 pull 后将被真实数据替换 -->
32
+
33
+ <!--
34
+ ## ORDER_STATUS(订单状态)
35
+
36
+ | 值(value) | 显示名称(label) | 排序 | 备注 |
37
+ | ---------- | ---------------- | ---- | ---- |
38
+ | 0 | 草稿 | 1 | |
39
+ | 1 | 待审核 | 2 | |
40
+ | 2 | 审核通过 | 3 | |
41
+ | 3 | 已驳回 | 4 | |
42
+
43
+ ## SALES_COMPANY(销售公司)
44
+
45
+ | 值(value) | 显示名称(label) | 排序 | 备注 |
46
+ | ---------- | ---------------- | ---- | ---- |
47
+ | 01 | 华北公司 | 1 | |
48
+ | 02 | 华南公司 | 2 | |
49
+ -->
50
+