SuperAPI AI 工具集

repo-source-code-review

编程与开发

查看项目

更新于 10-16 07:25

技能介绍

用途:审查修改库源码的拉取请求,在合并前验证实现模式,检查代码质量、类型、文档与测试。

审查流程:理解变更(读 PR 描述、确定受影响文件);检查模式(确认代码遵循既有约定);验证类型(确保类型安全与正确推断);审查文档(确认 JSDoc 完整准确);检查测试(验证运行时与类型测试覆盖)。

代码质量要求:命名匹配既有模式(如 StringSchema、minLength、_parse);纯工厂函数前加 // @NO_SIDE_EFFECTS;所有导入使用 .ts 扩展名;对象形状用 interface,联合/别名用 type;每个 API 包含 name.ts、name.test.ts、name.test-d.ts、index.ts。

类型安全要求:泛型无需显式标注即可正确推断;泛型参数有合适的 extends 约束;导出函数有显式返回类型;.test-d.ts 覆盖类型推断场景。

文档要求:所有导出函数有 JSDoc;首行使用与用途匹配的动词(Schemas 用 Creates a ... schema.,Actions 用 Creates a ... action.,Parse 用 Parses ...,类型守卫用 Checks if ...,Unwrap 用 Unwraps ...);每个参数有 @param;有 @returns;每个重载有独立完整 JSDoc。

测试要求:.test.ts 覆盖成功、失败与边界情况;.test-d.ts 用 expectTypeOf 验证类型推断;测试验证错误消息与 issue 结构。

常见问题:缺少纯度注解;JSDoc 不完整;新 API 无类型测试;导入缺少 .ts 后缀;命名不一致(Schema 未以 Schema 结尾、Action 未以 Action 结尾);纯代码中存在副作用(变更、I/O 或全局状态)。

检查清单:实现遵循相似文件的既有模式;纯工厂函数带 // @NO_SIDE_EFFECTS;导入使用 .ts;对象形状用 interface;所有导出 JSDoc 完整;.test.ts 运行时测试;.test-d.ts 类型测试;遵循命名约定。

限制:资料仅针对 /library/src/ 的源码审查,未提供安装命令、价格或平台信息。