SuperAPI AI 工具集

approachability-audit

编程与开发

查看项目

更新于 10-16 05:07

技能介绍

用途:以“聪明但刚入职的 TypeScript 开发者”视角审查代码,目标不是让代码更短或更抽象,而是降低首次阅读成本、让所有权边界显而易见、移除只为类型系统存在的技巧,同时保留真实的领域或校验边界。

主要能力:识别名称暗示的概念比代码实际更重要、假装是运行时真相却只是推断垫片的类型、只存在于服务端包中的客户端 hack 或服务端关注点泄漏到浏览器/共享代码、隐藏简单控制流的单次使用辅助函数、只增加词汇不增加清晰度的小包装、一个概念拆成多个文件、比直接代码更难信任的“聪明”泛型辅助、清晰解析或互操作边界之外的临时 as 断言、只复述代码而不解释边界存在原因的 JSDoc。

使用方式:从调用方最先使用的入口点开始,追踪理解行为所需的最小路径,统计跳转次数(即 Go-to-Definition 跳转);将每个抽象标记为“值得保留”“可能可内联”“归属边界错误”“命名误导”或“类型系统变通”。修复优先移动代码到正确归属、诚实重命名、折叠虚假层、用一条显式边界替代小聪明。报告时优先给出一两个最大的可读性或归属问题、新开发者会卡在哪里、以及最易信任的绿地修正方案。编辑代码时保持提交外科手术式,在公共边界补充或改进 JSDoc,除非能降低总认知负荷否则不新增抽象,优先使用 *Bridge、*Contract、*Parser、*Factory、*State 等显式名称。

适用场景:TypeScript 代码库的首次阅读审查、新人上手体验优化、重构前的可读性诊断。

限制:不应“修复”JSON、文件或网络边缘的真实解析边界、保护不安全输入的运行时校验、确实应集中一处的共享契约,以及比额外抽象更划算的重复。资料未提供具体安装命令、平台支持或收费信息。