SuperAPI AI 工具集

review-guidelines

编程与开发

查看项目

更新于 10-16 07:19

技能介绍

用途:为特定代码库提供额外的代码审查检查项,供 PR 审查时由审查智能体自动加载,以强制统一项目约定。

主要能力与规则要点: 代码质量:类型定义优先用 type 而非 interface;使用箭头函数 const fn = () => 而非函数声明;用 #field(ES2022 私有字段)代替 TypeScript private;禁止 any,改用 unknown 加类型守卫;除插件入口外不建 index.ts,改用按功能命名的再导出;所有本地导入显式写 .ts 扩展名;参数超过 2 个时使用对象参数,形如 fn({ a, b, c }: { ... });Zod 使用命名空间导入 import * as z from 'zod';直接从具体文件导入,而非经模块内再导出。 测试:用 test() 而非 it() 声明测试;禁止条件断言,先断言条件;覆盖 try/catch、条件分支与回退两条路径;模块解析测试优先使用真实依赖而非 mock;用 describe() 块组织。 Bun 运行时:用 Bun.file() 代替 fs.existsSync()/readFileSync();用 Bun.write() 代替 writeFileSync();用 Bun.$cmd 代替 child_process.spawn();用 import.meta.dir 代替 process.cwd();命令在仓库根目录以 bun --cwd packages/<name> 运行,不要 cd 进 packages。 安全:禁止提交密钥、API key 或 token;检查 OWASP Top 10、命令注入与 XSS;核验新依赖的许可证合规;留意正则中的 ReDoS 模式。 破坏性变更:标记任何公共 API 签名变更;检查被修改导出上的 TSDoc @public 标记;验证 Zod schema 变更的向后兼容性。

使用方式:作为该代码库的审查规范由审查智能体在 PR 审查时自动加载,无需手动调用;具体安装或集成步骤暂未提供。

适用场景:使用 Bun 与 TypeScript、Zod 的该代码库及其团队的 PR 审查。限制:规则仅针对该代码库的约定,不适用于其他项目;安装、配置与收费等信息暂未提供。