unplugin-kubb

unplugin-kubb

Universal build integration for Kubb

Integration of Kubb for Vite, webpack, Rollup, Rolldown, Rspack, esbuild, Farm, Nuxt, and Astro powered by unplugin.

Kubb generates once, when the first build starts. Watch rebuilds and later builds that share the plugin reuse that output, so restart the build after you change your spec. Vite, Nuxt, and Astro generate during builds only, not in their development servers. A missing config or a failed generation fails the build.

Installation

bun add -D unplugin-kubb @kubb/core
# or
pnpm add -D unplugin-kubb @kubb/core
# or
npm install -D unplugin-kubb @kubb/core

// vite.config.ts
import kubb from 'unplugin-kubb/vite'
import { defineConfig } from 'vite'
import config from './kubb.config'

export default defineConfig({
  plugins: [kubb({ config })],
})

// rollup.config.ts, rolldown.config.ts
import kubb from 'unplugin-kubb/rollup' // or 'unplugin-kubb/rolldown'
import config from './kubb.config'

export default {
  input: 'src/index.ts',
  plugins: [kubb({ config })],
}

// webpack.config.ts, rspack.config.ts
import kubb from 'unplugin-kubb/webpack' // or 'unplugin-kubb/rspack'
import config from './kubb.config'

export default {
  plugins: [kubb({ config })],
}

// build.ts
import { build } from 'esbuild'
import kubb from 'unplugin-kubb/esbuild'
import config from './kubb.config'

await build({
  entryPoints: ['src/index.ts'],
  bundle: true,
  outfile: 'dist/bundle.js',
  plugins: [kubb({ config })],
})

// farm.config.ts
import { defineConfig } from '@farmfe/core'
import kubb from 'unplugin-kubb/farm'
import config from './kubb.config'

export default defineConfig({
  plugins: [kubb({ config })],
})

// nuxt.config.ts: works with the Vite, webpack, and Rspack builders
import config from './kubb.config'

export default defineNuxtConfig({
  modules: [['unplugin-kubb/nuxt', { config }]],
})

// astro.config.mjs
import { defineConfig } from 'astro/config'
import kubb from 'unplugin-kubb/astro'
import config from './kubb.config'

export default defineConfig({
  integrations: [kubb({ config })],
})

Options

config

Define the options for Kubb.

type Options = {
  config: UserConfig
}

Supporting Kubb

Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:

• Become a Sponsor on GitHub
• See sponsorship tiers and our sponsors

License

MIT