@kubb/plugin-barrel

TIP

plugin-barrel ships with Kubb and runs by default. Install it on its own only when you want to tune barrel behavior.

@kubb/plugin-barrel writes the index.ts barrel files. It adds one barrel per plugin output directory and one root barrel at output.path/index.ts. This runs after the build finishes, so you import everything from one entry point, like import { Pet, usePetByIdQuery, petMock } from './gen'.

The plugin is registered by default in defineConfig, so barrels appear with no setup. When it runs, the default output.barrel is { type: 'named' }.

A plugin inherits output.barrel from config.output.barrel when it sets none of its own. Set barrel: false on a plugin to skip its barrel and drop its files from the root barrel.

Installation

bun

bun add -d @kubb/plugin-barrel@beta

pnpm

pnpm add -D @kubb/plugin-barrel@beta

npm

npm install --save-dev @kubb/plugin-barrel@beta

yarn

yarn add -D @kubb/plugin-barrel@beta

Example

Named exports (default)

import { defineConfig } from 'kubb'

export default defineConfig({
  input: { path: './petStore.yaml' },
  output: { path: './src/gen' },
  plugins: [],
})

Generated output

// src/gen/index.ts
export { getUser, User } from './api/user'
export { getPost, Post } from './api/post'
export { User } from './api/types/User'
export { useUser } from './hooks/useUser'

// src/gen/api/index.ts
export { getUser, User } from './user'
export { getPost, Post } from './post'
export { User } from './types/User'

// src/gen/api/types/index.ts
export { User } from './User'

Wildcard exports

import { defineConfig } from 'kubb'

export default defineConfig({
  input: { path: './petStore.yaml' },
  output: { path: './src/gen', barrel: { type: 'all' } },
  plugins: [],
})

Generated output

// src/gen/index.ts
export * from './api/user'
export * from './api/post'
export * from './api/types/User'
export * from './hooks/useUser'

// src/gen/api/index.ts
export * from './user'
export * from './post'
export * from './types/User'

// src/gen/api/types/index.ts
export * from './User'

Nested barrels (plugin level)

import { defineConfig } from 'kubb'
import { pluginTs } from '@kubb/plugin-ts'

// nested lives on a plugin's output.barrel, not on the root output.barrel.
export default defineConfig({
  input: { path: './petStore.yaml' },
  output: { path: './src/gen' },
  plugins: [pluginTs({ output: { path: 'api', barrel: { type: 'all', nested: true } } })],
})

Generated output

// src/gen/api/index.ts re-exports its files and subdirectories
export * from './user'
export * from './post'
export * from './types'

// src/gen/api/types/index.ts re-exports its files
export * from './User'

// the root src/gen/index.ts still uses the config default ({ type: 'named' })
export { getUser, User } from './api/user'
export { getPost, Post } from './api/post'
export { User } from './api/types/User'

Disable a plugin barrel

import { defineConfig } from 'kubb'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginZod } from '@kubb/plugin-zod'

// No zod/index.ts is created, and zod files
// are dropped from the root index.ts.
export default defineConfig({
  input: { path: './petStore.yaml' },
  output: { path: './src/gen' },
  plugins: [pluginTs(), pluginZod({ output: { path: 'zod', barrel: false } })],
})

Disable the root barrel

import {  } from 'kubb'

// No root index.ts. Each plugin still gets
// its own barrel from its inherited config.
export default ({
  : { : './petStore.yaml' },
  : { : './src/gen', : false },
  : [],
})

See Also

• Changelog