SuperAPI AI 工具集

code-quality-principles

测试与质量

查看项目

更新于 10-15 21:11

技能介绍

用途:这是一份经典软件工程设计原则在 AI 协作场景下的现代化清单,作为新模块设计、重构、代码审查时的对照表,本身不替代具体执行 skill。

触发场景:编写新模块、新服务、新接口;用户提到“设计”“拆分模块”“评审”“重构”;/review、/new-feature、/optimize、/design 命令的设计阶段;评估技术债时定位坏味道。

六原则速查:1)模块大小适中,单文件控制在职责边界内,默认阈值 Java ≤ 300、Go ≤ 400、Vue ≤ 200、TS ≤ 300、Python ≤ 300,项目可覆盖,主要执行交给 size-check。2)减少调用深度,调用链尽量 ≤ 3 层,栈深度大于 5 视为坏味道。3)多扇入、少扇出,单方法直接依赖数 ≤ 5,被依赖数越多越好。4)接口边界清晰,入参、出参、异常统一,推荐统一 {code, data, message} 包装,异常在 middleware/interceptor 集中处理,早期 return 优于深嵌套。5)作用域内聚,模块内修改不越界影响其他模块,私有实现不暴露为公共 API,跨模块通信走明确 API、事件或消息,不通过共享可变状态。6)功能可预测,同输入同输出,写操作使用幂等键去重,时间统一 UTC 并在边界转换,纯函数优先,副作用集中在 IO/DB/网络边界。

检查清单:新增或修改模块前逐条核对大小、深度、扇出、边界、作用域、幂等、隐式依赖(时区、当前时间、随机数等)。

与其他 skill 的边界:原则 1 由 size-check 执行,本 skill 仅触发提示;原则 2、3 由本 skill 主导;原则 4 对照 api-design-safety;原则 5 提示 refactor-safety 与 multi-tenant-safety;原则 6 由本 skill 主导,具体陷阱交由 time-zone-safety、redis-safety、query-performance-safety 处理。

限制:资料未提供安装命令、平台支持、收费方式与具体代码示例,相关细节暂未提供。