Gatsby#

If you build apps using Gatsby, you can use GraphQL Code Generator to generate TypeScript types.

The codegen knows automatically to look for the import of the graphql tag for gatsby package.

Using the following config file should cover everything specific to Gatsby:

schema: http://localhost:8000/___graphql
documents:
  - ./src/**/*.{ts,tsx}
  - ./node_modules/gatsby*/!(node_modules)/**/*.js
generates:
  ./src/graphqlTypes.ts:
    plugins:
      - typescript
      - typescript-operations

Now, the codegen should load your GraphQL operations from your source code and load all the internal fragments from node_modules.

Note on `documents` section

The glob expression above should get you started quickly, but note that it's vast and might load many files that match the ./node_modules/gatsby*/!(node_modules)/**/*.js pattern. If you are having issues with this glob expression, or if you see performance issues, please note that you need to narrow this expression to the bare minimum that is being loaded by your Gatsby instance.

This issue might help

Community Plugins#

There are also community Gatsby plugins that integrate with @graphql-codegen: