SuperAPI AI 工具集

clean-code

通用与其它

查看项目

更新于 10-16 05:43

技能介绍

用途:这是一套面向 AI 编码场景的务实编码规范,核心目标是让 AI 写出简洁、直接、以解决问题为导向的代码,避免过度工程化与无意义注释。

主要能力与原则:

  • 核心原则:SRP(单一职责,每个函数/类只做一件事)、DRY(不重复,抽取复用)、KISS(保持简单,用能工作的最简方案)、YAGNI(不构建用不到的功能)、童子军原则(让代码比你接手时更干净)。
  • 命名规范:变量体现意图(userCount 而非 n);函数用动词+名词(getUserById());布尔量用疑问形式(isActive、hasPermission、canEdit);常量用 SCREAMING_SNAKE(MAX_RETRY_COUNT)。若名字需要注释解释,就应改名。
  • 函数规范:函数要小(最多 20 行,理想 5-10 行),只做一件事,单一抽象层级,参数最多 3 个,避免意外副作用。
  • 代码结构:用守卫子句提前返回处理边界情况,避免深层嵌套(最多 2 层),通过组合小函数构建,相关代码就近放置。
  • AI 编码风格:用户要功能就直接写,用户报 bug 就直接修而不先解释,需求不清就先问不要假设。
  • 反模式:逐行注释、为一行代码写辅助函数、为两个对象写工厂、滥用 utils.ts、先讲“首先我们导入”、深层嵌套、魔法数字、上帝函数等,均应避免。

使用方式与约束:编辑任何文件前先思考——谁导入了这个文件、这个文件导入了什么、哪些测试覆盖它、是否为共享组件;规则是在同一任务中编辑该文件及其全部依赖文件,绝不留下损坏的导入。完成任务前需自检目标是否达成、是否改全必要文件、代码是否可用、lint 与 TypeScript 是否通过、是否遗漏边界情况,任一失败需先修复。

验证脚本:不同角色执行各自的脚本,例如前端执行 python ~/.claude/skills/frontend-design/scripts/ux_audit.py .,后端执行 python ~/.claude/skills/api-patterns/scripts/api_validator.py .,测试执行 python ~/.claude/skills/testing-patterns/scripts/test_runner.py . 等。脚本输出须按“读取→汇总→询问”流程处理,先汇总错误、警告与通过项并询问是否修复,等待用户确认后再修复,修复后重跑脚本确认。

限制:资料未提供该技能的收费、价格、平台支持范围及具体安装方法,暂未提供。