ai-engineering-init 1.4.2 → 1.5.0

package/src/skills/add-todo/SKILL.md

@@ -0,0 +1,269 @@
+---
+name: add-todo
+description: |
+  当需要快速添加待办任务、记录开发事项时自动使用此 Skill。
+
+  触发场景：
+  - 需要快速添加一个待办任务
+  - 需要记录开发中发现的问题
+  - 需要批量添加多个待办事项
+  - 需要为特定模块添加任务
+
+  触发词：添加待办、add-todo、待办事项、任务添加、记录任务、新增待办、快速待办
+---
+
+# /add-todo - 快速添加待办事项
+
+作为待办事项管理助手，帮我快速添加待办任务。支持自动创建缺失文档、联动项目状态。
+
+---
+
+## 使用方式
+
+```bash
+/add-todo 实现用户权限管理
+/add-todo 修复登录bug，优先级高
+/add-todo 优化接口性能，3天，中等优先级
+/add-todo ruoyi-demo 实现测试功能
+/add-todo ruoyi-system 修复缓存问题，高，截止1月30号
+```
+
+---
+
+## 第一步：智能检测文档状态
+
+### 检查待办清单.md
+
+如果 `docs/待办清单.md` 不存在：
+1. 读取模板 `.claude/templates/待办清单模板.md`
+2. 替换时间占位符为当前时间
+3. 创建 `docs/待办清单.md`
+4. 输出提示：`📝 已自动创建 docs/待办清单.md`
+
+---
+
+## 第二步：解析任务信息
+
+### 从用户输入中提取
+
+| 信息 | 解析方式 | 默认值 |
+|------|---------|--------|
+| 任务名称 | 必填，主体内容 | - |
+| 优先级 | "高"/"中"/"低"，或"紧急"/"重要" | 中 |
+| 预计时间 | "X天"/"X周" | 待定 |
+| 所属模块 | 模块名前缀如"ruoyi-demo"、"ruoyi-system" | 通用 |
+| 截止日期 | "截止XX"或"deadline XX" | 待定 |
+
+### 优先级映射
+
+| 用户输入 | 映射到 |
+|---------|--------|
+| 高、紧急、urgent、critical、ASAP | 🔥 高优先级 |
+| 中、一般、normal、默认 | 📌 中优先级 |
+| 低、可延后、optional、nice-to-have | 💡 低优先级 |
+
+### 模块识别
+
+| 用户输入 | 识别结果 |
+|---------|---------|
+| `ruoyi-demo 测试功能` | 模块: ruoyi-demo |
+| `ruoyi-system 用户管理` | 模块: ruoyi-system |
+| `后端 权限管理` | 模块: 后端 |
+| `权限管理` | 模块: 通用（无前缀） |
+
+---
+
+## 第三步：添加到待办清单.md
+
+### 读取现有内容
+- 读取 `docs/待办清单.md`
+- 解析各优先级区域的位置
+
+### 添加任务
+
+根据优先级添加到对应区域：
+
+```markdown
+## 🔥 高优先级（紧急重要）
+- [ ] [任务名称]
+  - 截止日期: YYYY-MM-DD（如果有）
+  - 描述: [任务描述]（如果有）
+  - 所属模块: ruoyi-xxx（如果识别到）
+  - 预计工作量: X天（如果有）
+  - 添加时间: YYYY-MM-DD HH:MM
+
+## 📌 中优先级（重要不紧急）
+...
+
+## 💡 低优先级（可延后）
+...
+```
+
+### 更新统计信息
+- 更新"待办总数": X 项
+- 更新"最后更新": 当前时间
+
+---
+
+## 第四步：联动更新项目状态.md（如果存在）
+
+### 检查项目状态.md
+
+如果 `docs/项目状态.md` 存在：
+1. 读取项目状态文档
+2. 将新任务添加到"待办"区域
+3. 格式与待办清单保持一致
+
+### 添加格式
+
+```markdown
+## 📋 待办
+- [ ] [任务名称]
+  - 优先级: 高/中/低
+  - 预计工作量: X天
+  - 所属模块: ruoyi-xxx
+```
+
+---
+
+## 第五步：输出确认信息
+
+```markdown
+✅ 已添加待办任务：
+
+📌 **[任务名称]**
+- 优先级: 高/中/低
+- 预计时间: X天
+- 所属模块: ruoyi-xxx（如果有）
+- 截止日期: YYYY-MM-DD（如果有）
+
+📁 已更新文件:
+- docs/待办清单.md
+- docs/项目状态.md（如果存在）
+
+📊 当前待办总数: X 项
+```
+
+---
+
+## 批量添加支持
+
+### 多任务添加
+
+用户可以一次添加多个任务：
+
+```bash
+/add-todo 实现用户登录；实现用户注册；实现密码重置
+```
+
+或分行：
+
+```
+/add-todo
+1. 实现用户登录，高优先级
+2. 实现用户注册，中优先级
+3. 实现密码重置，低优先级
+```
+
+### 处理方式
+- 按分号、换行、数字编号分割
+- 依次解析每个任务
+- 批量添加并汇总报告
+
+---
+
+## 智能建议
+
+### 添加后提示
+
+添加任务后，根据情况给出建议：
+
+**待办过多时（>15项）**：
+```
+💡 提示：当前待办已有 18 项，建议：
+- 运行 /progress 梳理优先级
+- 考虑将低优先级任务归档
+```
+
+**高优先级过多时（>5项）**：
+```
+⚠️ 提示：高优先级任务已有 6 项
+建议重新评估优先级，确保"紧急"真正紧急
+```
+
+**相似任务检测**：
+```
+💡 提示：检测到相似待办：
+- 已有: "实现用户登录功能"
+- 新增: "用户登录"
+是否为同一任务？
+```
+
+---
+
+## 示例
+
+### 示例 1：简单添加
+
+```
+用户: /add-todo 修复通知发送错误
+
+AI: ✅ 已添加待办任务：
+
+📌 **修复通知发送错误**
+- 优先级: 中
+- 预计时间: 待定
+- 添加时间: 2025-12-25 14:30
+
+📁 已更新: docs/待办清单.md
+📊 当前待办总数: 8 项
+```
+
+### 示例 2：带参数添加
+
+```
+用户: /add-todo ruoyi-demo 实现导出功能，高优先级，2天
+
+AI: ✅ 已添加待办任务：
+
+🔥 **实现导出功能**
+- 优先级: 高
+- 预计时间: 2天
+- 所属模块: ruoyi-demo
+- 添加时间: 2025-12-25 14:30
+
+📁 已更新:
+- docs/待办清单.md
+- docs/项目状态.md
+
+📊 当前待办总数: 9 项
+```
+
+### 示例 3：自动创建文档
+
+```
+用户: /add-todo 开发后端接口文档
+
+AI: 📝 已自动创建 docs/待办清单.md
+
+✅ 已添加待办任务：
+
+📌 **开发后端接口文档**
+- 优先级: 中
+- 预计时间: 待定
+- 添加时间: 2025-12-25 14:30
+
+📁 已更新: docs/待办清单.md
+📊 当前待办总数: 1 项
+```
+
+---
+
+## 与其他命令的关系
+
+| 命令 | 关系 |
+|------|------|
+| `/update-status` | 批量同步 TODO，/add-todo 是单个添加 |
+| `/init-docs` | 初始化文档，/add-todo 可自动补充创建 |
+| `/progress` | 查看进度，包含待办统计 |
+| `/sync` | 全量同步，确保数据一致 |

