Configuring Kubb

Kubb is configured with a configuation file (preferably with kubb.config.js).

TypeScript/JavaScript

TIP

When using a import statement you need to set "type": "module" in your package.json.

You can also rename your file to kubb.config.mjs to use ESM or `kubb.config.cjs for CJS.

DefineConfig

When using TypeScript/JavaScript you need to use defineConfig to create your config.

typescript

export const defineConfig = (
  options:
    | MaybePromise<KubbUserConfig>
    | ((
      /** The options derived from the CLI flags */
      cliOptions: CLIOptions,
    ) => MaybePromise<KubbUserConfig>),
) => options

export const defineConfig = (
  options:
    | MaybePromise<KubbUserConfig>
    | ((
      /** The options derived from the CLI flags */
      cliOptions: CLIOptions,
    ) => MaybePromise<KubbUserConfig>),
) => options

Basic config

kubb.config.js

typescript

import { defineConfig } from '@kubb/core'

export default defineConfig({
  root: '.',
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
    clean: true,
  },
})

import { defineConfig } from '@kubb/core'

export default defineConfig({
  root: '.',
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
    clean: true,
  },
})

Conditional config

If the config needs to be conditionally determined based on CLI options flags, it can be exported as a function instead.
Here you can choose between returning the config options synchronously or asynchronously.

typescript

// CLI options flags
export type CLIOptions = {
  /**
   * Path to `kubb.config.js`
   */
  config?: string
  /**
   * Watch changes on input
   */
  watch?: string

  /**
   * Log level to report when using the CLI
   *
   * `silent` will hide all information that is not relevant
   *
   * `info` will show all information possible(not related to the PluginManager)
   *
   * `debug` will show all information possible(related to the PluginManager), handy for seeing logs
   * @default `silent`
   */
  logLevel?: LogLevels
}

// CLI options flags
export type CLIOptions = {
  /**
   * Path to `kubb.config.js`
   */
  config?: string
  /**
   * Watch changes on input
   */
  watch?: string

  /**
   * Log level to report when using the CLI
   *
   * `silent` will hide all information that is not relevant
   *
   * `info` will show all information possible(not related to the PluginManager)
   *
   * `debug` will show all information possible(related to the PluginManager), handy for seeing logs
   * @default `silent`
   */
  logLevel?: LogLevels
}

kubb.config.js

typescript

import { defineConfig } from '@kubb/core'

export default defineConfig(async ({ config, debug, watch }) => {
  await setTimeout(() => {
    // wait for 1s, async behaviour
    return Promise.resolve(true)
  }, 1000)

  return {
    root: '.',
    input: {
      path: './petStore.yaml',
    },
    output: {
      path: './src/gen',
      clean: true,
    },
  }
})

import { defineConfig } from '@kubb/core'

export default defineConfig(async ({ config, debug, watch }) => {
  await setTimeout(() => {
    // wait for 1s, async behaviour
    return Promise.resolve(true)
  }, 1000)

  return {
    root: '.',
    input: {
      path: './petStore.yaml',
    },
    output: {
      path: './src/gen',
      clean: true,
    },
  }
})

Example with a plugin

kubb.config.js

typescript

import { defineConfig } from '@kubb/core'
import createSwagger from '@kubb/swagger'

export default defineConfig(async () => {
  return {
    root: '.',
    input: {
      path: './petStore.yaml',
    },
    output: {
      path: './src/gen',
    },
    plugins: [createSwagger({ 'output': 'schemas', 'validate': true })],
  }
})

import { defineConfig } from '@kubb/core'
import createSwagger from '@kubb/swagger'

export default defineConfig(async () => {
  return {
    root: '.',
    input: {
      path: './petStore.yaml',
    },
    output: {
      path: './src/gen',
    },
    plugins: [createSwagger({ 'output': 'schemas', 'validate': true })],
  }
})

JSON

You can use a JSON schema to be sure you are using the correct configs.

Example with a plugin

kubb.json

json

{
  "$schema": "@kubb/core/schemas.json",
  "root": ".",
  "input": {
    "path": "./petStore.yaml"
  },
  "output": {
    "path": "./src/gen"
  },
  "logLevel": "info",
  "plugins": ["@kubb/swagger", { "output": "schemas", "validate": true }]
}

{
  "$schema": "@kubb/core/schemas.json",
  "root": ".",
  "input": {
    "path": "./petStore.yaml"
  },
  "output": {
    "path": "./src/gen"
  },
  "logLevel": "info",
  "plugins": ["@kubb/swagger", { "output": "schemas", "validate": true }]
}

Object

Example with a plugin

kubb.json

json

{
  "$schema": "@kubb/core/schemas.json",
  "root": ".",
  "input": {
    "path": "./petStore.yaml"
  },
  "output": {
    "path": "./src/gen"
  },
  "logLevel": "info",
  "plugins": {
    "@kubb/swagger": { "output": "schemas", "validate": true }
  }
}

{
  "$schema": "@kubb/core/schemas.json",
  "root": ".",
  "input": {
    "path": "./petStore.yaml"
  },
  "output": {
    "path": "./src/gen"
  },
  "logLevel": "info",
  "plugins": {
    "@kubb/swagger": { "output": "schemas", "validate": true }
  }
}

YAML

Example with a plugin

.kubbrc

yaml

root: .
input:
  path: ./petStore.yaml
output:
  path: ./src/gen
plugins:
  - '@kubb/swagger'
  - output: schemas
    validate: true

root: .
input:
  path: ./petStore.yaml
output:
  path: ./src/gen
plugins:
  - '@kubb/swagger'
  - output: schemas
    validate: true

Read more about configuring the options.

@kubb/swagger-client

Configuring Kubb ​

TypeScript/JavaScript ​

DefineConfig ​

Basic config ​

Conditional config ​

Example with a plugin ​

JSON ​

Example with a plugin ​

Object ​

Example with a plugin ​

YAML ​

Example with a plugin ​

Configuring Kubb

TypeScript/JavaScript

DefineConfig

Basic config

Conditional config

Example with a plugin

JSON

Example with a plugin

Object

Example with a plugin

YAML

Example with a plugin