用途:在审查他人 PR 或提交 PR 前进行自查,核对 API 表面、错误处理、兼容性、依赖、安全与测试。
主要能力与检查项:
- API 设计与稳定性:新增或变更的公共导出需有 JSDoc,并与 lib/contentstack.js、lib/contentstackClient.js 保持一致;签名或导出变化时更新 types/**;未经明确同意(如大版本)不得引入破坏性变更;命名遵循 CMA 术语与 lib/stack/ 模式。未经批准的破坏性公共 API 为 Blocker,新公共 API 缺 JSDoc/types 为 Major。
- 错误处理与健壮性:错误经 lib/core/contentstackError.js(或等价物)流转,保留状态与安全的请求元数据;不得对可选 API 字段做不安全假设;不得记录完整 authtoken、authorization 或 management_token。新代码错误处理错误或缺失为 Major。
- 依赖与安全:新增或升级依赖需有理由,优先 lodash / axios 模式;处理 Snyk / Dependabot 发现的问题,或建单延期。范围内未修复的严重/高危漏洞为 Blocker。
- 测试:单元测试放在 test/unit/ 并 mock HTTP,注册到 test/unit/index.js;需要时更新 test/sanity-check/api/*-test.js 与 sanity.js,先运行 npm run build,环境按 testSetup.js,仓库内不得有密钥。新行为无测试为 Blocker,测试不稳定为 Major。
- 严重级别:Blocker 必须合并前修复(破坏 API、安全、新代码无测试);Major 应当修复(错误处理、缺文档、不稳定测试);Minor 可选修复(风格、次要文档)。
限制:资料未提供具体安装命令、收费、平台支持或效果数据。