gatsby-plugin-typegen

gatsby-plugin-typegen

Watch your queries and automatically generates TypeScript/Flow definitions out-of-box.

Features

• Schema extraction
• Plugin documents extraction
• Generates type definitions using graphql-codegen
• Auto-fixing <StaticQuery> and useStaticQuery() in code with generated type name.
• Integrates GatsbyJS project with GraphQL & TypeScript ecosystem.
• Provides type definitions for the schema customization.
• Provides utility types for gatsby-node.js.

Demo

Install

yarn add gatsby-plugin-typegen

# or
# npm install --save gatsby-plugin-typegen

How to use

// In your gatsby-config.js
plugins: [`gatsby-plugin-typegen`]

Example of type-safe usage

import type { PluginOptions as TypegenPluginOptions } from 'gatsby-plugin-typegen/types';

type Plugin = (
  | string
  | { resolve: string, options: object }
  | { resolve: `gatsby-plugin-typegen`, options: TypegenPluginOptions }
);

const plugins: Plugin[] = [
  {
    resolve: `gatsby-plugin-typegen`,
    options: {
      // ... customize options here
    },
  },
];

module.exports = {
  plugins,
};

Change the output path

{
  options: {
    outputPath: `src/__generated__/gatsby-types.d.ts`,
  },
}

Switch to Flow

{
  options: {
    language: `flow`,
    outputPath: `src/__generated__/gatsby-types.flow.js`,
  },
}

Add generated typedefs to .flowconfig:

[lib]
./src/__generated__/gatsby-types.flow.js

Emit schema as GraphQL SDL

{
  options: {
    emitSchema: {
      'src/__generated__/gatsby-schema.graphql': true,
    },
  },
}

Visualized via GraphQL Voyager.

ESLint

You can use the extracted schema file for eslint-plugin-graphql!

// gatsby-config.js

module.exports = {
  plugins: [
    // ...
    {
      resolve: `gatsby-plugin-typegen`,
      options: {
        emitSchema: {
          'src/__generated__/gatsby-introspection.json': true,
        },
      },
    },
  ],
};

// .eslintrc.js

const path = require('path');

module.exports = {
  plugins: [
    'graphql'
  ],
  rules: {
    'graphql/template-strings': ['error', {
      env: 'relay',
      tagName: 'graphql',
      schemaJsonFilepath: path.resolve(__dirname, 'src/__generated__gatsby-introspection.json'),
    }],
  },
};

VSCode extension

I recommend to use Apollo GraphQL extension.

(YES, even this isn't Apollo project)

• Install the extension.

• Configure plugin to emit schema and plugin documents.

  // gatsby-config.js
  
  module.exports = {
    plugins: [
      // ...
      {
        resolve: `gatsby-plugin-typegen`,
        options: {
          emitSchema: {
            'src/__generated__/gatsby-introspection.json': true,
          },
          emitPluginDocuments: {
            'src/__generated__/gatsby-plugin-documents.graphql': true,
          },
        },
      },
    ],
  };
  

• Create apollo.config.js file in project root.

  // apollo.config.js
  
  module.exports = {
    client: {
      name: 'your-project-name',
      tagName: 'graphql',
      includes: [
        './src/**/*.{ts,tsx}',
        './src/__generated__/gatsby-plugin-documents.graphql',
      ],
      service: {
        name: 'GatsbyJS',
        localSchemaFile: './src/__generated__/gatsby-schema.graphql',
      }
    },
  }
  

• Reload VSCode & Enjoy!
  

TypeScript plugin

The extracted schema file can also be used for ts-graphql-plugin. Using the config defined in Emit schema as GraphQL SDL:

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "plugins": [
      {
        "name": "ts-graphql-plugin",
        "schema": "src/__generated__/gatsby-schema.graphql",
        "tag": "graphql"
      }
    ]
  },
}

Available options

Checkout the full documentation of plugin options from src/types.ts.

Disclaimer

This plugin is a bit opinionated about how integrate GatsbyJS and codegen.

You cannot customize plugins and its options of graphql-codegen because this plugin is built for ONLY GatsbyJS.

If you wanna use codegen with other plugins (e.g. React Apollo), you can use @graphql-codegen/cli for it.

Or gatsby-plugin-graphql-codegen gives you a more flex options.

Troubleshooting

Error: Cannot use GraphQLSchema "[object GraphQLSchema]" from another module or realm.

See https://github.com/cometkim/gatsby-plugin-typegen/issues/120

Changelog

v2.2.4

• Fix misconfigured codegen options (#$81)

v2.2.3

• Allow React v17 as peer dependency (#140)

v2.2.2

• Fix missing options (#$81)

v2.2.1

• Fixes bug caused by upstream behavior change (#93)

v2.2.0

• Use union types instead of enum values (#78)
• Emit schema when add a new frontmatter field (#82)

v2.1.0

• Use string type for the GatsbyJS's Date scalar by default. (#73)
• Allow to add type mappings for custom scalars. (#73)
• Avoid using unstable API internally (#71, original issue: #54)

v2.0.1

• Fix multiple query definitions in plugin documents on Windows (#66, original issue: #44)

v2.0.0

• [BREAKING CHANGE] Generated types are now using global declaration with a namespace (default is GatsbyTypes).
• Fixed an issue where the insert types function only worked when documents were changed. (#43)

v1.1.2

• Export inline fragment subtypes. (#45)
• Insert eslint-disable comment on top of generated file. (#37)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Hyeseong Kim 🚧 💻 📖 🐛 🤔 👀	Richard Sewell 💻 🚧	Derek Nguyen 💻 🚧	Vincent Khougaz 💻	JongChan Choi 💻 📖	John Rom 💻	Jeremy Albright 💻 🐛 🤔 👀
Lars Francke 📖	Piotr Monwid-Olechnowicz 📖	Edward Kim 🐛 💻	Emily Marigold Klassen 📖	Thijmen 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Acknowledgements

• graphql-code-generator by @dotansimha
  The where this plugin started from.

• gatsby-plugin-graphql-codegen by @d4rekanguok
  Has almost same goal, but little bit different how handle GraphQL documents. @d4rekanguok also makes great contribution to this plugin as well!

• gatsby-plugin-extract-code by @NickyMeuleman
  Gives me an idea of ESLint integraiton.