@graphql-codegen/graphql-modules-preset/typings/config.d.cts

GraphQL Code Generator preset for modularized schema

export type ModulesConfig = {
    /**
     * @name baseTypesPath
     * @type string
     * @description Required, should point to the base schema types file.
     * The key of the output is used a base path for this file.
     *
     * @example
     * ```ts filename="codegen.ts" {10}
     *  import type { CodegenConfig } from '@graphql-codegen/cli';
     *
     *  const config: CodegenConfig = {
     *    // ...
     *    generates: {
     *      'path/to/file.ts': {
     *        preset: 'modules',
     *        plugins: ['typescript-resolvers'],
     *        presetConfig: {
     *          baseTypesPath: 'types.ts'
     *        },
     *      },
     *    },
     *  };
     *  export default config;
     * ```
     */
    baseTypesPath: string;
    /**
     * @name importBaseTypesFrom
     * @type string
     * @description 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.
     *
     */
    importBaseTypesFrom?: string;
    /**
     * @name cwd
     * @type string
     * @description 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 process.cwd()
     *
     * @example
     * ```ts filename="codegen.ts" {10}
     *  import type { CodegenConfig } from '@graphql-codegen/cli';
     *
     *  const config: CodegenConfig = {
     *    // ...
     *    generates: {
     *      'path/to/file.ts': {
     *        preset: 'modules',
     *        plugins: ['typescript-resolvers'],
     *        presetConfig: {
     *          baseTypesPath: 'types.ts',
     *          cwd: '/some/path'
     *        },
     *      },
     *    },
     *  };
     *  export default config;
     * ```
     */
    cwd?: string;
    /**
     * @name importTypesNamespace
     * @type string
     * @description Optional, override the name of the import namespace used to import from the `baseTypesPath` file.
     * @default Types
     *
     * @example
     * ```ts filename="codegen.ts" {10}
     *  import type { CodegenConfig } from '@graphql-codegen/cli';
     *
     *  const config: CodegenConfig = {
     *    // ...
     *    generates: {
     *      'path/to/file.ts': {
     *        preset: 'modules',
     *        plugins: ['typescript-resolvers'],
     *        presetConfig: {
     *          baseTypesPath: 'types.ts',
     *          importTypesNamespace: 'core'
     *        },
     *      },
     *    },
     *  };
     *  export default config;
     * ```
     */
    importTypesNamespace?: string;
    /**
     * @name filename
     * @type string
     * @description Required, sets the file name for the generated files.
     *
     */
    filename: string;
    /**
     * @name encapsulateModuleTypes
     * @type string
     * @default namespace
     * @description 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.
     *
     */
    encapsulateModuleTypes: 'prefix' | 'namespace' | 'none';
    /**
     * @name requireRootResolvers
     * @type boolean
     * @default false
     * @description Generate resolvers of root types (Query, Mutation and Subscription) as non-optional.
     *
     * @example
     * ```yaml
     * generates:
     * src/:
     *  preset: modules
     *  presetConfig:
     *    baseTypesPath: types.ts
     *    filename: types.ts
     *    requireRootResolvers: true
     *  plugins:
     *    - typescript-resolvers
     * ```
     */
    requireRootResolvers?: boolean;
    /**
     * @name useGraphQLModules
     * @type boolean
     * @default true
     * @description 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`.
     */
    useGraphQLModules?: boolean;
};