0.10.0 • Published 3 years ago
@stackup/codegen v0.10.0
A zero-config CLI tool to generate GraphQL type definitions and React Hooks. It's a thin wrapper around GraphQL code generator.
Install
$ yarn add @stackup/codegen --dev
$ yarn codegen --help
Generate type definitions from GraphQL queries.
USAGE
$ @stackup/codegen ROOT
ARGUMENTS
ROOT directory where your GraphQL queries live
OPTIONS
-s, --schema=schema (required) URL or file path to the GraphQL schema
-t, --types=types declare type for a custom scalar
--colocate=colocate generate files adjacent to their GraphQL source
--help show CLI help
--immutable generate readonly types
--show-config show the generated configuration
--suffix append a suffix to generated types
--version show CLI version
Usage
You have a directory of queries:
src/
queries/
posts.graphql
users.graphql
Run the code generator:
$ yarn codegen src/queries --schema http://localhost:3000/graphql
Now, you have code!
src/
queries/
index.ts <- This module exports typed React Hooks
schema.graphql <- This file contains your GraphQL schema
posts.graphql
users.graphql
Import the typed document node and use a query:
import { useQuery } from "@apollo/client"
import { UserDocument } from "../queries";
useQuery(UserDocument);
Colocated Queries
What if you want your queries to live next to your components?
src/
components/
User/
User.tsx
queries.graphql
Run the code generator:
$ yarn codegen src --colocate src/queries --schema http://localhost:3000/graphql
Now, your file tree should look like this:
src/
queries/
index.ts <- This module exports your schema's types
schema.graphql <- This file contains your GraphQL schema
components/
User/
User.tsx
queries.graphql
queries.ts <- This module exports typed React hooks
0.10.0
3 years ago
0.10.0-beta.2
3 years ago
0.10.0-beta.3
3 years ago
0.10.0-beta.0
3 years ago
0.10.0-beta.1
3 years ago
0.9.0-beta.0
3 years ago
0.9.0
3 years ago
0.8.4
3 years ago
0.8.3
3 years ago
0.8.1
3 years ago
0.8.2
3 years ago
0.8.0
3 years ago
0.7.0
3 years ago
0.6.0
3 years ago
0.5.0-beta.0
4 years ago
0.5.0
4 years ago
0.4.2
4 years ago
0.4.1
4 years ago
0.3.0
4 years ago
0.4.0
4 years ago
0.2.6
4 years ago
0.2.3
4 years ago
0.2.2
4 years ago
0.2.5
4 years ago
0.2.4
4 years ago
0.2.1
4 years ago
0.2.0
4 years ago
0.1.1
4 years ago
0.1.0
4 years ago