AgentSkillsCN

Code Review Skill

代码评审技能

SKILL.md

Code Review Skill

对当前分支或指定文件的改动进行全面的代码审查。

何时使用

  • 当用户想要进行代码审查时
  • 当用户输入 "code review"、"审查代码"、"review" 等意图时
  • 当用户想要检查代码质量时

能力

此 Skill 可以:

  1. 确定审查范围(工作区、分支、指定文件)
  2. 过滤和分类文件(Vue、TypeScript、配置、样式、文档)
  3. 执行全面的代码审查:
    • Vue 组件审查(结构、代码质量、组件分类)
    • 样式审查(Tailwind CSS 使用规范)
    • 类型定义审查(类型安全、导入规范)
    • 测试覆盖审查
    • 代码规范审查
  4. 生成详细的审查报告(通过项、需改进、必须修复)
  5. 提供 IDE 快捷跳转支持

参数

  • target (可选): 审查目标
    • 不提供: 审查当前工作区改动
    • branch: 审查当前分支相对于 master 的所有改动
    • file:<path>: 审查指定文件

实现步骤

  1. 确定审查范围:根据参数确定需要审查的文件
  2. 过滤和分类文件:按类型分类文件
  3. 执行代码审查:对每个文件进行详细检查
  4. 生成审查报告:使用标准格式输出审查结果
  5. 提供改进建议:按优先级排序问题

审查检查项

Vue 组件

  • 使用 <script setup> + Composition API
  • Props 有 TypeScript 类型定义
  • 组件命名使用 kebab-case

样式

  • 统一使用 Tailwind CSS
  • 禁止使用内联样式
  • 优先使用预定义颜色类

类型

  • 数据模型类型从共享包引入
  • 禁止手动定义已存在的接口类型
  • 优先基于导入类型推导

测试

  • 新增的工具函数/组件有对应的测试文件
  • 测试文件放在 __tests__ 目录下

输出格式

生成包含以下部分的审查报告:

  • 📊 审查概览(文件统计)
  • ✅ 通过项
  • ⚠️ 需要改进(文件路径 + 行号 + 建议)
  • ❌ 必须修复
  • 🧪 测试覆盖
  • 📝 总结