用途:在 API schema 发生变化、GraphQL 查询或变更被新增或修改、或 API 调用出现类型错误时,重新生成 GraphQL 类型。
主要能力:从 API schema 生成对应的 GraphQL 类型,并可通过测试验证生成结果是否正常。
使用方式:执行命令 pnpm --filter @cartridge/keychain codegen;随后检查 packages/keychain/src/utils/api/graphql.ts 中生成的类型;检查使用该 API 的文件是否存在 TypeScript 错误;运行 pnpm test 确认测试仍然通过。
配置:schema 来源为 https://api.cartridge.gg/query,配置文件位于 packages/keychain/src/utils/api/codegen.yaml,构建过程中会自动运行。
限制与注意:codegen 也会在 pnpm build 时自动触发;生成的文件不应手动编辑;schema 更新时应一并提交生成的变更。