@agile-team/wl-skills-kit 1.2.0 → 2.1.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 (86) hide show
  1. package/CHANGELOG.md +130 -0
  2. package/README.md +169 -366
  3. package/bin/wl-skills.js +149 -43
  4. package/files/.github/copilot-instructions.md +105 -42
  5. package/files/.github/guides/README.md +13 -0
  6. package/files/.github/guides/architecture.md +555 -0
  7. package/files/.github/guides/usage.md +166 -0
  8. package/files/.github/reports/README.md +65 -0
  9. package/files/.github/reports/SYS_DICT_INFO.md +19 -0
  10. package/files/.github/reports/SYS_PERMISSION_INFO.md +20 -0
  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 -0
  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 -0
  13. package/files/.github/skills/_compat/README.md +108 -0
  14. package/files/.github/skills/_compat/editors.json +61 -0
  15. package/files/.github/skills/_compat/headers/agents.txt +8 -0
  16. package/files/.github/skills/_compat/headers/claude-code.txt +7 -0
  17. package/files/.github/skills/_compat/headers/cline.txt +7 -0
  18. package/files/.github/skills/_compat/headers/cursor-mdc.txt +16 -0
  19. package/files/.github/skills/_compat/headers/cursor-rules.txt +7 -0
  20. package/files/.github/skills/_compat/headers/github-copilot.txt +1 -0
  21. package/files/.github/skills/_compat/headers/kiro.txt +10 -0
  22. package/files/.github/skills/_compat/headers/trae.txt +11 -0
  23. package/files/.github/skills/_compat/headers/windsurf.txt +7 -0
  24. package/files/.github/skills/_registry.md +81 -0
  25. package/files/.github/skills/{api-contract → core/api-contract}/SKILL.md +126 -29
  26. package/files/.github/skills/core/api-contract/USAGE.md +110 -0
  27. package/files/.github/skills/core/convention-audit/SKILL.md +189 -0
  28. package/files/.github/skills/core/convention-audit/USAGE.md +99 -0
  29. package/files/.github/skills/{page-codegen → core/page-codegen}/SKILL.md +67 -22
  30. package/files/.github/skills/core/page-codegen/USAGE.md +102 -0
  31. package/files/.github/skills/core/page-codegen/templates/_index.md +46 -0
  32. package/files/.github/skills/core/page-codegen/templates/domains/_CONTRIBUTING.md +107 -0
  33. package/files/.github/skills/{page-codegen → core/page-codegen/templates/domains/produce}/TPL-OPERATION-STATION.md +442 -442
  34. package/files/.github/skills/core/page-codegen/templates/domains/sale/README.md +26 -0
  35. package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-DETAIL-TABS.md +94 -39
  36. package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-DRIVEN.md +124 -124
  37. package/files/.github/skills/{prototype-scan → core/prototype-scan}/SKILL.md +87 -3
  38. package/files/.github/skills/core/prototype-scan/USAGE.md +95 -0
  39. package/files/.github/skills/core/template-extract/SKILL.md +139 -0
  40. package/files/.github/skills/core/template-extract/USAGE.md +93 -0
  41. package/files/.github/skills/domain/README.md +51 -0
  42. package/files/.github/skills/ops/code-fix/SKILL.draft.md +108 -0
  43. package/files/.github/skills/sync/dict-sync/SKILL.draft.md +100 -0
  44. package/files/.github/skills/{menu-sync → sync/menu-sync}/SKILL.md +258 -258
  45. package/files/.github/skills/sync/menu-sync/USAGE.md +104 -0
  46. package/files/.github/skills/{menu-sync → sync/menu-sync}/env/guide.md +83 -83
  47. package/files/.github/skills/sync/permission-sync/SKILL.draft.md +91 -0
  48. package/files/.github/standards/01-toolchain.md +57 -0
  49. package/files/.github/standards/02-code-structure.md +111 -0
  50. package/files/.github/standards/03-comments.md +53 -0
  51. package/files/.github/standards/04-coding-basics.md +33 -0
  52. package/files/.github/standards/05-logging.md +38 -0
  53. package/files/.github/standards/06-security.md +44 -0
  54. package/files/.github/standards/07-config.md +52 -0
  55. package/files/.github/standards/08-git.md +60 -0
  56. package/files/.github/standards/09-typescript.md +71 -0
  57. package/files/.github/standards/10-pinia.md +57 -0
  58. package/files/.github/standards/11-form-validation.md +81 -0
  59. package/files/.github/standards/12-base-table.md +116 -0
  60. package/files/.github/standards/13-platform-components.md +123 -0
  61. package/files/.github/standards/index.md +89 -0
  62. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/data.ts +196 -196
  63. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.scss +150 -150
  64. package/files/demo/produce/aiflow/mmwr-customer-apply-change-history/index.vue +79 -79
  65. package/files/docs/jh-date-range.md +257 -257
  66. package/files/docs/jh-date.md +222 -222
  67. package/files/docs/jh-dept-picker.md +190 -190
  68. package/files/docs/jh-drag-row.md +590 -590
  69. package/files/docs/jh-file-upload.md +216 -216
  70. package/files/docs/jh-picker.md +218 -218
  71. package/files/docs/jh-select.md +148 -148
  72. package/files/docs/jh-text.md +248 -248
  73. package/files/docs/jh-user-picker.md +197 -197
  74. package/package.json +4 -1
  75. package/files/.github/docs/menu-sync-design.md +0 -264
  76. package/files/.github/docs/use-skill.md +0 -382
  77. package/files/.github/docs/wl-skills-kit.md +0 -266
  78. package/files/.github/skills/convention-extract/SKILL.md +0 -236
  79. /package/files/.github/{docs → reports}/SYS_MENU_INFO.md +0 -0
  80. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-CHANGE-HISTORY.md +0 -0
  81. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-FORM-ROUTE.md +0 -0
  82. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-LIST.md +0 -0
  83. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-MASTER-DETAIL.md +0 -0
  84. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-RECORD-FORM.md +0 -0
  85. /package/files/.github/skills/{page-codegen → core/page-codegen/templates/universal}/TPL-TREE-LIST.md +0 -0
  86. /package/files/.github/skills/{menu-sync → sync/menu-sync}/env/env.local.json +0 -0
