SuperAPI AI 工具集

clean-code

通用与其它

查看项目

更新于 10-16 06:15

技能介绍

该技能用于约束 AI 编写代码时的风格与行为,核心目标是让产出简洁、直接、围绕可运行方案,而非讲编程课。

用途:为 AI 编码代理提供一套务实的编码标准与工作纪律,用于写新功能、修缺陷、改文件和交付前的自查。

主要能力:

  • 核心原则:SRP(单一职责)、DRY(不重复)、KISS(保持简单)、YAGNI(不做用不上的功能)、童子军规则(让代码比接手时更干净)。
  • 命名规则:变量反映意图(userCount 而非 n);函数用动词+名词(getUserById());布尔用疑问式(isActive、hasPermission、canEdit);常量用 SCREAMING_SNAKE(MAX_RETRY_COUNT)。若需注释解释名称,就改名。
  • 函数规则:尽量小(最多 20 行,理想 5-10 行);只做一件事;单一抽象层级;参数最多 3 个,优先 0-2 个;避免非预期修改输入。
  • 代码结构:用守卫子句提前返回边界情况;扁平优于深层嵌套(最多 2 层);小函数组合;相关代码就近放置。
  • AI 编码风格:用户要功能就直接写;报告缺陷就直接修,不先解释;需求不清先问不臆测。
  • 反模式:不给每行加注释、不为一行代码建 helper、不为两个对象建工厂、不建只含一个函数的 utils.ts、不写“首先我们导入……”式叙述、不用魔法数字、不写上帝函数。
  • 改动前思考:该文件被谁导入、它导入了什么、哪些测试覆盖它、是否为共享组件;要求在同一任务内同时修改文件与其依赖文件,不留断裂的导入。
  • 交付前自查:目标是否达成、必要文件是否都改、代码是否验证、lint 与 TypeScript 是否通过、是否遗漏边界情况。任一项失败需先修复。

使用方式:技能内含按代理角色对应的校验脚本映射,例如 frontend-specialist 运行 python ~/.claude/skills/frontend-design/scripts/ux_audit.py . 与 python ~/.claude/skills/frontend-design/scripts/accessibility_checker.py .;backend-specialist 运行 python ~/.claude/skills/api-patterns/scripts/api_validator.py .;security-auditor 运行 python ~/.claude/skills/vulnerability-scanner/scripts/security_scan.py .;test-engineer 运行 python ~/.claude/skills/testing-patterns/scripts/test_runner.py . 等。每个代理只运行自身技能对应的脚本。脚本输出须按“读取→汇总→询问”流程处理:捕获全部输出,区分错误、警告与通过项,向用户汇总后等待确认再修复,修复后重跑确认;忽略输出或未询问就自动修复均属违规。

适用场景:AI 代理参与日常开发、缺陷修复、代码审查前的自动校验,以及多代理分工的仓库协作。

限制:资料未提供安装命令、收费与价格信息、支持平台、效果数据或具体语言绑定,相关事实暂未提供。