@agile-team/wl-skills-kit 1.1.0 → 1.1.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.
- package/CHANGELOG.md +8 -0
- package/README.md +48 -1
- package/files/.github/docs/wl-skills-kit.md +266 -266
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.1.1] - 2026-04-09
|
|
4
|
+
|
|
5
|
+
### 修复
|
|
6
|
+
|
|
7
|
+
- 修复 wl-skills-kit.md 中 10 处 `@jhlc/wl-skills-kit` 过时包名引用 → `@agile-team/wl-skills-kit`
|
|
8
|
+
- README 新增「多编辑器 / AI 工具支持」章节，详细说明 8 个编辑器的使用姿势差异
|
|
9
|
+
- License 从 MIT 改为 UNLICENSED（内部使用）
|
|
10
|
+
|
|
3
11
|
## [1.1.0] - 2026-04-09
|
|
4
12
|
|
|
5
13
|
### 新增：多编辑器支持（v1.1）
|
package/README.md
CHANGED
|
@@ -206,6 +206,53 @@ npx @agile-team/wl-skills-kit
|
|
|
206
206
|
|
|
207
207
|
---
|
|
208
208
|
|
|
209
|
+
## 多编辑器 / AI 工具支持
|
|
210
|
+
|
|
211
|
+
安装后自动生成 **8 个编辑器配置文件**，内容统一来自 `copilot-instructions.md`（单一源头），确保所有 AI 工具读取到相同的项目规范。
|
|
212
|
+
|
|
213
|
+
### 各工具配置一览
|
|
214
|
+
|
|
215
|
+
| AI 工具 | 配置文件路径 | 规范加载 | Skill 识别 | 备注 |
|
|
216
|
+
|---------|-------------|---------|-----------|------|
|
|
217
|
+
| **GitHub Copilot** (VS Code) | `.github/copilot-instructions.md` | ✅ 自动 | ✅ 自动识别 `.github/skills/*/SKILL.md` | **主力工具，体验最完整** |
|
|
218
|
+
| **Cursor** | `.cursorrules` + `.cursor/rules/conventions.mdc` | ✅ 自动 | ⚠️ 需手动 `@file` 引用 SKILL.md | `.mdc` 带 `alwaysApply: true` 前缀 |
|
|
219
|
+
| **Windsurf (Cascade)** | `.windsurfrules` | ✅ 自动 | ⚠️ 需手动 `@context` 引用 SKILL.md | Windsurf 不支持 skill 目录扫描 |
|
|
220
|
+
| **Kiro** | `.kiro/steering/conventions.md` | ✅ 自动 | ⚠️ 需手动引用 | steering/ 下的 md 自动加载 |
|
|
221
|
+
| **Trae** | `.trae/rules/conventions.md` | ✅ 自动 | ⚠️ 需手动引用 | rules/ 下的 md 自动加载 |
|
|
222
|
+
| **Claude Code / CLI** | `CLAUDE.md` | ✅ 自动 | ⚠️ 需 `@import` 或手动引用 | 支持 `@import` 语法 |
|
|
223
|
+
| **Roo Code / Cline** | `.clinerules` | ✅ 自动 | ⚠️ 需手动引用 | 支持 tool_use 读文件 |
|
|
224
|
+
| **AGENTS.md 兼容** | `AGENTS.md` | ✅ 自动 | ⚠️ 需手动引用 | Linux Foundation 通用标准，兜底 |
|
|
225
|
+
|
|
226
|
+
### 各工具使用姿势差异
|
|
227
|
+
|
|
228
|
+
**GitHub Copilot**（VS Code）— 开箱即用，无需额外配置：
|
|
229
|
+
- 规范 → 自动加载 `.github/copilot-instructions.md`
|
|
230
|
+
- Skill → 自动识别 `.github/skills/*/SKILL.md`，对话中说"帮我生成页面"即触发
|
|
231
|
+
- docs/demo → AI 可通过 `@workspace` 自动搜索
|
|
232
|
+
|
|
233
|
+
**Cursor** — 规范自动加载，Skill 需手动引用：
|
|
234
|
+
- 规范 → `.cursorrules` 和 `.cursor/rules/*.mdc` 自动加载
|
|
235
|
+
- Skill → 对话中用 `@file .github/skills/page-codegen/SKILL.md` 手动引入
|
|
236
|
+
- 或在 `.cursor/rules/` 下新建 `.mdc` 文件 include SKILL 内容
|
|
237
|
+
|
|
238
|
+
**Windsurf** — 规范自动加载，Skill 需 `@context`：
|
|
239
|
+
- 规范 → `.windsurfrules` 自动加载
|
|
240
|
+
- Skill → 对话中用 `@context` 添加 SKILL.md 文件
|
|
241
|
+
- Windsurf Cascade 可读取项目文件，但不主动扫描 `.github/skills/`
|
|
242
|
+
|
|
243
|
+
**Claude Code / CLI** — 规范自动加载，Skill 推荐 `@import`：
|
|
244
|
+
- 规范 → `CLAUDE.md` 自动加载
|
|
245
|
+
- Skill → 在 `CLAUDE.md` 末尾追加 `@import .github/skills/page-codegen/SKILL.md`
|
|
246
|
+
- 或对话中 `/read .github/skills/page-codegen/SKILL.md`
|
|
247
|
+
|
|
248
|
+
**Kiro / Trae / Roo(Cline)** — 规范自动加载，Skill 需对话中引用：
|
|
249
|
+
- 规范 → 各自的 steering/rules/.clinerules 默认加载
|
|
250
|
+
- Skill → 需要在对话中让 AI 读取对应 SKILL.md
|
|
251
|
+
|
|
252
|
+
> **总结**：所有工具的**编码规范**均自动加载（零配置）。差异仅在 **Skill 触发方式**上 — 只有 GitHub Copilot 完全自动识别 Skill，其他工具需在对话中手动引用 SKILL.md 文件。
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
209
256
|
## 安装行为说明
|
|
210
257
|
|
|
211
258
|
| ✅ 会做 | ❌ 不会做 |
|
|
@@ -325,4 +372,4 @@ npx . --dry-run # 本地预览
|
|
|
325
372
|
|
|
326
373
|
## License
|
|
327
374
|
|
|
328
|
-
|
|
375
|
+
UNLICENSED — 内部使用，未授权外部分发。
|
|
@@ -1,266 +1,266 @@
|
|
|
1
|
-
# wl-skills-kit — AI Skill 模板包
|
|
2
|
-
|
|
3
|
-
> 统一维护、一键分发：AI 指令 + 组件文档 + 通用组件 + 领域样例。
|
|
4
|
-
> 安装即导入，无副作用，各项目通过 `npx @
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 一、定位
|
|
9
|
-
|
|
10
|
-
**wl-skills-kit** 是公司前端 AI 生态的基础设施包。
|
|
11
|
-
|
|
12
|
-
| 是什么 | 不是什么 |
|
|
13
|
-
| ---------------------------------------- | ----------------------------------- |
|
|
14
|
-
| 文件模板包，安装后按目录结构导入项目 | 不是运行时依赖 |
|
|
15
|
-
| AI 指令 + 文档 + 组件 + 样例的统一维护源 | 不修改 package.json / node_modules |
|
|
16
|
-
| 各项目同步更新的唯一通道 | 不执行 postinstall / 不删除任何文件 |
|
|
17
|
-
|
|
18
|
-
**一句话**：`npx @
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 二、包目录结构
|
|
23
|
-
|
|
24
|
-
```
|
|
25
|
-
@
|
|
26
|
-
├── package.json ← name: "@
|
|
27
|
-
├── README.md
|
|
28
|
-
├── CHANGELOG.md
|
|
29
|
-
├── bin/
|
|
30
|
-
│ └── wl-skills.js ← CLI 入口（文件拷贝 + 进度提示）
|
|
31
|
-
│
|
|
32
|
-
└── files/ ← 1:1 映射到目标项目根目录
|
|
33
|
-
│
|
|
34
|
-
├── .github/ ← ① AI 指令（核心）
|
|
35
|
-
│ ├── copilot-instructions.md ← 项目规范总纲
|
|
36
|
-
│ ├── skills/
|
|
37
|
-
│ │ ├── prototype-scan/SKILL.md ← 原型扫描
|
|
38
|
-
│ │ ├── api-contract/SKILL.md ← 接口约定
|
|
39
|
-
│ │ ├── page-codegen/ ← 页面代码生成
|
|
40
|
-
│ │ │ ├── SKILL.md ← 主规则（~825 行）
|
|
41
|
-
│ │ │ └── TPL-*.md ← 9 个模板（LIST / FORM-ROUTE / MASTER-DETAIL /
|
|
42
|
-
│ │ │ TREE-LIST / DETAIL-TABS / CHANGE-HISTORY /
|
|
43
|
-
│ │ │ RECORD-FORM / OPERATION-STATION / DRIVEN）
|
|
44
|
-
│ │ ├── menu-sync/
|
|
45
|
-
│ │ │ ├── SKILL.md ← 菜单同步
|
|
46
|
-
│ │ │ └── env/guide.md ← env.local.json 配置说明（json 本身不分发）
|
|
47
|
-
│ │ └── convention-extract/SKILL.md ← 规范提炼
|
|
48
|
-
│ └── docs/
|
|
49
|
-
│ ├── use-skill.md ← 使用 + 移植一站式指南
|
|
50
|
-
│ ├── menu-sync-design.md ← 菜单同步方案设计
|
|
51
|
-
│ ├── SYS_MENU_INFO.md ← 菜单注册记录模板
|
|
52
|
-
│ └── wl-skills-kit.md ← 本文档
|
|
53
|
-
│
|
|
54
|
-
├── docs/ ← ② 组件文档（12 个 md）
|
|
55
|
-
│ ├── request.md ← HTTP 请求工具
|
|
56
|
-
│ ├── page-query-hook-best-practices.md
|
|
57
|
-
│ ├── jh-select.md / jh-date.md / jh-date-range.md
|
|
58
|
-
│ ├── jh-drag-row.md / jh-pagination.md / jh-file-upload.md
|
|
59
|
-
│ └── jh-text.md / jh-user-picker.md / jh-dept-picker.md / jh-picker.md
|
|
60
|
-
│
|
|
61
|
-
├── src/
|
|
62
|
-
│ ├── components/ ← ③ 通用组件
|
|
63
|
-
│ │ ├── global/ ← C_Splitter / C_Tree / C_TagStatus
|
|
64
|
-
│ │ │ C_ParentView / C_SvgIcon / C_RightToolbar
|
|
65
|
-
│ │ ├── local/ ← c_formModal / c_formSections
|
|
66
|
-
│ │ │ c_listModal / c_spliterTitle
|
|
67
|
-
│ │ └── remote/ ← BaseQuery / BaseTable / BaseToolbar
|
|
68
|
-
│ │ BaseForm / AGGrid（仅 README）
|
|
69
|
-
│ └── types/page.ts ← ④ 类型桶文件
|
|
70
|
-
│
|
|
71
|
-
└── demo/ ← ⑤ 领域样例（AI 学习 + 开发参考）
|
|
72
|
-
├── README.md ← 样例索引 + 模板类型标注
|
|
73
|
-
├── produce/
|
|
74
|
-
│ └── aiflow/ ← 生产域 8 个页面
|
|
75
|
-
│ ├── mmwr-customer-archive/ ← LIST + Tabs + c_formModal
|
|
76
|
-
│ ├── mmwr-temp-customer-archive/ ← LIST
|
|
77
|
-
│ ├── mmwr-customer-apply-add/ ← LIST
|
|
78
|
-
│ ├── mmwr-customer-apply-add-form/ ← FORM_ROUTE
|
|
79
|
-
│ ├── mmwr-customer-apply-change/ ← LIST
|
|
80
|
-
│ ├── mmwr-customer-apply-change-form/ ← FORM_ROUTE
|
|
81
|
-
│ ├── mmwr-customer-apply-change-history/ ← CHANGE_HISTORY
|
|
82
|
-
│ └── mmwr-customer-detail/ ← DETAIL_TABS
|
|
83
|
-
└── sale/
|
|
84
|
-
└── demo/ ← 销售域 5 个页面（平台默认样例）
|
|
85
|
-
├── domestic-trade-order/ ← LIST 标准列表
|
|
86
|
-
├── metallurgical-spec/ ← MASTER_DETAIL 上下分栏
|
|
87
|
-
├── add-demo/ ← FORM_ROUTE（c_formSections）
|
|
88
|
-
├── billet-flame-cut-plan/ ← LIST 变体
|
|
89
|
-
└── heat-batch-return/ ← LIST + 自定义弹窗
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
> `files/` 下所有内容按原始路径写入项目根目录。**仅此而已，无其他逻辑。**
|
|
93
|
-
|
|
94
|
-
### 不分发的内容
|
|
95
|
-
|
|
96
|
-
| 路径 | 原因 |
|
|
97
|
-
| ------------------------------------------- | ---------------------------------------- |
|
|
98
|
-
| `src/components/template/*` | 高阶封装，v2.0 稳定后再纳入 |
|
|
99
|
-
| `src/components/local/c_customerTabs/` | 客户域专用 |
|
|
100
|
-
| `src/components/local/c_applyDetailDialog/` | 客户域专用 |
|
|
101
|
-
| `src/components/local/c_actionModal/` | 客户域专用 |
|
|
102
|
-
| `menu-sync/env/env.local.json` | 含 Token，各项目本地维护（已 gitignore） |
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
## 三、使用方式
|
|
107
|
-
|
|
108
|
-
```bash
|
|
109
|
-
# 安装 / 初始化（首次）
|
|
110
|
-
npx @
|
|
111
|
-
|
|
112
|
-
# 同步更新（拉取最新模板）
|
|
113
|
-
npx @
|
|
114
|
-
|
|
115
|
-
# 预览变更（不写入，仅输出文件列表）
|
|
116
|
-
npx @
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
| ✅ 做什么 | ❌ 不做什么 |
|
|
120
|
-
| ------------------------------ | -------------------- |
|
|
121
|
-
| 写入 .github/ docs/ src/ demo/ | 不修改 package.json |
|
|
122
|
-
| 覆盖同名文件 | 不修改 node_modules/ |
|
|
123
|
-
| 创建不存在的目录 | 不执行 postinstall |
|
|
124
|
-
| | 不删除任何文件 |
|
|
125
|
-
|
|
126
|
-
### 安全路径（不会被覆盖）
|
|
127
|
-
|
|
128
|
-
以下路径不在分发范围内，本地修改永远安全：
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
.github/skills/my-domain-skill/ ← 自定义 Skill（非内置名）
|
|
132
|
-
.github/docs/my-domain-doc.md ← 自定义文档
|
|
133
|
-
src/components/local/my_custom/ ← 自定义组件
|
|
134
|
-
src/views/ ← 业务页面
|
|
135
|
-
mock/ ← Mock 数据
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
| 修改类型 | 做法 |
|
|
139
|
-
| -------- | --------------------------------------------------- |
|
|
140
|
-
| 通用改进 | **提 PR 到 wl-skills-kit 仓库**，合并后所有项目受益 |
|
|
141
|
-
| 领域专有 | 放在上述安全路径，不会被覆盖 |
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
|
|
145
|
-
## 四、多编辑器支持
|
|
146
|
-
|
|
147
|
-
v1.0 聚焦 **GitHub Copilot**（`.github/` 目录即完整配置）。
|
|
148
|
-
|
|
149
|
-
v1.1 实现：CLI 安装时自动从 `.github/copilot-instructions.md` **动态生成**各编辑器配置文件。单一源头，更新 `copilot-instructions.md` 后重新运行即同步所有编辑器配置。
|
|
150
|
-
|
|
151
|
-
| 编辑器 | 配置路径 | 状态 |
|
|
152
|
-
| ------------------ | -------------------------------------------------------------- | ------- |
|
|
153
|
-
| **GitHub Copilot** | `.github/copilot-instructions.md` + `skills/` | ✅ v1.0 |
|
|
154
|
-
| **Cursor** | `.cursorrules` + `.cursor/rules/conventions.mdc` (alwaysApply) | ✅ v1.1 |
|
|
155
|
-
| **Windsurf** | `.windsurfrules` | ✅ v1.1 |
|
|
156
|
-
| **Kiro** | `.kiro/steering/conventions.md` | ✅ v1.1 |
|
|
157
|
-
| **Trae** | `.trae/rules/conventions.md` | ✅ v1.1 |
|
|
158
|
-
| **Claude Code** | `CLAUDE.md` | ✅ v1.1 |
|
|
159
|
-
| **Roo / Cline** | `.clinerules` | ✅ v1.1 |
|
|
160
|
-
| **AGENTS.md** | `AGENTS.md`（Linux Foundation 标准，通用兜底） | ✅ v1.1 |
|
|
161
|
-
|
|
162
|
-
> **原则**：AGENTS.md 是跨工具兜底标准，新工具出来大概率支持它。
|
|
163
|
-
|
|
164
|
-
---
|
|
165
|
-
|
|
166
|
-
## 五、发布策略
|
|
167
|
-
|
|
168
|
-
| 方式 | 场景 | 命令 |
|
|
169
|
-
| -------------------- | ----------- | ---------------------------------------------------- |
|
|
170
|
-
| **npm 公有**（优先） | 公开发布 | `npm publish --access public` |
|
|
171
|
-
| **私有 npm**（备选） | 内网团队 | `npm config set @
|
|
172
|
-
| **Git 直装** | 无 npm 仓库 | `npx git+http://git.nisco.cn/PSQF/wl-skills-kit.git` |
|
|
173
|
-
| **离线 tgz** | 隔离网络 | `npm pack` → `npx ./jhlc-wl-skills-kit-x.x.x.tgz` |
|
|
174
|
-
|
|
175
|
-
---
|
|
176
|
-
|
|
177
|
-
## 六、贡献指南
|
|
178
|
-
|
|
179
|
-
### 可贡献内容
|
|
180
|
-
|
|
181
|
-
| 类型 | 示例 | 贡献者 |
|
|
182
|
-
| ---------- | ----------------------------------- | -------------- |
|
|
183
|
-
| Skill 修复 | 修复 page-codegen 生成 bug | 任何使用者 |
|
|
184
|
-
| 组件文档 | 新增 jh-xxx 文档 | 平台组件开发者 |
|
|
185
|
-
| 领域样例 | `demo/{domain}/{submodule}/{page}/` | 各域开发者 |
|
|
186
|
-
| 通用组件 | 新增 c_xxxModal | 架构组 |
|
|
187
|
-
|
|
188
|
-
### 样例贡献规范
|
|
189
|
-
|
|
190
|
-
每个样例目录必须包含：
|
|
191
|
-
|
|
192
|
-
| 文件 | 必须 | 说明 |
|
|
193
|
-
| ------------ | ---- | ---------------------------------------- |
|
|
194
|
-
| `index.vue` | ✅ | 视图层 |
|
|
195
|
-
| `data.ts` | ✅ | 逻辑层（必须用 `createPage()` 标准模式） |
|
|
196
|
-
| `index.scss` | ✅ | 样式层 |
|
|
197
|
-
| `api.md` | 可选 | 有 API 约定时提供 |
|
|
198
|
-
|
|
199
|
-
**质量要求**：使用 Mock 数据（不依赖后端即可运行），脱敏处理（无真实手机号、客户名等）。
|
|
200
|
-
|
|
201
|
-
### 贡献流程
|
|
202
|
-
|
|
203
|
-
```
|
|
204
|
-
① clone wl-skills-kit 仓库 → 创建 feature 分支
|
|
205
|
-
② 修改 + 本地测试（npx . --dry-run）
|
|
206
|
-
③ 提 PR → Review → 合并
|
|
207
|
-
④ npm version → npm publish
|
|
208
|
-
⑤ 各项目 npx @
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
## 七、移植到新项目
|
|
214
|
-
|
|
215
|
-
详见 [use-skill.md](use-skill.md)「第四章：移植到新项目」。核心步骤：
|
|
216
|
-
|
|
217
|
-
1. `npx @
|
|
218
|
-
2. 执行 convention-extract Skill → 生成适配新项目的 copilot-instructions.md
|
|
219
|
-
3. 改写 page-codegen 代码模板（替换基类、组件、API 调用方式）
|
|
220
|
-
4. 验证：拿一个页面走完整 Skill 流程
|
|
221
|
-
|
|
222
|
-
### 依赖检查（⚠️ 必做）
|
|
223
|
-
|
|
224
|
-
Skill 生成的代码依赖以下包，新项目需确认已安装：
|
|
225
|
-
|
|
226
|
-
| 包名 | 类型 | 用途 | 安装命令 |
|
|
227
|
-
| ------------------ | ------ | ----------------------- | ------------------------------ |
|
|
228
|
-
| `mockjs` | devDep | Mock 数据生成 | `pnpm add -D mockjs` |
|
|
229
|
-
| `vite-plugin-mock` | devDep | Vite 自动加载 mock/ | `pnpm add -D vite-plugin-mock` |
|
|
230
|
-
| `lodash-es` | dep | debounce（RECORD_FORM） | `pnpm add lodash-es` |
|
|
231
|
-
| `xlsx` | dep | 导出/导入按钮（按需） | `pnpm add xlsx` |
|
|
232
|
-
|
|
233
|
-
> ⚠️ `lodash` ≠ `lodash-es`，两者不互通，模板代码 import 的是 `lodash-es`（ESM）。
|
|
234
|
-
|
|
235
|
-
---
|
|
236
|
-
|
|
237
|
-
## 八、版本管理
|
|
238
|
-
|
|
239
|
-
```
|
|
240
|
-
MAJOR.MINOR.PATCH
|
|
241
|
-
│ │ └── Skill bug fix / 文档修正
|
|
242
|
-
│ └──────── 新增 Skill / 组件 / 领域样例 / 编辑器支持
|
|
243
|
-
└────────────── 目录结构变更（breaking）
|
|
244
|
-
```
|
|
245
|
-
|
|
246
|
-
---
|
|
247
|
-
|
|
248
|
-
## 九、路线图
|
|
249
|
-
|
|
250
|
-
| 阶段 | 内容 | 优先级 |
|
|
251
|
-
| -------- | ----------------------------------------------------------------- | ------ |
|
|
252
|
-
| **v1.0** | Skills + 文档 + 组件 + demo 样例（Copilot） | 🔴 高 |
|
|
253
|
-
| **v1.1** | 多编辑器配置自动生成（Cursor / Windsurf / Kiro / Trae / Claude Code / AGENTS.md）| ✅ 已发布 |
|
|
254
|
-
| **v1.2** | `--dry-run` 预览 + `--diff` 变更对比 | 🟡 中 |
|
|
255
|
-
| **v2.0** | 纳入 `components/template/`（成熟后） | 🟢 低 |
|
|
256
|
-
|
|
257
|
-
---
|
|
258
|
-
|
|
259
|
-
## 附录：社区参考
|
|
260
|
-
|
|
261
|
-
| 项目 | 说明 |
|
|
262
|
-
| ------------- | ------------------------------- |
|
|
263
|
-
| Ruler | 30+ AI agent 规则集中管理 |
|
|
264
|
-
| rule-porter | Cursor ↔ AGENTS.md 双向转换 |
|
|
265
|
-
| killer-skills | 社区 Skill 安装器 |
|
|
266
|
-
| AGENTS.md | Linux Foundation 跨工具指令标准 |
|
|
1
|
+
# wl-skills-kit — AI Skill 模板包
|
|
2
|
+
|
|
3
|
+
> 统一维护、一键分发：AI 指令 + 组件文档 + 通用组件 + 领域样例。
|
|
4
|
+
> 安装即导入，无副作用，各项目通过 `npx @agile-team/wl-skills-kit` 同步更新。
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 一、定位
|
|
9
|
+
|
|
10
|
+
**wl-skills-kit** 是公司前端 AI 生态的基础设施包。
|
|
11
|
+
|
|
12
|
+
| 是什么 | 不是什么 |
|
|
13
|
+
| ---------------------------------------- | ----------------------------------- |
|
|
14
|
+
| 文件模板包，安装后按目录结构导入项目 | 不是运行时依赖 |
|
|
15
|
+
| AI 指令 + 文档 + 组件 + 样例的统一维护源 | 不修改 package.json / node_modules |
|
|
16
|
+
| 各项目同步更新的唯一通道 | 不执行 postinstall / 不删除任何文件 |
|
|
17
|
+
|
|
18
|
+
**一句话**：`npx @agile-team/wl-skills-kit` = 把模板文件复制到你的项目。完毕。
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 二、包目录结构
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
@agile-team/wl-skills-kit/
|
|
26
|
+
├── package.json ← name: "@agile-team/wl-skills-kit"
|
|
27
|
+
├── README.md
|
|
28
|
+
├── CHANGELOG.md
|
|
29
|
+
├── bin/
|
|
30
|
+
│ └── wl-skills.js ← CLI 入口（文件拷贝 + 进度提示）
|
|
31
|
+
│
|
|
32
|
+
└── files/ ← 1:1 映射到目标项目根目录
|
|
33
|
+
│
|
|
34
|
+
├── .github/ ← ① AI 指令（核心）
|
|
35
|
+
│ ├── copilot-instructions.md ← 项目规范总纲
|
|
36
|
+
│ ├── skills/
|
|
37
|
+
│ │ ├── prototype-scan/SKILL.md ← 原型扫描
|
|
38
|
+
│ │ ├── api-contract/SKILL.md ← 接口约定
|
|
39
|
+
│ │ ├── page-codegen/ ← 页面代码生成
|
|
40
|
+
│ │ │ ├── SKILL.md ← 主规则（~825 行）
|
|
41
|
+
│ │ │ └── TPL-*.md ← 9 个模板（LIST / FORM-ROUTE / MASTER-DETAIL /
|
|
42
|
+
│ │ │ TREE-LIST / DETAIL-TABS / CHANGE-HISTORY /
|
|
43
|
+
│ │ │ RECORD-FORM / OPERATION-STATION / DRIVEN）
|
|
44
|
+
│ │ ├── menu-sync/
|
|
45
|
+
│ │ │ ├── SKILL.md ← 菜单同步
|
|
46
|
+
│ │ │ └── env/guide.md ← env.local.json 配置说明（json 本身不分发）
|
|
47
|
+
│ │ └── convention-extract/SKILL.md ← 规范提炼
|
|
48
|
+
│ └── docs/
|
|
49
|
+
│ ├── use-skill.md ← 使用 + 移植一站式指南
|
|
50
|
+
│ ├── menu-sync-design.md ← 菜单同步方案设计
|
|
51
|
+
│ ├── SYS_MENU_INFO.md ← 菜单注册记录模板
|
|
52
|
+
│ └── wl-skills-kit.md ← 本文档
|
|
53
|
+
│
|
|
54
|
+
├── docs/ ← ② 组件文档（12 个 md）
|
|
55
|
+
│ ├── request.md ← HTTP 请求工具
|
|
56
|
+
│ ├── page-query-hook-best-practices.md
|
|
57
|
+
│ ├── jh-select.md / jh-date.md / jh-date-range.md
|
|
58
|
+
│ ├── jh-drag-row.md / jh-pagination.md / jh-file-upload.md
|
|
59
|
+
│ └── jh-text.md / jh-user-picker.md / jh-dept-picker.md / jh-picker.md
|
|
60
|
+
│
|
|
61
|
+
├── src/
|
|
62
|
+
│ ├── components/ ← ③ 通用组件
|
|
63
|
+
│ │ ├── global/ ← C_Splitter / C_Tree / C_TagStatus
|
|
64
|
+
│ │ │ C_ParentView / C_SvgIcon / C_RightToolbar
|
|
65
|
+
│ │ ├── local/ ← c_formModal / c_formSections
|
|
66
|
+
│ │ │ c_listModal / c_spliterTitle
|
|
67
|
+
│ │ └── remote/ ← BaseQuery / BaseTable / BaseToolbar
|
|
68
|
+
│ │ BaseForm / AGGrid（仅 README）
|
|
69
|
+
│ └── types/page.ts ← ④ 类型桶文件
|
|
70
|
+
│
|
|
71
|
+
└── demo/ ← ⑤ 领域样例（AI 学习 + 开发参考）
|
|
72
|
+
├── README.md ← 样例索引 + 模板类型标注
|
|
73
|
+
├── produce/
|
|
74
|
+
│ └── aiflow/ ← 生产域 8 个页面
|
|
75
|
+
│ ├── mmwr-customer-archive/ ← LIST + Tabs + c_formModal
|
|
76
|
+
│ ├── mmwr-temp-customer-archive/ ← LIST
|
|
77
|
+
│ ├── mmwr-customer-apply-add/ ← LIST
|
|
78
|
+
│ ├── mmwr-customer-apply-add-form/ ← FORM_ROUTE
|
|
79
|
+
│ ├── mmwr-customer-apply-change/ ← LIST
|
|
80
|
+
│ ├── mmwr-customer-apply-change-form/ ← FORM_ROUTE
|
|
81
|
+
│ ├── mmwr-customer-apply-change-history/ ← CHANGE_HISTORY
|
|
82
|
+
│ └── mmwr-customer-detail/ ← DETAIL_TABS
|
|
83
|
+
└── sale/
|
|
84
|
+
└── demo/ ← 销售域 5 个页面（平台默认样例）
|
|
85
|
+
├── domestic-trade-order/ ← LIST 标准列表
|
|
86
|
+
├── metallurgical-spec/ ← MASTER_DETAIL 上下分栏
|
|
87
|
+
├── add-demo/ ← FORM_ROUTE（c_formSections）
|
|
88
|
+
├── billet-flame-cut-plan/ ← LIST 变体
|
|
89
|
+
└── heat-batch-return/ ← LIST + 自定义弹窗
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
> `files/` 下所有内容按原始路径写入项目根目录。**仅此而已，无其他逻辑。**
|
|
93
|
+
|
|
94
|
+
### 不分发的内容
|
|
95
|
+
|
|
96
|
+
| 路径 | 原因 |
|
|
97
|
+
| ------------------------------------------- | ---------------------------------------- |
|
|
98
|
+
| `src/components/template/*` | 高阶封装，v2.0 稳定后再纳入 |
|
|
99
|
+
| `src/components/local/c_customerTabs/` | 客户域专用 |
|
|
100
|
+
| `src/components/local/c_applyDetailDialog/` | 客户域专用 |
|
|
101
|
+
| `src/components/local/c_actionModal/` | 客户域专用 |
|
|
102
|
+
| `menu-sync/env/env.local.json` | 含 Token，各项目本地维护（已 gitignore） |
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## 三、使用方式
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
# 安装 / 初始化（首次）
|
|
110
|
+
npx @agile-team/wl-skills-kit
|
|
111
|
+
|
|
112
|
+
# 同步更新（拉取最新模板）
|
|
113
|
+
npx @agile-team/wl-skills-kit@latest
|
|
114
|
+
|
|
115
|
+
# 预览变更（不写入，仅输出文件列表）
|
|
116
|
+
npx @agile-team/wl-skills-kit --dry-run
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
| ✅ 做什么 | ❌ 不做什么 |
|
|
120
|
+
| ------------------------------ | -------------------- |
|
|
121
|
+
| 写入 .github/ docs/ src/ demo/ | 不修改 package.json |
|
|
122
|
+
| 覆盖同名文件 | 不修改 node_modules/ |
|
|
123
|
+
| 创建不存在的目录 | 不执行 postinstall |
|
|
124
|
+
| | 不删除任何文件 |
|
|
125
|
+
|
|
126
|
+
### 安全路径（不会被覆盖）
|
|
127
|
+
|
|
128
|
+
以下路径不在分发范围内，本地修改永远安全：
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
.github/skills/my-domain-skill/ ← 自定义 Skill（非内置名）
|
|
132
|
+
.github/docs/my-domain-doc.md ← 自定义文档
|
|
133
|
+
src/components/local/my_custom/ ← 自定义组件
|
|
134
|
+
src/views/ ← 业务页面
|
|
135
|
+
mock/ ← Mock 数据
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
| 修改类型 | 做法 |
|
|
139
|
+
| -------- | --------------------------------------------------- |
|
|
140
|
+
| 通用改进 | **提 PR 到 wl-skills-kit 仓库**，合并后所有项目受益 |
|
|
141
|
+
| 领域专有 | 放在上述安全路径，不会被覆盖 |
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 四、多编辑器支持
|
|
146
|
+
|
|
147
|
+
v1.0 聚焦 **GitHub Copilot**（`.github/` 目录即完整配置）。
|
|
148
|
+
|
|
149
|
+
v1.1 实现：CLI 安装时自动从 `.github/copilot-instructions.md` **动态生成**各编辑器配置文件。单一源头，更新 `copilot-instructions.md` 后重新运行即同步所有编辑器配置。
|
|
150
|
+
|
|
151
|
+
| 编辑器 | 配置路径 | 状态 |
|
|
152
|
+
| ------------------ | -------------------------------------------------------------- | ------- |
|
|
153
|
+
| **GitHub Copilot** | `.github/copilot-instructions.md` + `skills/` | ✅ v1.0 |
|
|
154
|
+
| **Cursor** | `.cursorrules` + `.cursor/rules/conventions.mdc` (alwaysApply) | ✅ v1.1 |
|
|
155
|
+
| **Windsurf** | `.windsurfrules` | ✅ v1.1 |
|
|
156
|
+
| **Kiro** | `.kiro/steering/conventions.md` | ✅ v1.1 |
|
|
157
|
+
| **Trae** | `.trae/rules/conventions.md` | ✅ v1.1 |
|
|
158
|
+
| **Claude Code** | `CLAUDE.md` | ✅ v1.1 |
|
|
159
|
+
| **Roo / Cline** | `.clinerules` | ✅ v1.1 |
|
|
160
|
+
| **AGENTS.md** | `AGENTS.md`（Linux Foundation 标准，通用兜底） | ✅ v1.1 |
|
|
161
|
+
|
|
162
|
+
> **原则**：AGENTS.md 是跨工具兜底标准，新工具出来大概率支持它。
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 五、发布策略
|
|
167
|
+
|
|
168
|
+
| 方式 | 场景 | 命令 |
|
|
169
|
+
| -------------------- | ----------- | ---------------------------------------------------- |
|
|
170
|
+
| **npm 公有**（优先） | 公开发布 | `npm publish --access public` |
|
|
171
|
+
| **私有 npm**（备选） | 内网团队 | `npm config set @agile-team:registry http://npm.nisco.cn/` |
|
|
172
|
+
| **Git 直装** | 无 npm 仓库 | `npx git+http://git.nisco.cn/PSQF/wl-skills-kit.git` |
|
|
173
|
+
| **离线 tgz** | 隔离网络 | `npm pack` → `npx ./jhlc-wl-skills-kit-x.x.x.tgz` |
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 六、贡献指南
|
|
178
|
+
|
|
179
|
+
### 可贡献内容
|
|
180
|
+
|
|
181
|
+
| 类型 | 示例 | 贡献者 |
|
|
182
|
+
| ---------- | ----------------------------------- | -------------- |
|
|
183
|
+
| Skill 修复 | 修复 page-codegen 生成 bug | 任何使用者 |
|
|
184
|
+
| 组件文档 | 新增 jh-xxx 文档 | 平台组件开发者 |
|
|
185
|
+
| 领域样例 | `demo/{domain}/{submodule}/{page}/` | 各域开发者 |
|
|
186
|
+
| 通用组件 | 新增 c_xxxModal | 架构组 |
|
|
187
|
+
|
|
188
|
+
### 样例贡献规范
|
|
189
|
+
|
|
190
|
+
每个样例目录必须包含：
|
|
191
|
+
|
|
192
|
+
| 文件 | 必须 | 说明 |
|
|
193
|
+
| ------------ | ---- | ---------------------------------------- |
|
|
194
|
+
| `index.vue` | ✅ | 视图层 |
|
|
195
|
+
| `data.ts` | ✅ | 逻辑层（必须用 `createPage()` 标准模式） |
|
|
196
|
+
| `index.scss` | ✅ | 样式层 |
|
|
197
|
+
| `api.md` | 可选 | 有 API 约定时提供 |
|
|
198
|
+
|
|
199
|
+
**质量要求**：使用 Mock 数据（不依赖后端即可运行），脱敏处理（无真实手机号、客户名等）。
|
|
200
|
+
|
|
201
|
+
### 贡献流程
|
|
202
|
+
|
|
203
|
+
```
|
|
204
|
+
① clone wl-skills-kit 仓库 → 创建 feature 分支
|
|
205
|
+
② 修改 + 本地测试（npx . --dry-run）
|
|
206
|
+
③ 提 PR → Review → 合并
|
|
207
|
+
④ npm version → npm publish
|
|
208
|
+
⑤ 各项目 npx @agile-team/wl-skills-kit@latest
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## 七、移植到新项目
|
|
214
|
+
|
|
215
|
+
详见 [use-skill.md](use-skill.md)「第四章：移植到新项目」。核心步骤：
|
|
216
|
+
|
|
217
|
+
1. `npx @agile-team/wl-skills-kit` → 导入全部文件
|
|
218
|
+
2. 执行 convention-extract Skill → 生成适配新项目的 copilot-instructions.md
|
|
219
|
+
3. 改写 page-codegen 代码模板（替换基类、组件、API 调用方式）
|
|
220
|
+
4. 验证：拿一个页面走完整 Skill 流程
|
|
221
|
+
|
|
222
|
+
### 依赖检查（⚠️ 必做）
|
|
223
|
+
|
|
224
|
+
Skill 生成的代码依赖以下包，新项目需确认已安装：
|
|
225
|
+
|
|
226
|
+
| 包名 | 类型 | 用途 | 安装命令 |
|
|
227
|
+
| ------------------ | ------ | ----------------------- | ------------------------------ |
|
|
228
|
+
| `mockjs` | devDep | Mock 数据生成 | `pnpm add -D mockjs` |
|
|
229
|
+
| `vite-plugin-mock` | devDep | Vite 自动加载 mock/ | `pnpm add -D vite-plugin-mock` |
|
|
230
|
+
| `lodash-es` | dep | debounce（RECORD_FORM） | `pnpm add lodash-es` |
|
|
231
|
+
| `xlsx` | dep | 导出/导入按钮（按需） | `pnpm add xlsx` |
|
|
232
|
+
|
|
233
|
+
> ⚠️ `lodash` ≠ `lodash-es`，两者不互通，模板代码 import 的是 `lodash-es`（ESM）。
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## 八、版本管理
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
MAJOR.MINOR.PATCH
|
|
241
|
+
│ │ └── Skill bug fix / 文档修正
|
|
242
|
+
│ └──────── 新增 Skill / 组件 / 领域样例 / 编辑器支持
|
|
243
|
+
└────────────── 目录结构变更（breaking）
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
## 九、路线图
|
|
249
|
+
|
|
250
|
+
| 阶段 | 内容 | 优先级 |
|
|
251
|
+
| -------- | ----------------------------------------------------------------- | ------ |
|
|
252
|
+
| **v1.0** | Skills + 文档 + 组件 + demo 样例（Copilot） | 🔴 高 |
|
|
253
|
+
| **v1.1** | 多编辑器配置自动生成（Cursor / Windsurf / Kiro / Trae / Claude Code / AGENTS.md）| ✅ 已发布 |
|
|
254
|
+
| **v1.2** | `--dry-run` 预览 + `--diff` 变更对比 | 🟡 中 |
|
|
255
|
+
| **v2.0** | 纳入 `components/template/`（成熟后） | 🟢 低 |
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## 附录：社区参考
|
|
260
|
+
|
|
261
|
+
| 项目 | 说明 |
|
|
262
|
+
| ------------- | ------------------------------- |
|
|
263
|
+
| Ruler | 30+ AI agent 规则集中管理 |
|
|
264
|
+
| rule-porter | Cursor ↔ AGENTS.md 双向转换 |
|
|
265
|
+
| killer-skills | 社区 Skill 安装器 |
|
|
266
|
+
| AGENTS.md | Linux Foundation 跨工具指令标准 |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agile-team/wl-skills-kit",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "AI Skill 模板包 — 一键导入 AI 指令 + 组件文档 + 通用组件 + 领域样例，覆盖 Copilot/Cursor/Windsurf/Kiro 等主流 AI 编辑器",
|
|
5
5
|
"bin": {
|
|
6
6
|
"wl-skills-kit": "./bin/wl-skills.js"
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"agents"
|
|
25
25
|
],
|
|
26
26
|
"author": "JHLC Frontend Team",
|
|
27
|
-
"license": "
|
|
27
|
+
"license": "UNLICENSED",
|
|
28
28
|
"repository": {
|
|
29
29
|
"type": "git",
|
|
30
30
|
"url": "git+https://github.com/ChenyCHENYU/wl-skills-kit.git"
|