SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 00:01

技能介绍

用途:为 AI 编程代理提供务实的编码标准,让代理直接产出可运行代码,而非写教程或解释。核心原则包括单一职责(SRP)、避免重复(DRY)、保持简单(KISS)、不做无用功能(YAGNI)以及“童子军规则”(让代码比接手时更整洁)。

主要能力:命名规范(变量体现意图如 userCount、函数用动词加名词如 getUserById、布尔值用疑问式如 isActive、常量用 SCREAMING_SNAKE);函数规则(不超过 20 行、只做一件事、单一抽象层级、参数不超过 3 个、避免意外副作用);代码结构(用守卫子句提前返回、避免超过 2 层嵌套、小函数组合、相关代码就近放置)。

使用方式:代理在用户要求功能时直接编写,报告缺陷时直接修复而不先解释,需求不清时先询问而非假设。编辑文件前需先思考:谁导入了该文件、该文件导入了什么、哪些测试覆盖它、是否为共享组件,并在同一任务中同步修改所有依赖文件,不留断裂的导入。完成任务前须自检目标是否达成、文件是否全部修改、代码是否验证、lint 与 TypeScript 是否通过、是否遗漏边界情况。

验证脚本:各代理只运行自身技能对应的脚本,例如前端运行 ux_audit.py 与 accessibility_checker.py,后端运行 api_validator.py,安全运行 security_scan.py,测试运行 test_runner.py 等;脚本输出须按“读取→汇总→询问”流程处理,先汇总错误、警告与通过项,等待用户确认后再修复,修复后重跑确认。

限制:资料未提供该技能的安装方式、收费模式、支持平台及具体效果数据。