@graphql-codegen/cli

What is @graphql-codegen/cli?

The @graphql-codegen/cli package is a command-line interface tool that automates the generation of GraphQL types, resolvers, and operation functions based on your GraphQL schema and operations. It supports multiple programming languages and frameworks, making it a versatile tool for developers working with GraphQL.

What are @graphql-codegen/cli's main functionalities?

TypeScript Types Generation

Generates TypeScript typings for GraphQL queries, mutations, and subscriptions, making it easier to work with GraphQL in TypeScript projects. The configuration file 'codegen.yml' specifies the schema and documents locations, plugins, and the output file paths.

graphql-codegen --config codegen.yml

Resolvers Signature

Creates TypeScript or JavaScript signatures for GraphQL resolvers based on the schema. This helps in implementing resolvers by providing type safety and auto-completion in IDEs.

graphql-codegen --config codegen.yml

Fragment Matcher

Generates a utility for optimizing cache behavior with GraphQL clients like Apollo Client by generating a fragment matcher file. This is particularly useful for interfaces and union types in GraphQL.

graphql-codegen --config codegen.yml

Other packages similar to @graphql-codegen/cli

graphql-code-generator

An alternative package name that often refers to the same tool as @graphql-codegen/cli. It's not a different package but can sometimes be confused as such due to naming.

type-graphql

TypeGraphQL is a framework for building GraphQL APIs in TypeScript, focusing on defining schemas using classes and decorators. It differs from @graphql-codegen/cli by being more of a full framework rather than just a code generation tool.

README

GraphQL Code Generator

Live demo and full documentation: the-guild.dev/graphql/codegen

Project repository: graphql-code-generator