Lifecycle Hooks

The codegen allows specifying scripts it can run for you in certain events.

You can specify hooks on the root level or specify hooks on the output level (only some of them).

Each hook has its arguments, and it passes them to your scripts using argv.

How to use?

Add your scripts to your codegen.ts file, and specify the scripts you wish to run, for example:

import { CodegenConfig } from '@graphql-codegen/cli'
 
const config: CodegenConfig = {
  schema: 'http://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      plugins: []
    }
  },
  hooks: {
    afterOneFileWrite: ['prettier --write']
  }
}
 
export default config

Or, for specific output:

import { CodegenConfig } from '@graphql-codegen/cli'
 
const config: CodegenConfig = {
  schema: 'http://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      plugins: [],
      hooks: {
        afterOneFileWrite: ['prettier --write']
      }
    }
  }
}
 
export default config

Root Level

The following lifecycle hooks are supported on the root level:

`afterStart`

Triggered with no arguments when the codegen starts (after the codegen.ts has been loaded).

`onWatchTriggered`

Triggered every time a file changes when using watch mode. Triggered with two arguments: the type of the event (for example, changed) and the file's path.

`onError`

Triggered in case of a general error in the codegen. The argument is a string containing the error.

`beforeAllFileWrite`

Executed after the codegen has created the output and before writing the files to the file system.

Triggered with multiple arguments - paths for all relevant files.

💡

Not all the files will be written to the file system, because this is triggered before checking if the file has changed since last execution.

`beforeOneFileWrite`

Triggered before a file is written to the file system. Executed with the path for the file.

If the content of the file hasn't changed since the last execution - this hook won't be triggered.

`afterOneFileWrite`

Triggered after a file is written to the file system. Executed with the path for the file. If the content of the file hasn't changed since the last execution - this hook won't be triggered.

💡

This is a very useful hook, you can use it for integration with Prettier or other linters.

`afterAllFileWrite`

Executed after writing all the files to the file system. Triggered with multiple arguments - paths for all files.

`beforeDone`

Triggered with no arguments, right before the codegen closes or when watch mode is stopped.

Output Level

The following hooks are available for a single output file: beforeOneFileWrite and afterOneFileWrite.

Output level hooks are triggered before root level hooks.

Last updated on August 31, 2022

Naming Convention Multi Project