Options

Option	Type	Default	Description
output	Output	{ path: 'mocks', barrel: { type: 'named' } }	Where the generated files are written and exported
group	Group	—	Split output into per-tag or per-path folders
dateParser	'faker' | 'dayjs' | 'moment' | string	'faker'	Library that formats string date, time, and datetime fields
regexGenerator	'faker' | 'randexp'	'faker'	Library that turns a regex pattern into a string
locale	string	'en'	Faker locale code for the generated values
seed	number | number[]	—	Value passed to faker.seed(...) for deterministic output
include	Array<Include>	—	Keep only operations that match
exclude	Array<Exclude>	—	Skip operations that match
override	Array<Override>	—	Apply different options per pattern
resolver	Partial<ResolverFaker>	—	Customize generated names and file paths
macros	Array<Macro>	—	Rewrite AST nodes before printing
printer	{ nodes?: PrinterFakerNodes }	—	Replace the handler for a schema type

output

Where the generated .ts files are written and how they are exported.

Type:	Output
Default:	{ path: 'mocks', barrel: { type: 'named' } }

output.path

Folder where the plugin writes its files. It is resolved against the global output.path on defineConfig. To write everything to one file instead, set output.mode: 'file' and give path a file name with its extension, such as 'mocks.ts'.

Type:	string
Default:	'mocks'

TIP

output.path sets where files go, output.mode sets how many. Use 'directory' (the default) for one file per operation, optionally grouped into subdirectories with the group option. Use 'file' to write everything into a single file.

output.mode

How the plugin consolidates its generated code into files.

• 'directory' (default) writes one file per operation or schema under output.path.
• 'file' writes everything into a single file. The output.path must include the file extension (for example 'mocks.ts').

Type:	'directory' | 'file'
Default:	'directory'

TIP

Pair 'directory' with the group option to organize output into per-tag or per-path subdirectories. mode: 'file' forbids group. A single-file output has nothing to group, and combining them stops the build with a KUBB_INVALID_PLUGIN_OPTIONS error.

output.barrel

Controls how the generated index.ts (barrel) file re-exports the plugin's output.

• { type: 'named' } re-exports each symbol by name. Best for tree-shaking and explicit imports.
• { type: 'all' } uses export *. Smaller barrel file, but exports everything.
• { nested: true } creates a barrel in every subdirectory, so callers can import from any depth.
• false skips the barrel entirely. The plugin's files are also excluded from the root index.ts.

Type:	{ type: 'named' | 'all', nested?: boolean } | false
Default:	{ type: 'named' }

TIP

Pick 'named' when consumers care about which symbols they import (better tree-shaking, friendlier auto-import). Pick 'all' when the file count is small and you want a one-line barrel.

'named' (default)

// src/gen/mocks/index.ts
export { createPet } from './createPet'
export { createStore } from './createStore'

'all'

// src/gen/mocks/index.ts
export * from './createPet'
export * from './createStore'

nested

src/gen/mocks/
├── index.ts          # re-exports ./pet and ./store
├── pet/
│   ├── index.ts      # re-exports createPet, ...
│   └── createPet.ts
└── store/
    ├── index.ts
    └── createStore.ts

false

# No index.ts is generated for this plugin.
# Its files are also excluded from the root index.ts.

output.banner

Text added to the top of every generated file. Use it for license headers, lint disables, or a @ts-nocheck directive. Pass a string for a fixed banner, or a function that builds one from a BannerMeta object. The meta carries the document info (title, description, version, baseURL) plus the per-file context filePath, baseName, isBarrel, and isAggregation, so a directive such as 'use server' can skip barrel files.

Type:	string | ((meta: BannerMeta) => string)

A static banner: '/* eslint-disable */\n// @ts-nocheck' lands at the top of each generated file:

/* eslint-disable */
// @ts-nocheck
export function createPet<TData extends Partial<Pet> = object>(data?: TData) {
  const defaultFakeData = { id: faker.number.int(), name: faker.string.alpha() }
  return { ...defaultFakeData, ...(data || {}) }
}

A function banner builds the text from the meta, such as banner: (meta) => \// Source: ${meta.filePath}``.

