File Generation Control

Complete control over which files are auto-generated and their output paths (v2.0+).

Overview

Nitro GraphQL auto-generates several files. You can:

• Disable specific files
• Customize output paths
• Use path placeholders
• Configure per-service paths

Configuration Structure

graphql: {
  framework: 'graphql-yoga',

  // Scaffold files
  scaffold: false | {
    enabled?: boolean
    graphqlConfig?: boolean | string
    serverSchema?: boolean | string
    serverConfig?: boolean | string
    serverContext?: boolean | string
  },

  // Client utilities (Nuxt only)
  clientUtils: false | {
    enabled?: boolean
    index?: boolean | string
    ofetch?: boolean | string
  },

  // SDK files
  sdk: false | {
    enabled?: boolean
    main?: boolean | string
    external?: boolean | string
  },

  // Type files
  types: false | {
    enabled?: boolean
    server?: boolean | string
    client?: boolean | string
    external?: boolean | string
  },

  // Global path overrides
  paths: {
    serverGraphql?: string
    clientGraphql?: string
    buildDir?: string
    typesDir?: string
  }
}

Examples

Library Mode (No Scaffolding)

graphql: {
  scaffold: false,
  clientUtils: false,
}

Custom Monorepo Paths

graphql: {
  paths: {
    serverGraphql: 'packages/api/src/graphql',
    clientGraphql: 'packages/web/src/graphql',
    typesDir: 'packages/types/src/generated',
  },
}

Selective File Generation

graphql: {
  scaffold: {
    graphqlConfig: false,              // Don't generate
    serverSchema: 'lib/schema.ts',     // Custom path
    serverConfig: true,                // Default location
    serverContext: false,              // Don't generate
  },
}

Path Placeholders

Placeholder	Description	Example
{serviceName}	External service name	github, stripe
{buildDir}	Build directory	.nitro or .nuxt
{rootDir}	Root directory	/Users/you/project
{framework}	Framework name	nuxt or nitro
{typesDir}	Types directory	.nitro/types
{serverGraphql}	Server GraphQL dir	server/graphql
{clientGraphql}	Client GraphQL dir	app/graphql

Example:

sdk: {
  external: '{clientGraphql}/{serviceName}/sdk.ts'
}
// → app/graphql/github/sdk.ts
// → app/graphql/stripe/sdk.ts

Service-Specific Paths

externalServices: [
  {
    name: 'github',
    endpoint: '...',
    paths: {
      sdk: 'app/graphql/organization/github-sdk.ts',
      types: 'types/github.d.ts',
    }
  },
]

Path Resolution Priority

1. Service-specific path (service.paths.sdk)
2. Category config (sdk.external)
3. Global paths (paths.clientGraphql)
4. Framework defaults

Next Steps

• Path Customization
• External Services
• Auto-Discovery