The GraphQL Code Generator should be integrated as part of your development workflow.
If you wish to run the codegen before starting your server/app, you can use
pre scripts in your
package.json, for example:
This way, the codegen will generate the output according to your configuration before each time you run
It's also useful to run the codegen during your continuous integration flow and make sure that you code always compiles with the generated output, this way you can detect breaking changes in your GraphQL schema and GraphQL documents.
If you wish to run the codegen in watch mode, you can specify
-w) when running it.
You can either run it in a separate terminal session, or use tools like
concurrently to run two scripts at the same time:
If you wish, you can specify a custom list of files to watch, by adding a glob expression to the command, using
Use this when you are loading your schema or documents from a single code file, that depends on other files internally, because codegen can't tell that you using those files automatically.
By default, watch mode uses the system's native support to listen for file change events. This can be configured in the settings file to use a stat polling method instead in unusual cases where system support is unavailable.
If you need to execute the codegen multiple times, note that you can specify multiple fields for
generates field, for example: