@kubb/plugin-barrel 5.8.3 → 5.9.0

package/README.md

@@ -24,7 +24,7 @@
 
 ### Barrel-file plugin for Kubb
 
-Automatically generates `index.ts` re-export files for each plugin output directory.
+Generates `index.ts` re-export files for each plugin output directory, and a root `index.ts` when `output.barrel` is set on `defineConfig`.
 
 ## Installation
 
@@ -38,42 +38,42 @@ npm install @kubb/plugin-barrel
 
 ## Usage
 
-Add `pluginBarrel` to the `plugins` array in your `kubb.config.ts`:
+`defineConfig` adds `pluginBarrel()` to `plugins` for you, so you do not add it yourself. Set `output.barrel` on `defineConfig` to write a root barrel and to give every plugin without its own `output.barrel` the same setting:
 
 ```typescript
 import { defineConfig } from 'kubb'
-import { pluginBarrel } from '@kubb/plugin-barrel'
+import { pluginTs } from '@kubb/plugin-ts'
 
 export default defineConfig({
   input: './openapi.yaml',
   output: {
     path: './src/gen',
+    barrel: { type: 'named' },
   },
-  plugins: [
-    pluginBarrel({
-      type: 'named',
-    }),
-  ],
+  plugins: [pluginTs()],
 })
 ```
 
 ## Options
 
-| Option | Type                              | Default   | Description                                 |
-| ------ | --------------------------------- | --------- | ------------------------------------------- |
-| `type` | `'all' \| 'named' \| 'propagate'` | `'named'` | Export style for the generated barrel files |
+`pluginBarrel()` takes no arguments. You configure it through `output.barrel`, on `defineConfig` or on a single plugin.
+
+| Option                 | Type                                                    | Default                   | Description                                                                                        |
+| ---------------------- | ------------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------------------- |
+| `output.barrel`        | `{ type: 'all' \| 'named', nested?: boolean } \| false` | `false` on `defineConfig` | Barrel settings. `false` on a plugin turns its barrel off and leaves its files out of the root one |
+| `output.barrel.type`   | `'all' \| 'named'`                                      | None                      | Export style for the generated barrel files                                                        |
+| `output.barrel.nested` | `boolean`                                               | `false`                   | Plugin only. Each barrel re-exports its own directory and the barrels below it                     |
 
 ### Export types
 
-| Value         | Output                                                                          |
-| ------------- | ------------------------------------------------------------------------------- |
-| `'all'`       | `export * from './...'` — wildcard re-exports                                   |
-| `'named'`     | `export { ... } from './...'` — named re-exports, tree-shaking friendly         |
-| `'propagate'` | `export * from './...'` on index files only, propagating up through directories |
+| Value     | Output                                                                  |
+| --------- | ----------------------------------------------------------------------- |
+| `'all'`   | `export * from './...'` — wildcard re-exports                           |
+| `'named'` | `export { ... } from './...'` — named re-exports, tree-shaking friendly |
 
 ## How it works
 
-After every plugin finishes generating files, `@kubb/plugin-barrel` walks the output tree and creates an `index.ts` in each directory, re-exporting everything inside. It then creates a root `index.ts` at the top of the output path that re-exports from all plugin directories.
+After every plugin finishes generating files, `@kubb/plugin-barrel` walks the output tree and creates an `index.ts` in each directory of every plugin output with a barrel enabled. When `output.barrel` is set on `defineConfig`, it also creates a root `index.ts` at the top of the output path that re-exports the files of every plugin that does not set `output.barrel: false`.
 
 `@kubb/plugin-barrel` uses `enforce: 'post'` so it always runs after all regular plugins complete, giving it access to the full set of generated files.
 

package/dist/index.cjs