output.footer

Text added to the bottom of every generated file. It works like banner but for closing comments, such as re-enabling a lint rule. Pass a string or a function that receives the same BannerMeta and returns the text. Pair banner: '/* eslint-disable */' with footer: '/* eslint-enable */' to scope a lint disable to the generated file.

Type:	string | ((meta: BannerMeta) => string)

group

Splits generated files into subfolders by the operation's tag or URL path. Each group gets its own directory under {output.path}/{groupName}/. Without group, every file lands directly in output.path.

Type:	Group

TIP

Use group to mirror your API's domain structure (pet, store, user) in the generated code. Combine it with output.barrel: { type: 'named', nested: true } to get per-tag barrel files.

group only applies to output.mode: 'directory' (the default). It is not valid with output.mode: 'file', since a single-file output has no grouping concept.

With group: { type: 'tag' }, the generator emits one folder per tag, named after the camelCased tag:

Resulting tree

src/gen/
├── pet/
│   ├── createPet.ts
│   └── getPet.ts
└── store/
    ├── createStore.ts
    └── getStoreById.ts

Pass group.name to customize the folder name. For example, a name function that appends Controller to the group keeps the pre-v5 petController/ layout.

group.type

Property used to assign each operation to a group. Required whenever group is set.

• 'tag' uses the operation's first tag.
• 'path' uses the first segment of the operation's URL, such as pet for /pet/{petId}.

An operation with no tag goes in the default group.

Type:	'tag' | 'path'

group.name