@@ -0,0 +1,166 @@
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
+ ## 6 个 Skill 速览
52
+
53
+ | Skill | 触发关键词 | 用途 |
54
+ | ------------------ | ------------------------------ | ---------------------------- |
55
+ | `prototype-scan` | 扫描原型 / 解析原型 / 口述需求 | 原型 / 详设 → page-spec JSON |
56
+ | `api-contract` | 接口约定 / api.md / 字段定义 | 生成接口约定文档 |
57
+ | `page-codegen` | 生成页面 / 帮我生成 | 生成 4 文件 + 菜单注册 |
58
+ | `menu-sync` | 创建菜单 / 同步菜单 | 菜单数据同步到后端 |
59
+ | `convention-audit` | 规范审计 / 代码审计 | 13 条规范扫描 + 偏差报告 |
60
+ | `template-extract` | 提取模板 / 抽取模板 | 从现有页面沉淀领域专属模板 |
61
+
62
+ 完整调度规则见 `.github/skills/_registry.md`。
63
+
64
+ ---
65
+
66
+ ## 项目目录结构
67
+
68
+ 安装后业务项目得到的关键目录:
69
+
70
+ ```
71
+ 你的项目/
72
+ ├── .github/
73
+ │ ├── copilot-instructions.md AI 主入口
74
+ │ ├── standards/ 13 条模块化规范
75
+ │ ├── skills/ 6 个 Skill + 3 个 PLANNED 草稿
76
+ │ ├── guides/ 使用指南 + 架构设计
77
+ │ └── reports/ AI 生成报告(SYS_MENU_INFO 等)
78
+ ├── docs/ 12 个组件 API 文档(jh-* / request 等)
79
+ ├── demo/ 13 个领域样例(生产 + 销售)
80
+ └── src/
81
+ ├── components/ 全局/局部/远程组件
82
+ └── types/
83
+ ```
84
+
85
+ ---
86
+
87
+ ## 完整流水线(从原型到上线)
88
+
89
+ ```
90
+ 1. 原型/详设 → prototype-scan → page-spec JSON
91
+ 2. page-spec → api-contract → api.md
92
+ 3. api.md → page-codegen → 4 文件 + reports/SYS_MENU_INFO.md
93
+ 4. SYS_MENU_INFO → menu-sync → 后端菜单表
94
+ 5. 完成 → convention-audit → 报告 + 提取建议(人工评审)
95
+ ```
96
+
97
+ 每一步都可以单独触发,也可以按用户意图自动接续。
98
+
99
+ ---
100
+
101
+ ## 常见问题
102
+
103
+ **Q: AI 生成的代码不符合规范怎么办?**
104
+ A: 触发 `convention-audit`,输出偏差报告到 `reports/规范审查报告.md`,按 🔴 严重 → 🟡 轻微的优先级修复。
105
+
106
+ **Q: 工具链检测一直失败?**
107
+ A: 检查 `.prettierrc.js` / `eslint.config.ts` / `.husky/` 是否齐全。重新执行 `npx @robot-admin/git-standards init`,或联系 CHENY(工号 409322)。
108
+
109
+ **Q: 本团队有特殊的页面模式,通用模板不适用?**
110
+ A: 触发 `template-extract`,从现有标杆页面提取为领域专属模板,沉淀到 `templates/domains/{你的领域}/`。
111
+
112
+ **Q: 多个 AI 编辑器之间会冲突吗?**
113
+ A: 不会。`bin/wl-skills.js` 已自动生成 8 种主流 AI 编辑器配置文件,所有内容来自同一份 `copilot-instructions.md`,保持一致。
114
+
115
+ **Q: 部署到生产环境前如何清理 AI 文件?**
116
+ A: 执行 `npx @agile-team/wl-skills-kit clean`。会移除所有 AI 辅助文件,保留 `src/components/` 和 `src/types/`。
117
+
118
+ ---
119
+
120
+ ## 升级与维护
121
+
122
+ ### 增量更新
123
+
124
+ ```bash
125
+ npx @agile-team/wl-skills-kit@latest update
126
+ # 仅覆盖有变化的文件,未变文件不动
127
+ ```
128
+
129
+ ### 预览模式
130
+
131
+ 任何命令都可加 `--dry-run` 预览变更:
132
+
133
+ ```bash
134
+ npx @agile-team/wl-skills-kit update --dry-run
135
+ npx @agile-team/wl-skills-kit clean --dry-run
136
+ ```
137
+
138
+ ---
139
+
140
+ ## Pre-flight 声明阅读指南
141
+
142
+ 每次 AI 触发 Skill 时会输出"Pre-flight 声明",告诉你它读取了哪些文件、做了哪些前置检查:
143
+
144
+ ```
145
+ 🚀 已触发技能 page-codegen/SKILL.md → 页面代码生成
146
+ ✅ 已读取 standards/13-platform-components.md → 平台组件对照表
147
+ ✅ 工具链检测:.prettierrc.js ✓ eslint.config.ts ✓ .husky/ ✓
148
+ ✅ cid 已生成:cl-745831
149
+ ```
150
+
151
+ 如果 AI 没输出此声明,说明它跳过了前置检查,**请提示它"补 Pre-flight 声明"**,或重新触发。
152
+
153
+ ---
154
+
155
+ ## 反馈与贡献
156
+
157
+ - 使用问题 / Bug:联系 CHENY(工号 409322)
158
+ - 模板贡献:使用 `template-extract` Skill 自动提取并 PR
159
+ - 规范修改:在 `standards/` 编辑后,团队评审通过后合入
160
+
161
+ ---
162
+
163
+ ## 进一步阅读
164
+
165
+ - 架构与决策记录:[architecture.md](architecture.md)
166
+ - 编辑器适配说明:`.github/skills/_compat/README.md`
@@ -0,0 +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`
@@ -0,0 +1,19 @@
1
+ # SYS_DICT_INFO — 字典数据汇总 [PLANNED]
2
+
3
+ > ⚠️ 本文件为 [PLANNED] 状态。等 `dict-sync` Skill 转正后启用。
4
+ >
5
+ > 设计草稿:`.github/skills/sync/dict-sync/SKILL.draft.md`
6
+
7
+ ---
8
+
9
+ ## 预期格式
10
+
11
+ ```markdown
12
+ | 字典编码 | 字典名称 | 字典项编码 | 字典项名称 | 排序 | 备注 |
13
+ | -------- | -------- | ---------- | ---------- | ---- | ---- |
14
+ | status | 状态 | 1 | 启用 | 1 | |
15
+ | status | 状态 | 0 | 停用 | 2 | |
16
+ ```
17
+
18
+ 写入方:dict-collect Skill(PLANNED)从代码扫描汇总
19
+ 读取方:dict-sync Skill(PLANNED)调用后端批量导入接口
@@ -0,0 +1,20 @@
1
+ # SYS_PERMISSION_INFO — 权限数据汇总 [PLANNED]
2
+
3
+ > ⚠️ 本文件为 [PLANNED] 状态。等 `permission-sync` Skill 转正后启用。
4
+ >
5
+ > 设计草稿:`.github/skills/sync/permission-sync/SKILL.draft.md`
6
+
7
+ ---
8
+
9
+ ## 预期格式
10
+
11
+ ```markdown
12
+ | 菜单 | 按钮 | 权限码 | 权限标识 | 备注 |
13
+ | -------- | ---- | -------------------- | ---------- | ---- |
14
+ | 客户档案 | 新增 | mmwr:customer:add | btn-add | |
15
+ | 客户档案 | 编辑 | mmwr:customer:edit | btn-edit | |
16
+ | 客户档案 | 删除 | mmwr:customer:delete | btn-delete | |
17
+ ```
18
+
19
+ 写入方:page-codegen / permission-collect(PLANNED)
20
+ 读取方:permission-sync Skill(PLANNED)
@@ -0,0 +1,33 @@
1
+ # 组件提取建议
2
+
3
+ > 由 `convention-audit` Skill 自动追加写入。识别**跨 3+ 页面相同的未封装模式**,输出提取建议供人工评审。
4
+ >
5
+ > ⚠️ 本文件中的建议**不自动执行**。人工评审通过后,触发 `template-extract` Skill(页面级)或手动封装为 `c_*` 组件(组件级)。
6
+
7
+ ---
8
+
9
+ <!--
10
+ 追加格式示例:
11
+
12
+ ## 🕐 2026-04-26 14:30 | 范围:src/views/
13
+
14
+ ### 📦 组件提取建议(共 N 处)
15
+
16
+ | 建议组件名 | 出现次数 | 页面路径 | 菜单位置 | 模式描述 |
17
+ | -------------- | -------- | ------------------------------------------ | ----------------------- | ------------------ |
18
+ | c_statusBadge | 5 处 | src/views/sale/.../{a,b,c,d,e}/index.vue | 销售管理 > 多个子菜单 | 状态枚举彩色标签 |
19
+ | c_priceFormat | 4 处 | src/views/.../... | ... | 千分位金额显示 |
20
+ | c_addressInput | 3 处 | src/views/.../... | ... | 省市区联动选择器 |
21
+
22
+ **评审建议**:
23
+
24
+ - c_statusBadge:模式简单且高频,建议立即封装到 `src/components/local/c_statusBadge/`
25
+ - c_priceFormat:建议先评估是否可用现有 `jh-text` + 格式化指令实现
26
+ - c_addressInput:业务耦合度高,建议保持现状,1 年后再评估
27
+
28
+ ---
29
+
30
+ (旧报告章节)
31
+ -->
32
+
33
+ > 本文件初始为空。首次执行 convention-audit 后,将自动填入提取建议。
@@ -0,0 +1,44 @@
1
+ # 规范审查报告
2
+
3
+ > 由 `convention-audit` Skill 自动追加写入。**最新章节在顶部**,历史章节自然下沉。
4
+ >
5
+ > 整改优先级:🔴 严重 → 🟡 轻微 → 🟢 提示
6
+
7
+ ---
8
+
9
+ <!--
10
+ 追加格式示例(AI 生成时按此格式插入到文件顶部 ## 之前):
11
+
12
+ ## 🕐 2026-04-26 14:30 | 范围:src/views/sale/ | 触发:user
13
+
14
+ ### 概要
15
+ | 指标 | 值 |
16
+ |------|---|
17
+ | 扫描页面 | 12 |
18
+ | 合规页面 | 8 |
19
+ | 偏差页面 | 4 |
20
+ | 🔴 严重 | 5 |
21
+ | 🟡 轻微 | 7 |
22
+
23
+ ### 🔴 严重偏差(必须整改)
24
+
25
+ #### src/views/sale/.../customer-list/index.vue — 违反规范 13(平台组件合规)
26
+ - **菜单位置**(来自文件头):销售管理 > 客户档案
27
+ - **现状**:使用 `<el-table>` 渲染数据
28
+ - **应为**:使用 `<BaseTable render-type="agGrid" cid="...">`
29
+ - **整改建议**:参考 templates/universal/TPL-LIST.md
30
+ - **修复标记**:🔧 待修复
31
+
32
+ ### 🟡 轻微偏差
33
+
34
+ (同格式)
35
+
36
+ ### ✅ 合规页面
37
+ - src/views/produce/.../mmwr-customer-archive/
38
+
39
+ ---
40
+
41
+ (旧报告章节)
42
+ -->
43
+
44
+ > 本文件初始为空。首次执行 convention-audit 后,将自动填入审查内容。
@@ -0,0 +1,108 @@
1
+ # \_compat — 多 AI 编辑器适配层
2
+
3
+ > ⚠️ **本目录是配置层,不是说明文档。**
4
+ > `bin/wl-skills.js` 在 `init` / `update` 时读取本目录的模板,**生成业务项目根目录下各 AI 编辑器需要的配置文件**。
5
+
6
+ ---
7
+
8
+ ## 设计原则
9
+
10
+ 1. **解耦**:每个 AI 编辑器的配置文件**独立**,移除/新增任意编辑器不影响其他
11
+ 2. **零污染**:每个编辑器**只读自己的配置文件**,不会读到其他编辑器的内容
12
+ 3. **特化注入**:各编辑器的 frontmatter / 头部规范由对应模板决定(Cursor 需 `description+globs+alwaysApply`,Kiro 需 `inclusion`,Trae 需 `description`,Cline/Windsurf 无 frontmatter)
13
+ 4. **内容统一**:所有编辑器的"主体内容"来自 `copilot-instructions.md`,**单一数据源**修改一处全员同步
14
+
15
+ ---
16
+
17
+ ## 目录结构
18
+
19
+ ```
20
+ _compat/
21
+ ├── README.md ← 本文件
22
+ ├── editors.json ← 编辑器注册表(bin/wl-skills.js 读取)
23
+ └── headers/ ← 各编辑器特化头部模板
24
+ ├── github-copilot.txt
25
+ ├── claude-code.txt
26
+ ├── cursor-rules.txt (.cursorrules 用,无 frontmatter)
27
+ ├── cursor-mdc.txt (.cursor/rules/conventions.mdc 用,含 frontmatter)
28
+ ├── windsurf.txt
29
+ ├── cline.txt
30
+ ├── kiro.txt (.kiro/steering/conventions.md,含 frontmatter)
31
+ ├── trae.txt (.trae/rules/conventions.md,含 frontmatter)
32
+ └── agents.txt (AGENTS.md 通用代理)
33
+ ```
34
+
35
+ ---
36
+
37
+ ## 工作流程
38
+
39
+ ```
40
+ bin/wl-skills.js (init/update)
41
+
42
+ ├─ 读取 files/.github/copilot-instructions.md → MAIN_BODY
43
+
44
+ ├─ 读取 _compat/editors.json → 编辑器列表
45
+
46
+ └─ 对每个 editor in editors.json:
47
+ ├─ 读取 headers/{editor.headerFile} → HEADER(含特化 frontmatter)
48
+ ├─ 拼接:HEADER + AUTO_HEADER_NOTE + MAIN_BODY
49
+ └─ 写入到业务项目:editor.outputPath
50
+ ```
51
+
52
+ ---
53
+
54
+ ## 解耦验证
55
+
56
+ | 场景 | 受影响文件 | 不受影响文件 |
57
+ | ------------------------------------- | ----------------------------- | --------------------------- |
58
+ | 团队不用 Cursor,从 editors.json 删除 | `.cursorrules`、`.cursor/` | `.github/`、CLAUDE.md、其他 |
59
+ | 团队新增某 AI 编辑器(如 Augment) | 加 headers/augment.txt + 注册 | 其他文件不动 |
60
+ | `copilot-instructions.md` 内容更新 | 全部 8 个根配置同步更新 | headers/ 不变(只是模板) |
61
+
62
+ ---
63
+
64
+ ## 修改 / 扩展示例
65
+
66
+ ### 添加新编辑器(如 Augment)
67
+
68
+ 1. 在 `headers/` 创建 `augment.txt`(含该编辑器要求的 frontmatter)
69
+ 2. 在 `editors.json` 追加:
70
+ ```json
71
+ {
72
+ "name": "augment",
73
+ "headerFile": "augment.txt",
74
+ "outputPath": ".augment/rules.md",
75
+ "enabled": true
76
+ }
77
+ ```
78
+ 3. `npm publish`,业务项目执行 `update` 即可
79
+
80
+ ### 临时禁用某编辑器
81
+
82
+ ```json
83
+ {
84
+ "name": "kiro",
85
+ "headerFile": "kiro.txt",
86
+ "outputPath": ".kiro/...",
87
+ "enabled": false
88
+ }
89
+ ```
90
+
91
+ `enabled: false` 的编辑器**不生成**对应根配置文件,已存在的用户可手动删除。
92
+
93
+ ---
94
+
95
+ ## 与官方机制的对应关系(截至 2026-04)
96
+
97
+ | 编辑器 | 官方加载路径 | 是否需要 frontmatter | 备注 |
98
+ | -------------- | -------------------------------------- | -------------------- | -------------------------------- |
99
+ | GitHub Copilot | `.github/copilot-instructions.md` | ❌ | 唯一识别 .github/ 子目录的编辑器 |
100
+ | Claude Code | `CLAUDE.md` (root) | ❌ | 自动加载根目录 CLAUDE.md |
101
+ | Cursor | `.cursorrules` + `.cursor/rules/*.mdc` | ❌ / ✅ | 双形式,新版 mdc 需 frontmatter |
102
+ | Windsurf | `.windsurfrules` (root) | ❌ | 单文件 |
103
+ | Cline | `.clinerules` (root) | ❌ | 单文件 |
104
+ | Kiro | `.kiro/steering/*.md` | ✅ | 需 inclusion 字段 |
105
+ | Trae | `.trae/rules/*.md` | ✅ | 需 description 字段 |
106
+ | 通用 Agent | `AGENTS.md` (root) | ❌ | 新兴跨平台规范 |
107
+
108
+ > 所有这些编辑器在加载完根配置后,**都支持按指令读取项目内任意文件**(含 `.github/standards/`、`.github/skills/`、`.github/guides/`),所以本架构的"懒加载门控 + 子目录规范"对所有编辑器**有效**。
@@ -0,0 +1,61 @@
1
+ {
2
+ "_comment": "AI 编辑器注册表 — bin/wl-skills.js 读取此文件决定生成哪些配置。要新增/移除编辑器,改这里。",
3
+ "version": "1.0.0",
4
+ "editors": [
5
+ {
6
+ "name": "github-copilot",
7
+ "headerFile": "github-copilot.txt",
8
+ "outputPath": ".github/copilot-instructions.md",
9
+ "enabled": true,
10
+ "_note": "Copilot 唯一识别 .github/ 的编辑器。该文件实际就是 files/.github/copilot-instructions.md 直接复制,不加 header。"
11
+ },
12
+ {
13
+ "name": "claude-code",
14
+ "headerFile": "claude-code.txt",
15
+ "outputPath": "CLAUDE.md",
16
+ "enabled": true
17
+ },
18
+ {
19
+ "name": "cursor-rules",
20
+ "headerFile": "cursor-rules.txt",
21
+ "outputPath": ".cursorrules",
22
+ "enabled": true
23
+ },
24
+ {
25
+ "name": "cursor-mdc",
26
+ "headerFile": "cursor-mdc.txt",
27
+ "outputPath": ".cursor/rules/conventions.mdc",
28
+ "enabled": true
29
+ },
30
+ {
31
+ "name": "windsurf",
32
+ "headerFile": "windsurf.txt",
33
+ "outputPath": ".windsurfrules",
34
+ "enabled": true
35
+ },
36
+ {
37
+ "name": "cline",
38
+ "headerFile": "cline.txt",
39
+ "outputPath": ".clinerules",
40
+ "enabled": true
41
+ },
42
+ {
43
+ "name": "kiro",
44
+ "headerFile": "kiro.txt",
45
+ "outputPath": ".kiro/steering/conventions.md",
46
+ "enabled": true
47
+ },
48
+ {
49
+ "name": "trae",
50
+ "headerFile": "trae.txt",
51
+ "outputPath": ".trae/rules/conventions.md",
52
+ "enabled": true
53
+ },
54
+ {
55
+ "name": "agents-generic",
56
+ "headerFile": "agents.txt",
57
+ "outputPath": "AGENTS.md",
58
+ "enabled": true
59
+ }
60
+ ]
61
+ }
@@ -0,0 +1,8 @@
1
+ # AGENTS.md — 通用代理协议(项目编码规范)
2
+
3
+ > 此文件遵循 [agents.md 跨编辑器协议](https://agents.md),可被任意支持该协议的 AI 代理读取。
4
+ > 由 @agile-team/wl-skills-kit 自动生成。源文件:`.github/copilot-instructions.md`
5
+ > 更新方式:`npx @agile-team/wl-skills-kit@latest update`
6
+
7
+ ---
8
+
@@ -0,0 +1,7 @@
1
+ # Claude Code 项目编码规范
2
+
3
+ > 此文件由 `@agile-team/wl-skills-kit` 自动生成。源文件:`.github/copilot-instructions.md`
4
+ > 请勿手动编辑本文件,更新时执行:`npx @agile-team/wl-skills-kit@latest update`
5
+
6
+ ---
7
+
@@ -0,0 +1,7 @@
1
+ # Cline 项目编码规范(.clinerules)
2
+
3
+ > 由 @agile-team/wl-skills-kit 自动生成。请勿手动编辑。
4
+ > 更新方式:npx @agile-team/wl-skills-kit@latest update
5
+
6
+ ---
7
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ description: "项目编码规范(13 条标准 + 6 个 Skill 自动调度,由 wl-skills-kit 自动生成)"
3
+ globs:
4
+ - "**/*.vue"
5
+ - "**/*.ts"
6
+ - "**/*.tsx"
7
+ - "**/*.js"
8
+ - "**/*.scss"
9
+ alwaysApply: true
10
+ ---
11
+
12
+ <!-- Cursor MDC 规则文件。由 @agile-team/wl-skills-kit 自动生成。 -->
13
+ <!-- 源文件:.github/copilot-instructions.md,更新方式:npx @agile-team/wl-skills-kit@latest update -->
14
+
15
+ ---
16
+
@@ -0,0 +1,7 @@
1
+ # Cursor 项目编码规范(.cursorrules)
2
+
3
+ > 由 @agile-team/wl-skills-kit 自动生成。请勿手动编辑。
4
+ > 更新方式:npx @agile-team/wl-skills-kit@latest update
5
+
6
+ ---
7
+
@@ -0,0 +1 @@
1
+ <!-- GitHub Copilot 自动加载 .github/copilot-instructions.md,无需特化 header。bin/wl-skills.js 对此编辑器实际是直接复制源文件,不附加任何头部。-->
@@ -0,0 +1,10 @@
1
+ ---
2
+ inclusion: always
3
+ description: 项目编码规范(13 条标准 + 6 个 Skill 自动调度)
4
+ ---
5
+
6
+ <!-- Kiro Steering 规则。由 @agile-team/wl-skills-kit 自动生成。-->
7
+ <!-- 源文件:.github/copilot-instructions.md,更新方式:npx @agile-team/wl-skills-kit@latest update -->
8
+
9
+ ---
10
+
@@ -0,0 +1,11 @@
1
+ ---
2
+ description: "项目编码规范(13 条标准 + 6 个 Skill 自动调度,由 wl-skills-kit 自动生成)"
3
+ globs: ["**/*.vue", "**/*.ts", "**/*.tsx", "**/*.js", "**/*.scss"]
4
+ alwaysApply: true
5
+ ---
6
+
7
+ <!-- Trae Rules 规则。由 @agile-team/wl-skills-kit 自动生成。-->
8
+ <!-- 源文件:.github/copilot-instructions.md,更新方式:npx @agile-team/wl-skills-kit@latest update -->
9
+
10
+ ---
11
+
@@ -0,0 +1,7 @@
1
+ # Windsurf 项目编码规范(.windsurfrules)
2
+
3
+ > 由 @agile-team/wl-skills-kit 自动生成。请勿手动编辑。
4
+ > 更新方式:npx @agile-team/wl-skills-kit@latest update
5
+
6
+ ---
7
+