package/src/skills/api-development/SKILL.md

@@ -0,0 +1,266 @@
+---
+name: api-development
+description: |
+  后端 API 接口设计规范。基于三层架构的 RESTful API 开发指南。
+
+  触发场景：
+  - 设计 RESTful API 接口
+  - 编写 Controller 层代码
+  - 配置接口权限、日志、防重复提交注解
+  - 接口返回值类型选择
+  - 数据验证和参数校验
+
+  触发词：API、接口、RESTful、Controller、GetMapping、PostMapping、权限注解、日志注解、分页查询、接口规范
+
+  注意：
+  - 本项目是三层架构：Controller -> Service -> Mapper
+  - 参考 java-controller 技能获取更详细的 Controller 层规范
+---
+
+# API 接口设计规范
+
+## 核心规范
+
+| 原则 | 说明 |
+|------|------|
+| 统一入口 | 所有接口使用 POST 或 RESTful 风格 |
+| 认证保护 | 所有业务接口必须添加认证注解 |
+| 参数校验 | 使用分组校验区分新增/修改场景 |
+| 统一响应 | 使用统一的响应格式包装返回数据 |
+
+### HTTP 方法规范
+
+| 操作 | 方法 | 路径 |
+|------|------|------|
+| 列表查询 | POST/GET | `/query` 或 `/list` |
+| 获取详情 | POST/GET | `/{id}` 或 `/detail` |
+| 新增 | POST | `/add` |
+| 修改 | POST/PUT | `/update` |
+| 删除 | POST/DELETE | `/delete` 或 `/batch/delete` |
+| 导出 | POST | `/export` |
+| 导入 | POST | `/import-excel` |
+
+---
+
+## Controller 标准模板
+
+```java
+@Slf4j
+@RestController
+@RequiresAuthentication
+@RequestMapping("/module/feature")
+@Api(value = "模块/功能", tags = "模块/功能")
+public class XxxController {
+
+    @Resource @Lazy
+    private XxxService xxxService;
+
+    @PostMapping("/add")
+    @ApiOperation(value = "功能描述-新增")
+    public Long add(@Validated(InsertGroup.class) @RequestBody LeRequest<XxxDTO> request) {
+        return xxxService.add(request.getContent());
+    }
+
+    @PostMapping("/update")
+    @ApiOperation(value = "功能描述-修改")
+    public void update(@Validated(UpdateGroup.class) @RequestBody LeRequest<XxxDTO> request) {
+        xxxService.update(request.getContent());
+    }
+
+    @PostMapping("/query")
+    @ApiOperation(value = "功能描述-分页查询")
+    public Page<XxxVO> query(@Validated @RequestBody LeRequest<XxxQueryParam> request) {
+        return xxxService.pageList(request.getContent());
+    }
+
+    @PostMapping("/delete")
+    @ApiOperation(value = "功能描述-删除")
+    public void delete(@RequestBody LeRequest<Long> request) {
+        xxxService.delete(request.getContent());
+    }
+}
+```
+
+---
+
+## 参数封装规范
+
+### 请求参数用 LeRequest 包装
+
+```java
+@PostMapping("/query")
+public Page<XxxVO> query(@RequestBody LeRequest<XxxQueryParam> request) {
+    return xxxService.pageList(request.getContent());
+}
+```
+
+### 分页参数
+
+```java
+@Data
+public class XxxPageParam implements Serializable {
+    @NotNull(message = "分页参数不能为空")
+    private PageDTO page;
+    private String keyword;
+    private Integer status;
+}
+```
+
+### 分组校验
+
+```java
+// DTO 中使用分组
+@Data
+public class XxxDTO {
+    @NotNull(message = "ID不能为空", groups = {UpdateGroup.class})
+    private Long id;
+
+    @NotBlank(message = "名称不能为空", groups = {InsertGroup.class, UpdateGroup.class})
+    private String name;
+}
+
+// Controller 中应用
+@PostMapping("/add")
+public Long add(@Validated(InsertGroup.class) @RequestBody LeRequest<XxxDTO> request)
+```
+
+> Jakarta Validation: 项目用 JDK 21，必须 `import jakarta.validation.constraints.*`
+
+---
+
+## 响应格式
+
+```java
+// 分页响应
+@PostMapping("/query")
+public Page<XxxVO> query(@RequestBody LeRequest<XxxQueryParam> request) { ... }
+
+// 单条数据
+@GetMapping("/{id}")
+public XxxVO getById(@PathVariable Long id) { ... }
+
+// 新增返回 ID / 修改删除返回 void
+@PostMapping("/add")
+public Long add(@RequestBody LeRequest<XxxDTO> request) { ... }
+```
+
+---
+
+## 常见场景
+
+### 带 Redisson 分布式锁的导入
+
+```java
+@PostMapping("/import-excel")
+@ApiOperation(value = "Excel导入")
+public void importExcel(@RequestParam(value = "file") MultipartFile file) {
+    if (Objects.isNull(file) || file.isEmpty()) {
+        throw new LeException("文件不能为空");
+    }
+    RLock lock = redissonClient.getLock("import:lock:" + TenantContextHolder.getTenantId());
+    if (!lock.tryLock(5, 60, TimeUnit.SECONDS)) {
+        throw new LeException("正在处理中，请稍后再试");
+    }
+    try {
+        xxxService.importExcel(file);
+    } finally {
+        if (lock.isLocked() && lock.isHeldByCurrentThread()) {
+            lock.unlock();
+        }
+    }
+}
+```
+
+### 批量删除
+
+```java
+@RequestMapping(value = "/batch/delete", method = {RequestMethod.POST, RequestMethod.PUT})
+@ApiOperation(value = "批量删除")
+public void batchDelete(@RequestBody LeRequest<List<Long>> request) {
+    if (CollUtil.isEmpty(request.getContent())) {
+        throw new LeException("ID列表不能为空");
+    }
+    xxxService.batchDelete(request.getContent());
+}
+```
+
+### 带合计行的分页查询
+
+```java
+@PostMapping("/query")
+@ApiOperation(value = "分页查询（带合计）")
+public ReportBaseTotalVO<XxxVO> query(@RequestBody LeRequest<XxxQueryParam> request) {
+    ReportBaseTotalVO<XxxVO> result = new ReportBaseTotalVO<>();
+    result.setTotalLine(xxxService.getSummaryTotal(request.getContent()));
+    result.setResultPage(PageVO.of(xxxService.pageList(request.getContent())));
+    return result;
+}
+```
+
+---
+
+## Swagger 注解
+
+```java
+@Api(value = "模块/功能", tags = "模块/功能")  // Controller 类
+@ApiOperation(value = "功能描述-新增")           // 方法
+@ApiModel("功能描述DTO")                         // DTO/VO 类
+@ApiModelProperty(value = "主键ID", required = true) // 字段
+```
+
+---
+
+## 检查清单
+
+- [ ] 认证注解 `@RequiresAuthentication`
+- [ ] API 文档注解 `@ApiOperation`
+- [ ] 参数校验 `@Validated` + 分组
+- [ ] 返回值类型正确（分页用 `Page<VO>`）
+- [ ] 使用 `LeRequest<T>` 封装请求
+- [ ] 敏感操作加分布式锁
+
+---
+
+## 多项目对比
+
+| 特征 | RuoYi-Vue-Plus | leniu-tengyun-core |
+|-----|----------------|-------------------|
+| JDK | 17 | 21 |
+| 包名 | `org.dromara.*` | `net.xnzn.core.*` |
+| 请求封装 | 直接 BO | `LeRequest<T>` |
+| 响应封装 | `R<T>`, `TableDataInfo<T>` | `Page<T>`, `void` |
+| 分组校验 | `AddGroup`, `EditGroup` | `InsertGroup`, `UpdateGroup` |
+| 认证 | `@SaCheckPermission` | `@RequiresAuthentication` |
+| 异常 | `ServiceException` | `LeException` |
+| 国际化 | `MessageUtils.message()` | `I18n.getMessage()` |
+
+---
+
+## 错误对比
+
+```java
+// ---- 错误 ----
+@RestController                                    // 缺认证注解
+public Long add(@RequestBody XxxDTO dto) { }       // 不用 LeRequest
+public Long add(@Valid @RequestBody LeRequest<XxxDTO> request) { }  // @Valid 应为 @Validated(InsertGroup.class)
+import javax.validation.constraints.NotNull;        // JDK 21 用 jakarta
+
+// ---- 正确 ----
+@RestController @RequiresAuthentication
+public Long add(@Validated(InsertGroup.class) @RequestBody LeRequest<XxxDTO> request) {
+    return xxxService.add(request.getContent());
+}
+import jakarta.validation.constraints.NotNull;
+```
+
+---
+
+## 相关技能
+
+| 需要了解 | Skill |
+|---------|-------|
+| Service 层 | `java-service` |
+| Controller 详细 | `java-controller` |
+| 异常处理 | `error-handler` |
+| 参数校验 | `java-entity` |
+| 数据库设计 | `database-ops` |