codegen について
codegen は、@cartridge/keychain の API スキーマから GraphQL 型を再生成するスキルです。実行コマンドに加え、生成ファイル、TypeScript エラー、テストの確認手順を示します。
主な機能
- 01スキーマから GraphQL 型を再生成
- 02pnpm でコード生成を実行
- 03生成された TypeScript ファイルを確認
- 04API関連の TypeScript エラーを確認
- 05生成後にテストを実行
活用シーン
- 01APIスキーマ変更後の型更新
- 02GraphQLクエリ編集後の型再生成
- 03API呼び出しの型エラー調査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ cartridge-gg/ controller --skill codegenインストール後、Claude Code で/codegenを入力して読み込まれたか確認します。
詳細
GraphQL Codegen スキル
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の実行時にも Codegen が自動的にトリガーされます- 生成されたファイルを手動で編集しないでください
- スキーマの更新と一緒に、生成された変更をコミットしてください
コメント
Markdown 対応