@kubb/plugin-barrel 5.0.0-beta.63 → 5.0.0-beta.64

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { t as __name } from "./chunk-C0LytTxp.js";
+import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
 import { Plugin } from "@kubb/core";
 
 //#region src/types.d.ts

package/dist/index.js

@@ -1,4 +1,4 @@
-import "./chunk-C0LytTxp.js";
+import "./rolldown-runtime-C0LytTxp.js";
 import path, { extname, resolve } from "node:path";
 import { definePlugin } from "@kubb/core";
 import * as factory from "@kubb/ast/factory";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-barrel",
-  "version": "5.0.0-beta.63",
+  "version": "5.0.0-beta.64",
   "description": "Barrel-file plugin for Kubb. Automatically generates index.ts re-export files per plugin output directory and an optional root barrel after all plugins complete.",
   "keywords": [
     "barrel",
@@ -17,7 +17,6 @@
     "directory": "packages/plugin-barrel"
   },
   "files": [
-    "src",
     "dist",
     "*.d.ts",
     "*.d.cts",
@@ -42,14 +41,14 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/ast": "5.0.0-beta.63",
-    "@kubb/core": "5.0.0-beta.63"
+    "@kubb/ast": "5.0.0-beta.64",
+    "@kubb/core": "5.0.0-beta.64"
   },
   "devDependencies": {
     "@internals/utils": "0.0.0"
   },
   "peerDependencies": {
-    "@kubb/core": "5.0.0-beta.63"
+    "@kubb/core": "5.0.0-beta.64"
   },
   "engines": {
     "node": ">=22"

package/src/index.ts

@@ -1,2 +0,0 @@
-export { pluginBarrel, pluginBarrelName } from './plugin.ts'
-export type { BarrelType, BarrelConfig, PluginBarrelConfig } from './types.ts'

package/src/plugin.ts

@@ -1,162 +0,0 @@
-import path from 'node:path'
-import { resolve } from 'node:path'
-import type { FileNode } from '@kubb/ast'
-import { definePlugin } from '@kubb/core'
-import type { Config, NormalizedPlugin, Plugin } from '@kubb/core'
-import type { BarrelConfig, PluginBarrelConfig } from './types.ts'
-import { getBarrelFiles, getPluginOutputPrefix, isExcludedPath } from './utils.ts'
-
-/**
- * Applies a plugin's configured `output.banner`/`footer` to a barrel file, flagged as `isBarrel`.
- *
- * Resolves through the plugin's own resolver, and only when the plugin explicitly sets a
- * banner/footer, so barrels stay banner-free by default and never inherit the implicit
- * "Generated by Kubb" notice.
- */
-function withBarrelBannerFooter({ file, plugin, config }: { file: FileNode; plugin: NormalizedPlugin; config: Config }): FileNode {
-  const output = plugin.options?.output
-  const resolver = plugin.resolver
-  if (!resolver) return file
-
-  const hasBanner = output?.banner !== undefined
-  const hasFooter = output?.footer !== undefined
-  if (!hasBanner && !hasFooter) return file
-
-  const context = { output, config, file: { path: file.path, baseName: file.baseName, isBarrel: true } }
-  return {
-    ...file,
-    banner: hasBanner ? resolver.resolveBanner(undefined, context) : file.banner,
-    footer: hasFooter ? resolver.resolveFooter(undefined, context) : file.footer,
-  }
-}
-
-declare global {
-  namespace Kubb {
-    interface PluginOptionsRegistry {
-      output: {
-        /**
-         * Barrel configuration for this plugin's output.
-         * Set to `false` to disable barrel generation for this plugin entirely. Doing so also
-         * excludes the plugin's files from the root barrel.
-         *
-         * Falls back to `config.output.barrel` when omitted.
-         *
-         * @default { type: 'named' }
-         */
-        barrel?: PluginBarrelConfig | false
-      }
-    }
-    interface ConfigOptionsRegistry {
-      output: {
-        /**
-         * Barrel configuration for the root barrel file at `config.output.path/index.ts`.
-         * Set to `false` to disable root barrel generation. Individual plugins can override
-         * this via their own `output.barrel`.
-         *
-         * @default { type: 'named' }
-         */
-        barrel?: BarrelConfig | false
-      }
-    }
-  }
-}
-
-/**
- * Canonical plugin name for `@kubb/plugin-barrel`. Used for driver lookups
- * and to guard the `kubb:plugin:end` handler against reacting to its own lifecycle event.
- */
-export const pluginBarrelName = 'plugin-barrel' satisfies Plugin['name']
-
-/**
- * Generates an `index.ts` for every plugin output directory and one root
- * barrel at `config.output.path/index.ts` after the build completes. Ships
- * with Kubb and is registered by default in `defineConfig`.
- *
- * Each plugin inherits `output.barrel` from `config.output.barrel` (which
- * defaults to `{ type: 'named' }`). Set `barrel: false` on a plugin to skip
- * its barrel and also exclude its files from the root barrel.
- *
- * A plugin with `output.mode: 'file'` gets no per-plugin barrel, since its output
- * is a single file. The root barrel re-exports that file directly.
- *
- * @example
- * ```ts
- * import { defineConfig } from '@kubb/core'
- * import { pluginBarrel } from '@kubb/plugin-barrel'
- * import { pluginTs } from '@kubb/plugin-ts'
- * import { pluginZod } from '@kubb/plugin-zod'
- *
- * export default defineConfig({
- *   input: { path: './petStore.yaml' },
- *   output: { path: 'src/gen', barrel: { type: 'named' } },
- *   plugins: [
- *     pluginTs({ output: { path: 'types', barrel: { type: 'all' } } }),
- *     pluginZod({ output: { path: 'schemas' } }),
- *     pluginBarrel(),
- *   ],
- * })
- * ```
- */
-export const pluginBarrel = definePlugin(() => {
-  const excludedPrefixes = new Set<string>()
-
-  return {
-    name: pluginBarrelName,
-    enforce: 'post' as const,
-    hooks: {
-      'kubb:plugin:end'({ plugin, config, files, upsertFile }) {
-        // Skip reactions to the barrel plugin's own lifecycle event
-        if (plugin.name === pluginBarrelName) return
-
-        const pluginBarrelOpt = plugin.options.output?.barrel
-        const configBarrel = config.output.barrel
-        const defaultBarrel = { type: 'named' } as const
-
-        // Root config barrel doesn't have nested, so we add it
-        const barrelConfig: PluginBarrelConfig | false = (() => {
-          if (pluginBarrelOpt !== undefined) return pluginBarrelOpt
-          if (configBarrel !== undefined) return configBarrel === false ? false : { ...configBarrel, nested: false }
-          return defaultBarrel
-        })()
-
-        if (barrelConfig === false) {
-          excludedPrefixes.add(getPluginOutputPrefix(plugin, config))
-          return
-        }
-
-        // `mode: 'file'` writes a single file, so there is no directory to barrel. The root barrel
-        // re-exports that file as a direct leaf of `config.output.path`.
-        if (plugin.options.output.mode === 'file') {
-          return
-        }
-
-        const barrelType = barrelConfig.type
-        const nested = barrelConfig.nested ?? false
-
-        const base = resolve(config.root, config.output.path)
-        const target = resolve(base, plugin.options.output.path)
-        const relative = path.relative(base, target)
-        if (relative.startsWith('..') || path.isAbsolute(relative)) {
-          throw new Error('Invalid output path')
-        }
-        for (const file of getBarrelFiles({ outputPath: target, files, barrelType, nested, recursive: true })) {
-          upsertFile(withBarrelBannerFooter({ file, plugin, config }))
-        }
-      },
-      'kubb:plugins:end'({ files, config, upsertFile }) {
-        const barrelConfig = config.output.barrel ?? { type: 'named' }
-
-        const filteredFiles = excludedPrefixes.size === 0 ? files : files.filter((f) => !isExcludedPath(f.path, excludedPrefixes))
-        excludedPrefixes.clear()
-
-        if (barrelConfig === false) return
-
-        const barrelType = barrelConfig.type
-
-        for (const file of getBarrelFiles({ outputPath: resolve(config.root, config.output.path), files: filteredFiles, barrelType })) {
-          upsertFile(file)
-        }
-      },
-    },
-  }
-})

package/src/types.ts

@@ -1,52 +0,0 @@
-/**
- * Barrel export strategy.
- *
- * - `'all'` generates `export * from '...'` for every file
- * - `'named'` generates `export { name1, name2 } from '...'` using each file's named exports
- */
-export type BarrelType = 'all' | 'named'
-
-/**
- * Barrel configuration at the root config level.
- *
- * @example
- * ```ts
- * barrel: { type: 'named' }  // default
- * barrel: { type: 'all' }
- * barrel: false  // disable barrel generation
- * ```
- */
-export type BarrelConfig = {
-  /**
-   * Export strategy for the root barrel file.
-   * - `'all'` wildcard exports: `export * from './file'`
-   * - `'named'` explicit exports: `export { x, y } from './file'`
-   */
-  type: BarrelType
-}
-
-/**
- * Barrel configuration at the plugin level.
- * Supports nested barrel generation in subdirectories.
- *
- * @example
- * ```ts
- * barrel: { type: 'named' }  // single barrel with named exports
- * barrel: { type: 'all', nested: true }  // hierarchical barrels with wildcard exports
- * barrel: { type: 'named', nested: true }  // hierarchical barrels with named exports
- * barrel: false  // disable barrel generation
- * ```
- */
-export type PluginBarrelConfig = {
-  /**
-   * Export strategy for the plugin's barrel files.
-   * - `'all'` wildcard exports: `export * from './file'`
-   * - `'named'` explicit exports: `export { x, y } from './file'`
-   */
-  type: BarrelType
-  /**
-   * Generate an `index.ts` in every sub-directory, each re-exporting only what's directly inside it.
-   * Creates a hierarchical barrel structure instead of flat exports from the root.
-   */
-  nested?: boolean
-}

package/src/utils.ts

@@ -1,254 +0,0 @@
-import { extname, resolve } from 'node:path'
-import * as factory from '@kubb/ast/factory'
-import type { ExportNode, FileNode, SourceNode } from '@kubb/ast'
-import type { Config, NormalizedPlugin } from '@kubb/core'
-import { type BuildTree, buildTree, toPosixPath } from '@internals/utils'
-import type { BarrelType } from './types.ts'
-
-const SOURCE_EXTENSIONS = new Set(['.ts', '.tsx', '.js', '.jsx'])
-const BARREL_SUFFIX = `/index.ts`
-
-function toRelativeModulePath(fromDir: string, filePath: string): string {
-  return `./${filePath.slice(fromDir.length + 1)}`
-}
-
-function isBarrelPath(path: string): boolean {
-  return path.endsWith(BARREL_SUFFIX)
-}
-
-function makeBarrel(dirPath: string, exports: Array<ExportNode>): FileNode {
-  return factory.createFile({
-    baseName: 'index.ts',
-    path: `${dirPath}${BARREL_SUFFIX}`,
-    exports,
-    sources: [],
-    imports: [],
-    // Default to no banner/footer. The barrel plugin resolves a configured plugin
-    // banner/footer (with isBarrel: true) afterwards, so a `banner` function can
-    // decide per file whether a barrel should carry a directive like "use server".
-    banner: undefined,
-    footer: undefined,
-  })
-}
-
-type LeafContext = {
-  dirPath: string
-  leafPath: string
-  sourceFile: FileNode | null
-}
-
-type LeafStrategy = (ctx: LeafContext) => Array<ExportNode>
-
-function hasOnlyNonIndexableSources(sources: ReadonlyArray<SourceNode>): boolean {
-  if (sources.length === 0) return false
-  for (const source of sources) {
-    if (source.isIndexable) return false
-  }
-  return true
-}
-
-function partitionIndexableNames(sources: ReadonlyArray<SourceNode>): Map<boolean, Set<string>> {
-  const byTypeOnly = new Map<boolean, Set<string>>([
-    [false, new Set()],
-    [true, new Set()],
-  ])
-  for (const source of sources) {
-    if (!source.isIndexable || !source.name) continue
-    byTypeOnly.get(Boolean(source.isTypeOnly))!.add(source.name)
-  }
-  return byTypeOnly
-}
-
-const allStrategy: LeafStrategy = ({ dirPath, leafPath, sourceFile }) => {
-  if (sourceFile && hasOnlyNonIndexableSources(sourceFile.sources)) return []
-  return [factory.createExport({ path: toRelativeModulePath(dirPath, leafPath) })]
-}
-
-const namedStrategy: LeafStrategy = ({ dirPath, leafPath, sourceFile }) => {
-  const modulePath = toRelativeModulePath(dirPath, leafPath)
-
-  if (!sourceFile) return [factory.createExport({ path: modulePath })]
-
-  const namesByTypeOnly = partitionIndexableNames(sourceFile.sources)
-  const valueNames = namesByTypeOnly.get(false)!
-  const typeNames = namesByTypeOnly.get(true)!
-
-  if (valueNames.size === 0 && typeNames.size === 0) {
-    if (sourceFile.sources.length > 0) return []
-    return [factory.createExport({ path: modulePath })]
-  }
-
-  const exports: Array<ExportNode> = []
-  if (valueNames.size > 0) {
-    exports.push(factory.createExport({ name: [...valueNames].sort(), path: modulePath }))
-  }
-  if (typeNames.size > 0) {
-    exports.push(factory.createExport({ name: [...typeNames].sort(), path: modulePath, isTypeOnly: true }))
-  }
-  return exports
-}
-
-const LEAF_STRATEGIES: ReadonlyMap<BarrelType, LeafStrategy> = new Map([
-  ['all', allStrategy],
-  ['named', namedStrategy],
-])
-
-type LeafWalkParams = {
-  sourceFiles: ReadonlyMap<string, FileNode>
-  strategy: LeafStrategy
-  recursive: boolean
-}
-
-/**
- * Post-order walk that yields a barrel per visited directory.
- * Returns the list of leaf file paths collected in this subtree (used by the parent call).
- */
-function* walkAllOrNamed(node: BuildTree, params: LeafWalkParams, isRoot: boolean): Generator<FileNode, Array<string>> {
-  const subtreeLeaves: Array<string> = []
-
-  for (const child of node.children) {
-    if (child.isFile) {
-      if (!isBarrelPath(child.path)) subtreeLeaves.push(child.path)
-      continue
-    }
-
-    const childLeaves = yield* walkAllOrNamed(child, params, false)
-    for (const leaf of childLeaves) subtreeLeaves.push(leaf)
-  }
-
-  if (!isRoot && !params.recursive) return subtreeLeaves
-
-  const exports = subtreeLeaves.flatMap((leafPath) => params.strategy({ dirPath: node.path, leafPath, sourceFile: params.sourceFiles.get(leafPath) ?? null }))
-
-  if (exports.length > 0) {
-    yield makeBarrel(node.path, exports)
-  }
-
-  return subtreeLeaves
-}
-
-/**
- * Recursive walk that yields one barrel per directory, re-exporting files and sub-barrels.
- * Used when nested: true.
- */
-function* walkNested(node: BuildTree): Generator<FileNode> {
-  const exports: Array<ExportNode> = []
-
-  for (const child of node.children) {
-    if (child.isFile) {
-      if (isBarrelPath(child.path)) continue
-      exports.push(factory.createExport({ path: toRelativeModulePath(node.path, child.path) }))
-      continue
-    }
-
-    yield* walkNested(child)
-    exports.push(factory.createExport({ path: toRelativeModulePath(node.path, `${child.path}${BARREL_SUFFIX}`) }))
-  }
-
-  if (exports.length > 0) {
-    yield makeBarrel(node.path, exports)
-  }
-}
-
-type IndexedFiles = {
-  sourceFiles: ReadonlyMap<string, FileNode>
-  paths: ReadonlyArray<string>
-}
-
-function indexRelevantFiles(files: ReadonlyArray<FileNode>, outputPath: string): IndexedFiles {
-  const outputPrefix = `${toPosixPath(outputPath)}/`
-  const sourceFiles = new Map<string, FileNode>()
-  const paths: Array<string> = []
-
-  for (const file of files) {
-    const normalized = toPosixPath(file.path)
-    if (!normalized.startsWith(outputPrefix)) continue
-    if (isBarrelPath(normalized)) continue
-    if (!SOURCE_EXTENSIONS.has(extname(normalized))) continue
-
-    sourceFiles.set(normalized, file)
-    paths.push(normalized)
-  }
-
-  return { sourceFiles, paths }
-}
-
-type GetBarrelFilesParams = {
-  /**
-   * Absolute directory the barrel(s) should be rooted at.
-   * Only files living under this path are considered.
-   */
-  outputPath: string
-  /**
-   * Pool of generated files to scan for indexable sources.
-   */
-  files: ReadonlyArray<FileNode>
-  /**
-   * Export strategy used when emitting each barrel.
-   * - `'all'` re-exports the whole module (`export * from './x'`)
-   * - `'named'` re-exports only the indexable named symbols
-   */
-  barrelType: BarrelType
-  /**
-   * Generate an `index.ts` in every sub-directory, each re-exporting only what's directly inside it (hierarchical).
-   * When false, uses flat generation strategy with optional recursive subdirectory barrels.
-   */
-  nested?: boolean
-  /**
-   * Also generate a barrel for each sub-directory when nested is false.
-   * No effect when nested is true (always generates hierarchical structure).
-   */
-  recursive?: boolean
-}
-
-/**
- * Yields barrel `FileNode`s for the directory rooted at `outputPath`.
- *
- * @example
- * ```ts
- * for (const file of getBarrelFiles({ outputPath, files, barrelType })) {
- *   upsertFile(file)
- * }
- * // or collect into an array
- * const barrels = [...getBarrelFiles({ outputPath, files, barrelType })]
- * ```
- */
-export function* getBarrelFiles({ outputPath, files, barrelType, nested = false, recursive = false }: GetBarrelFilesParams): Generator<FileNode> {
-  const { sourceFiles, paths } = indexRelevantFiles(files, outputPath)
-  if (paths.length === 0) return
-
-  const tree = buildTree(outputPath, paths)
-
-  if (nested) {
-    yield* walkNested(tree)
-    return
-  }
-
-  const strategy = LEAF_STRATEGIES.get(barrelType)
-  if (!strategy) return
-
-  yield* walkAllOrNamed(tree, { sourceFiles, strategy, recursive }, true)
-}
-
-/**
- * Builds a POSIX-normalized prefix for a plugin's output. A directory output gets a trailing `/`,
- * while a `mode: 'file'` output (the path is the file itself) gets the exact path with no trailing `/`.
- *
- * Used to detect (and later exclude) files generated by plugins that opted out of the root barrel.
- */
-export function getPluginOutputPrefix(plugin: NormalizedPlugin, config: Config): string {
-  const resolved = toPosixPath(resolve(config.root, config.output.path, plugin.options.output.path))
-  return plugin.options.output.mode === 'file' ? resolved : `${resolved}/`
-}
-
-/**
- * Returns `true` when `filePath` lives under any of the given excluded prefixes. A prefix with a
- * trailing `/` matches a directory subtree, and a prefix without one matches that exact file
- * (used for `mode: 'file'` outputs).
- *
- * Both sides are POSIX-normalized so Windows backslash paths match correctly.
- */
-export function isExcludedPath(filePath: string, prefixes: ReadonlySet<string>): boolean {
-  const normalized = toPosixPath(filePath)
-  return prefixes.values().some((prefix) => (prefix.endsWith('/') ? normalized.startsWith(prefix) : normalized === prefix))
-}