Function that turns a group key (the operation's first tag) into a folder or identifier name. The result is used as both the subdirectory name under output.path and as a suffix when naming aggregate files.

Type:	(context: { group: string }) => string
Default:	({ group }) => camelCase(group)

For type: 'path' groups, the default uses the first URL segment as-is instead of camelCasing.

dateParser

Library used to format date, time, and datetime fields represented as strings. Pick a value other than 'faker' when your project already uses a date library and you want consistent formatting. Any library exporting a default function works, and Kubb adds the import for you.

Type:	'faker' | 'dayjs' | 'moment' | string
Default:	'faker'

A string date field renders differently per parser:

'faker' (default)

faker.date.anytime().toISOString().substring(0, 10)

'dayjs'

dayjs(faker.date.anytime()).format('YYYY-MM-DD')

'moment'

moment(faker.date.anytime()).format('YYYY-MM-DD')

You call the factory the same way for every parser. Only the format of the generated date field changes:

import { createPet } from './src/gen/mocks/createPet'

const pet = createPet()

regexGenerator

Library used to generate strings that satisfy a regex pattern keyword in the spec.

• 'faker' (default) uses faker.helpers.fromRegExp. No extra dependency.
• 'randexp' uses the randexp package. It supports a wider regex grammar, but adds a runtime dependency.

Type:	'faker' | 'randexp'
Default:	'faker'

'faker' (default)

faker.helpers.fromRegExp("^[A-Z]+$")

'randexp'

new RandExp('^[A-Z]+$').gen()

You call the factory the same way for both libraries. Only the source of the generated pattern string changes:

import { createPet } from './src/gen/mocks/createPet'

const pet = createPet()

locale

Faker locale code. It switches the named import to fakerXX from @faker-js/faker, so names, addresses, and phone numbers reflect the target region. The default 'en' imports fakerEN.

Type:	string
Default:	'en'

TIP

See Faker.js localization for the full list of locale codes.

'en' (default)

import { fakerEN as faker } from '@faker-js/faker'

'de'

import { fakerDE as faker } from '@faker-js/faker'

'de_AT'

import { fakerDE_AT as faker } from '@faker-js/faker'

You call the factory the same way for every locale. Only the generated values change, so names and addresses reflect the region:

import { createPet } from './src/gen/mocks/createPet'

const pet = createPet()

seed

Value passed to faker.seed(...). Set it for deterministic output across runs, which helps with snapshot tests and reproducible local data. Pass a single number or an array of numbers.

Type:	number | number[]

include

Generates only the operations and schemas that match at least one entry in the list. Everything else is skipped. Each entry filters by one of:

• tag: the operation's first tag in the OpenAPI spec.
• operationId: the operation's operationId.
• path: the URL path, such as '/pet/{petId}'.
• method: the HTTP method, such as 'GET' or 'POST'.
• contentType: the request or response media type, such as 'application/json'.
• schemaName: the component schema name under #/components/schemas.

pattern accepts either a string (exact match) or a RegExp for fuzzy matches.

Type:	Array<Include>

Type definition

export type Include = {
  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType' | 'schemaName'
  pattern: string | RegExp
}

Pass include: [{ type: 'tag', pattern: 'pet' }] to keep only the pet tag. Stack entries to narrow further, such as { type: 'method', pattern: 'GET' } with { type: 'path', pattern: /^\/pet/ } for GET operations under /pet.

exclude

Skips any operation or schema that matches at least one entry in the list. It is the opposite of include. Entries use the same type (tag, operationId, path, method, contentType, schemaName) and pattern (string or RegExp). When both are set, exclude wins.

Type:	Array<Exclude>

Type definition

export type Exclude = {
  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType' | 'schemaName'
  pattern: string | RegExp
}

Pass exclude: [{ type: 'tag', pattern: 'store' }] to drop the store tag, or stack { type: 'operationId', pattern: 'deletePet' } with { type: 'method', pattern: 'DELETE' } to skip one operation and every DELETE.

override

Applies different plugin options to operations that match a pattern. Use it for the few endpoints that need special treatment. Each entry takes the same type and pattern as include and exclude, plus an options object. That object accepts any plugin option except override, so rules cannot nest. Entries run top to bottom. The first match merges onto the plugin defaults, and later entries do not stack.

Type:	Array<Override>

Type definition

export type Override = {
  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType' | 'schemaName'
  pattern: string | RegExp
  options: Omit<Partial<Options>, 'override'>
}

For example, override: [{ type: 'tag', pattern: 'user', options: { locale: 'de' } }] switches the user tag to German values while the rest of the spec keeps the plugin default.

resolver

Changes how the plugin names generated files and symbols. Use it to add a prefix or suffix, or to swap the casing, without forking the plugin. Override only the methods you want to change, since anything you omit keeps its default behavior. Inside a method, this is the full resolver, so you can call this.default(name, type) to reuse the built-in name.

Type:	Partial<ResolverFaker> & ThisType<ResolverFaker>

TIP

Use resolver for naming and file-location tweaks. For changing the AST nodes themselves (for example stripping descriptions), use macros instead.

For example, resolver: { resolveName(name, type) { return \${this.default(name, type)}Mock` } }appendsMock` to every generated factory name so helpers do not clash with imported types.

macros

Rewrites AST nodes before they are printed to source. Use it to rename operation IDs, drop descriptions, or change schema metadata without forking the generator. Each macro callback (such as schema or operation) receives the node and a context object. Return a new node to replace it, or undefined to leave it as is. Callbacks you omit keep their default behavior. Macros run in order, so a later one sees the output of an earlier one.

Type:	Array<Macro>

TIP

Use macros to rewrite node properties before printing. For changing the names of generated symbols and files, use resolver instead.

Each entry names the macro and supplies one callback per node kind:

A macros array

import { pluginFaker } from '@kubb/plugin-faker'

pluginFaker({
  macros: [
    {
      name: 'strip-descriptions',
      schema(node) {
        return { ...node, description: undefined }
      },
    },
    {
      name: 'prefix-operation-id',
      operation(node) {
        return { ...node, operationId: `api_${node.operationId}` }
      },
    },
  ],
})

printer

Replaces the Faker node handler for a specific schema type, such as 'integer', 'date', or 'string'. Each handler returns the Faker expression as a string. Use this.transform to recurse into nested nodes, and this.options to read printer options.

Type:	{ nodes?: PrinterFakerNodes }

Map integer schemas to a float

import { pluginFaker } from '@kubb/plugin-faker'

pluginFaker({
  printer: {
    nodes: {
      integer() {
        return 'faker.number.float()'
      },
    },
  },
})