SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-15 20:27

技能介绍

用途:这是面向 contentstack-cli-tsgen 仓库的代码审查(PR review)清单技能,帮助审查者按固定维度检查改动,避免遗漏关键风险。

主要能力与审查要点: CLI 与文档方面,当标志或行为变化时,需确保帮助文本、静态示例、README 及 oclif 生成的文档保持同步;短命令名 tsgen / TSGEN 来自 package.json 中的 csdxConfig。 产品语言方面,应优先使用 Delivery token 流程;GraphQL 在代码路径中需要 delivery token,审查者要识别以 CMA 为中心、可能误导用户的措辞。 错误处理方面,src/lib/helper.ts 中的 printFormattedError 将 error_code 映射为用户可见消息,扩展 switch 时需谨慎,保持向后兼容。 依赖边界方面,generateTS / graphqlTS 的业务逻辑属于 @contentstack/types-generator(npm、GitHub),CLI 改动应负责编排与格式化,而非重新实现生成逻辑。 测试与 CI 方面,集成测试依赖 csdx 与 TOKEN_ALIAS,新增用例时需记录环境变量需求。 向后兼容方面,未经 semver 意图,避免对标志、退出行为或输出文件契约造成破坏性变更。 供应链方面,.github/workflows/sca-scan.yml 会在 pull request 上运行 Snyk。

可选严重度分级: Blocker:token 类型处理错误、破坏 csdx 契约、安全问题。 Major:新标志缺少集成测试覆盖、错误信息不清。 Minor:文案、非破坏性重构。

使用方式:作为该仓库 PR 审查时的检查清单逐项对照即可,具体安装与运行步骤资料未提供。

限制:资料未说明该技能的安装方式、命令行调用形式、支持的平台或收费信息,暂未提供。