Package Exports

vite-plugin-graphql-codegen
vite-plugin-graphql-codegen/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vite-plugin-graphql-codegen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vite Plugin GraphQL Codegen

Zero-config vite plugin that uses the vite file watcher to run graphql codegen programmatically without needing to start a separate watcher.

Setup GraphQL Codegen

Installation instructions found here. Optional if already set up in project.

Install Plugin

# npm
npm i -D vite-plugin-graphql-codegen

# yarn
yarn add -D vite-plugin-graphql-codegen

# pnpm
pnpm i -D vite-plugin-graphql-codegen

Initialize Plugin

# vite.config.ts

import { defineConfig } from 'vite';
import codegen from 'vite-plugin-graphql-codegen';

export default defineConfig({
  plugins: [
    codegen()
  ],
});

Options

Providing options is not required as sensible defaults are in place, but there may be times where it's helpful to disable codegen under certain circumstances, like when running builds in CI.

codegen({
  /* Should codegen run when the dev server starts. Defaults to true. */
  runOnStart: true,
  /* Should codegen run on build. Will prevent build if codegen fails. Defaults to true. */
  runOnBuild: true,
  /* Should codegen run when files get added or change. Defaults to true. */
  enableWatcher: true,
  /* Run codegen when a document matches. */
  matchOnDocuments: true,
  /* Run codegen when a schema matches. Only supports file path based schemas. */
  matchOnSchemas: false,
  /* Allows manually defining the codegen config instead of relying on cosmiconfig. */
  config: CodegenConfig,
  /* Allows overriding codegen config options in the context of this plugin. Useful if you prefer a cleaner log by passing { errorsOnly: true }. */
  configOverride: CodegenConfig,
  /* Overrides config on server start. */
  configOverrideOnStart: CodegenConfig,
  /* Overrides config on build. */
  configOverrideOnBuild: CodegenConfig,
  /* Overrides config for the watcher. */
  configOverrideWatcher: CodegenConfig,
  /* Allows overriding the codegen config file path. */
  configFilePathOverride: `${process.cwd()}/codegen.yml`,
  /* Enable plugin logging to assist in debugging. Defaults to false. */
  debug: false,
});