SuperAPI AI 工具集

review-style-guide

通用与其它

查看项目

更新于 10-16 08:09

技能介绍

用途:在提交代码或创建 PR 前,依据项目自身的编码风格指南检查当前代码改动,提前发现命名、导入顺序、文件结构、模式与反模式方面的问题。

主要能力:按优先级查找风格指南(项目根目录 STYLE_GUIDE.md、.claude/style-guide.md,或 CLAUDE.md、AGENTS.md 中的 Conventions 段落);确定审查范围;逐文件检查命名(变量、函数、类、文件、数据库表列)、代码组织(导入顺序、标准内部结构、文件目录位置)、模式(错误处理、测试结构、API 端点、前端组件)以及“Anti-Patterns — Do NOT Replicate”中列出的反模式;最后以 🔴 MUST FIX、🟡 SHOULD FIX、🟢 CONSIDER 三级输出问题,并给出审查小结与结论。

使用方式:无参数时依次检查已暂存改动、未暂存改动、最近一次提交;传入参数则作为 diff 基线,如 /review-style main 对应 git diff main...HEAD,/review-style HEAD~3 对应 git diff HEAD~3。若找不到风格指南,会提示用户运行 /setup-ai 或 /generate-comprehensive-style-guide 生成。

适用场景:团队有明确风格文档的代码仓库,希望在合并前做一致性检查。

限制:只标记确有依据的偏差,不将个人偏好强加为规则;每个 🔴 和 🟡 必须引用风格指南具体条目;风格指南含糊时只能标为 🟢。不审查锁文件、构建产物、自动生成的类型等生成文件,只关注人工编写的源码。官方文本暂未提供。