关于 codegen
codegen 是用于根据 @cartridge/keychain 的 API schema 重新生成 GraphQL 类型的技能。它列出执行命令,以及检查生成文件、TypeScript 错误和测试的步骤。
主要功能
- 01根据 schema 重新生成 GraphQL 类型
- 02使用 pnpm 执行代码生成
- 03检查生成的 TypeScript 文件
- 04检查 API 相关的 TypeScript 错误
- 05生成后运行测试
适用场景
- 01API schema 变更后更新类型
- 02编辑 GraphQL 查询后刷新类型
- 03排查 API 调用中的类型错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ cartridge-gg/ controller --skill codegen安装后在 Claude Code 中输入/codegen确认已加载。
详细介绍
GraphQL 代码生成技能
根据 API 架构重新生成 GraphQL 类型。
用法
在以下情况下运行:
- API 架构发生更改
- 新增或修改 GraphQL 查询/变更
- API 调用出现类型错误
步骤
- 运行
pnpm --filter @cartridge/keychain codegen - 检查
packages/keychain/src/utils/api/graphql.ts中生成的类型 - 检查使用 API 的文件是否存在 TypeScript 错误
- 运行
pnpm test,确保测试仍能通过
配置
- 架构来源:https://api.cartridge.gg/query
- 配置:
packages/keychain/src/utils/api/codegen.yaml - 在构建过程中自动运行
备注
- 运行
pnpm build时也会自动触发代码生成 - 不应手动编辑生成的文件
- 更新架构时,请一并提交生成的更改
评论
支持 Markdown