@@ -66,12 +66,12 @@ function isPathInside(path, parent) {
 //#endregion
 //#region kubb-extension.json
 var compatibility = {
-	"kubb": ">=5.8.0",
+	"kubb": ">=5.8.3",
 	"node": ">=22"
 };
 //#endregion
 //#region package.json
-var version = "5.8.3";
+var version = "5.9.0";
 //#endregion
 //#region src/utils.ts
 const SOURCE_EXTENSIONS = /* @__PURE__ */ new Set([

package/dist/index.js

@@ -43,12 +43,12 @@ function isPathInside(path, parent) {
 //#endregion
 //#region kubb-extension.json
 var compatibility = {
-	"kubb": ">=5.8.0",
+	"kubb": ">=5.8.3",
 	"node": ">=22"
 };
 //#endregion
 //#region package.json
-var version = "5.8.3";
+var version = "5.9.0";
 //#endregion
 //#region src/utils.ts
 const SOURCE_EXTENSIONS = /* @__PURE__ */ new Set([

package/docs/options.md

@@ -14,7 +14,7 @@
 
 ### output.barrel
 
-Kubb writes one root barrel and an `index.ts` in every directory of a plugin's output. For two plugins that write to `models` and `clients`:
+Kubb writes an `index.ts` in every directory of a plugin's output, and a root barrel when `output.barrel` is set on `defineConfig`. For two plugins that write to `models` and `clients`, with `output.barrel` set on `defineConfig`:
 
 ```text
 src/gen

package/docs/overview.md

@@ -1,27 +1,27 @@
-# Barrel plugin
+# Barrel
 
-The barrel plugin writes `index.ts` files that re-export generated code, one for each plugin's output and one root barrel, so you can import everything from a single entry point.
-
-Kubb adds it to `plugins` for you. Do not add it yourself. It generates nothing until you configure `output.barrel`.
+The Barrel plugin writes `index.ts` files that re-export generated code, so you can import everything from a single entry point. It writes a barrel in every folder of each plugin output that has a barrel setting, plus a root barrel when you set `output.barrel` on `defineConfig`.
 
 ## Setup
 
-Set `output.barrel` on `defineConfig` to write a root barrel. Plugins without a barrel setting of their own inherit it.
+Kubb adds the plugin to `plugins` for you, so no setup is needed. Generator plugins such as `pluginTs()` turn on their own barrels by default. Plugins without their own `output.barrel` inherit the root setting.
 
-## Options
+## Options worth knowing
 
-The plugin takes no arguments. You configure it through `output.barrel`, on `defineConfig` or on a single plugin.
+`pluginBarrel()` takes no arguments. You configure it through `output.barrel`, on `defineConfig` or on a single plugin.
 
 - `type: 'named'` re-exports each symbol by name, which suits tree-shaking. `type: 'all'` writes `export *`.
-- `nested: true`, on a plugin only, makes each barrel re-export just its own directory and the barrels below it. The root barrel is always flat.
+- `nested: true`, on a plugin only, makes each barrel re-export just its own folder and the barrels below it. The root barrel is always flat.
 - `false` on a plugin turns its barrel off and leaves its files out of the root barrel.
 
-A plugin with `output.mode: 'file'` gets no barrel of its own. The root barrel re-exports that file directly. Passing your own `output` object to a plugin replaces its default `barrel: { type: 'named' }`, so it falls back to the root setting.
+A plugin with `output.mode: 'file'` gets no barrel of its own, and the root barrel re-exports that file directly. Passing your own `output` object to a plugin replaces its default `barrel: { type: 'named' }`, so that plugin falls back to the root setting. When two files export the same name, Kubb reports an error, and a `named` barrel keeps only the first one.
 
-See [Options](https://kubb.dev/extensions/kubb-labs/plugin-barrel/options) for the export `type`, `nested` barrels, and per-plugin overrides.
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-barrel/options) for every option and its default.
 
 ## Example
 
+The config below writes a root `src/gen/index.ts` that re-exports the generated types by name.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -29,6 +29,8 @@ import { pluginTs } from '@kubb/plugin-ts'
 export default defineConfig({
   input: './petStore.yaml',
   output: { path: './src/gen', barrel: { type: 'named' } },
-  plugins: [pluginTs()],
+  plugins: [
+    pluginTs(),
+  ],
 })
 ```

package/kubb-extension.json

@@ -4,7 +4,7 @@
   "name": "plugin-barrel",
   "export": "pluginBarrel",
   "displayName": "Barrel",
-  "description": "Generates index.ts barrel files for every plugin output and one root barrel.",
+  "description": "Generates index.ts barrel files for every plugin output, plus a root barrel when output.barrel is set on defineConfig.",
   "category": "output",
   "icon": {
     "light": "https://kubb.dev/feature/plugins-light.svg"
@@ -13,7 +13,7 @@
   "docs": "https://kubb.dev/extensions/kubb-labs/plugin-barrel",
   "maintainers": [{ "name": "Stijn Van Hulle", "github": "stijnvanhulle" }],
   "compatibility": {
-    "kubb": ">=5.8.0",
+    "kubb": ">=5.8.3",
     "node": ">=22"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-barrel",
-  "version": "5.8.3",
+  "version": "5.9.0",
   "description": "Barrel-file plugin for Kubb. Automatically generates index.ts re-export files per plugin output directory.",
   "keywords": [
     "barrel",
@@ -61,11 +61,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/kit": "5.8.3"
+    "@kubb/kit": "5.9.0"
   },
   "devDependencies": {
     "@internals/utils": "0.0.1",
-    "@kubb/core": "5.8.3"
+    "@kubb/core": "5.9.0"
   },
   "engines": {
     "node": ">=22"