GraphQL Modules Preset

          npm i -D @graphql-codegen/graphql-modules-preset
        

          yarn add -D @graphql-codegen/graphql-modules-preset
        

          pnpm add -D @graphql-codegen/graphql-modules-preset
        

          bun add -D @graphql-codegen/graphql-modules-preset
        

Config API Reference

baseTypesPath

type: string

Required, should point to the base schema types file. The key of the output is used a base path for this file.

importBaseTypesFrom

type: string

Overrides the package import for the base types. Use this if you are within a monorepo, and you wish to import the base types directly from a different package, and not from a relative path.

cwd

type: string

Optional, override the cwd of the execution. We are using cwd to figure out the imports between files. Use this if your execution path is not your project root directory. Default value: “process.cwd()“

importTypesNamespace

type: string

Optional, override the name of the import namespace used to import from the baseTypesPath file. Default value: “Types”

filename

type: string

Required, sets the file name for the generated files.

encapsulateModuleTypes

type: string

Configure how to encapsulate the module types, to avoid confusion.

namespace (default): will wrap all types in a TypeScript namespace, using the module name. prefix: will prefix all types from a specific module with the module name. none: will skip encapsulation, and generate type as-is. Default value: “namespace”

requireRootResolvers

type: boolean

Generate resolvers of root types (Query, Mutation and Subscription) as non-optional. Default value: “false”

useGraphQLModules

type: boolean

By default, the generated types will generate some code specific to graphql-modules library.

If you are not using GraphQL-Modules, you can disable this feature by setting this to false. Default value: “true”

- src/
  - modules/
    - user/
      - resolvers.ts
      - typedefs/
        - user.graphql
    - product/
      - resolvers.ts
      - typedefs/
        - product.graphql

import type { CodegenConfig } from '@graphql-codegen/cli'

const config: CodegenConfig = {
  schema: './src/modules/**/typedefs/*.graphql',
  generates: {
    './src/modules/': {
      preset: 'graphql-modules',
      presetConfig: {
        baseTypesPath: '../generated-types/graphql.ts',
        filename: 'generated-types/module-types.ts'
      },
      plugins: [
        {
          add: {
            content: '/* eslint-disable */'
          }
        },
        'typescript',
        'typescript-resolvers'
      ]
    }
  }
}
export default config

import { MyModule } from './generated-types/module-types'

export const resolvers: MyModule.Resolvers = {
  // Here you can implement only the types and fields defined in your module!
}