@kubb/core 2.18.3 → 2.18.5

package/src/FileManager.ts

@@ -5,12 +5,14 @@ import { orderBy } from 'natural-orderby'
 import PQueue from 'p-queue'
 import { isDeepEqual } from 'remeda'
 
+import { getRelativePath, read, write } from '@kubb/fs'
 import { BarrelManager } from './BarrelManager.ts'
-import { getRelativePath, read } from './fs/read.ts'
-import { write } from './fs/write.ts'
 import { searchAndReplace } from './transformers/searchAndReplace.ts'
 import { trimExtName } from './transformers/trim.ts'
 
+import type * as KubbFile from '@kubb/fs/types'
+
+import type { BaseName, File, UUID } from '@kubb/fs/src/types.ts'
 import type { GreaterThan } from '@kubb/types'
 import type { BarrelManagerOptions } from './BarrelManager.ts'
 import type { Logger } from './logger.ts'
@@ -18,163 +20,30 @@ import transformers from './transformers/index.ts'
 import type { Plugin } from './types.ts'
 import { getParser } from './utils'
 
-type BasePath<T extends string = string> = `${T}/`
-
-export namespace KubbFile {
-  export type Import = {
-    /**
-     * Import name to be used
-     * @example ["useState"]
-     * @example "React"
-     */
-    name:
-      | string
-      | Array<
-          | string
-          | {
-              propertyName: string
-              name?: string
-            }
-        >
-    /**
-     * Path for the import
-     * @xample '@kubb/core'
-     */
-    path: string
-    /**
-     * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`.
-     */
-    isTypeOnly?: boolean
-    /**
-     * Add `* as` prefix to the import, this will result in: `import * as path from './path'`.
-     */
-
-    isNameSpace?: boolean
-    /**
-     * When root is set it will get the path with relative getRelativePath(root, path).
-     */
-    root?: string
-  }
-
-  export type Export = {
-    /**
-     * Export name to be used.
-     * @example ["useState"]
-     * @example "React"
-     */
-    name?: string | Array<string>
-    /**
-     * Path for the import.
-     * @xample '@kubb/core'
-     */
-    path: string
-    /**
-     * Add `type` prefix to the export, this will result in: `export type { Type } from './path'`.
-     */
-    isTypeOnly?: boolean
-    /**
-     * Make it possible to override the name, this will result in: `export * as aliasName from './path'`.
-     */
-    asAlias?: boolean
-  }
-
-  export declare const dataTagSymbol: unique symbol
-  export type DataTag<Type, Value> = Type & {
-    [dataTagSymbol]: Value
-  }
-
-  export type UUID = string
-  export type Source = string
-
-  export type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`
-
-  export type Mode = 'single' | 'split'
-
+export type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = File<TMeta, TBaseName> & {
   /**
-   * Name to be used to dynamicly create the baseName(based on input.path)
-   * Based on UNIX basename
-   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
+   * @default crypto.randomUUID()
    */
-  export type BaseName = `${string}${Extname}`
-
+  id: UUID
   /**
-   * Path will be full qualified path to a specified file
+   * Contains the first part of the baseName, generated based on baseName
+   * @link  https://nodejs.org/api/path.html#pathformatpathobject
    */
-  export type Path = string
 
-  export type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`
-
-  export type OptionalPath = Path | undefined | null
-
-  export type FileMetaBase = {
-    pluginKey?: Plugin['key']
-  }
-
-  export type File<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = {
-    /**
-     * Unique identifier to reuse later
-     * @default crypto.randomUUID()
-     */
-    id?: string
-    /**
-     * Name to be used to create the path
-     * Based on UNIX basename, `${name}.extName`
-     * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
-     */
-    baseName: TBaseName
-    /**
-     * Path will be full qualified path to a specified file
-     */
-    path: AdvancedPath<TBaseName> | Path
-    source: Source
-    imports?: Import[]
-    exports?: Export[]
-    /**
-     * This will call fileManager.add instead of fileManager.addOrAppend, adding the source when the files already exists
-     * This will also ignore the combinefiles utils
-     * @default `false`
-     */
-    override?: boolean
-    /**
-     * Use extra meta, this is getting used to generate the barrel/index files.
-     */
-    meta?: TMeta
-    /**
-     * Override if a file can be exported by the BarrelManager
-     * @default true
-     */
-    exportable?: boolean
-    /**
-     * This will override `process.env[key]` inside the `source`, see `getFileSource`.
-     */
-    env?: NodeJS.ProcessEnv
-    /**
-     * The name of the language being used. This can be TypeScript, JavaScript and still have another ext.
-     */
-    language?: string
-  }
+  name: string
+}
 
-  export type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = KubbFile.File<TMeta, TBaseName> & {
-    /**
-     * @default crypto.randomUUID()
-     */
-    id: UUID
-    /**
-     * Contains the first part of the baseName, generated based on baseName
-     * @link  https://nodejs.org/api/path.html#pathformatpathobject
-     */
-
-    name: string
-  }
+export type FileMetaBase = {
+  pluginKey?: Plugin['key']
 }
 
-type CacheItem = KubbFile.ResolvedFile & {
+type FileWithMeta<TMeta extends FileMetaBase = FileMetaBase> = KubbFile.File<TMeta>
+
+type CacheItem = ResolvedFile & {
   cancel?: () => void
 }
 
-type AddResult<T extends Array<KubbFile.File>> = Promise<
-  Awaited<GreaterThan<T['length'], 1> extends true ? Promise<KubbFile.ResolvedFile[]> : Promise<KubbFile.ResolvedFile>>
->
+type AddResult<T extends Array<FileWithMeta>> = Promise<Awaited<GreaterThan<T['length'], 1> extends true ? Promise<ResolvedFile[]> : Promise<ResolvedFile>>>
 
 type AddIndexesProps = {
   /**
@@ -192,12 +61,12 @@ type AddIndexesProps = {
   }
   logger: Logger
   options?: BarrelManagerOptions
-  meta?: KubbFile.File['meta']
+  meta?: FileWithMeta['meta']
 }
 
 type Options = {
   queue?: PQueue
-  task?: (file: KubbFile.ResolvedFile) => Promise<KubbFile.ResolvedFile>
+  task?: (file: ResolvedFile) => Promise<ResolvedFile>
 }
 
 export class FileManager {
@@ -213,8 +82,8 @@ export class FileManager {
     return this
   }
 
-  get files(): Array<KubbFile.File> {
-    const files: Array<KubbFile.File> = []
+  get files(): Array<FileWithMeta> {
+    const files: Array<FileWithMeta> = []
     this.#cache.forEach((item) => {
       files.push(...item.flat(1))
     })
@@ -225,7 +94,7 @@ export class FileManager {
     return this.#queue.size !== 0 && this.#queue.pending !== 0
   }
 
-  async add<T extends Array<KubbFile.File> = Array<KubbFile.File>>(...files: T): AddResult<T> {
+  async add<T extends Array<FileWithMeta> = Array<FileWithMeta>>(...files: T): AddResult<T> {
     const promises = combineFiles(files).map((file) => {
       if (file.override) {
         return this.#add(file)
@@ -243,9 +112,9 @@ export class FileManager {
     return resolvedFiles[0] as unknown as AddResult<T>
   }
 
-  async #add(file: KubbFile.File): Promise<KubbFile.ResolvedFile> {
+  async #add(file: FileWithMeta): Promise<ResolvedFile> {
     const controller = new AbortController()
-    const resolvedFile: KubbFile.ResolvedFile = {
+    const resolvedFile: ResolvedFile = {
       id: crypto.randomUUID(),
       name: trimExtName(file.baseName),
       ...file,
@@ -272,10 +141,10 @@ export class FileManager {
         return this.#task?.(resolvedFile)
       },
       { signal: controller.signal },
-    ) as Promise<KubbFile.ResolvedFile>
+    ) as Promise<ResolvedFile>
   }
 
-  async #addOrAppend(file: KubbFile.File): Promise<KubbFile.ResolvedFile> {
+  async #addOrAppend(file: FileWithMeta): Promise<ResolvedFile> {
     const previousCaches = this.#cache.get(file.path)
     const previousCache = previousCaches ? previousCaches.at(previousCaches.length - 1) : undefined
 
@@ -341,7 +210,7 @@ export class FileManager {
     )
 
     const rootPath = mode === 'split' ? `${exportPath}/index${output.extName || ''}` : `${exportPath}${output.extName || ''}`
-    const rootFile: KubbFile.File = {
+    const rootFile: FileWithMeta = {
       path: resolve(root, 'index.ts'),
       baseName: 'index.ts',
       source: '',
@@ -371,8 +240,8 @@ export class FileManager {
     })
   }
 
-  getCacheByUUID(UUID: KubbFile.UUID): KubbFile.File | undefined {
-    let cache: KubbFile.File | undefined
+  getCacheByUUID(UUID: KubbFile.UUID): FileWithMeta | undefined {
+    let cache: FileWithMeta | undefined
 
     this.#cache.forEach((files) => {
       cache = files.find((item) => item.id === UUID)
@@ -380,7 +249,7 @@ export class FileManager {
     return cache
   }
 
-  get(path: KubbFile.Path): Array<KubbFile.File> | undefined {
+  get(path: KubbFile.Path): Array<FileWithMeta> | undefined {
     return this.#cache.get(path)
   }
 
@@ -403,11 +272,11 @@ export class FileManager {
 
   // statics
 
-  static async getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): Promise<string> {
+  static async getSource<TMeta extends FileMetaBase = FileMetaBase>(file: FileWithMeta<TMeta>): Promise<string> {
     return getSource<TMeta>(file)
   }
 
-  static combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>> {
+  static combineFiles<TMeta extends FileMetaBase = FileMetaBase>(files: Array<FileWithMeta<TMeta> | null>): Array<FileWithMeta<TMeta>> {
     return combineFiles<TMeta>(files)
   }
   static getMode(path: string | undefined | null): KubbFile.Mode {
@@ -426,9 +295,9 @@ export class FileManager {
   }
 }
 
-function combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>> {
+function combineFiles<TMeta extends FileMetaBase = FileMetaBase>(files: Array<FileWithMeta<TMeta> | null>): Array<FileWithMeta<TMeta>> {
   return files.filter(Boolean).reduce(
-    (acc, file: KubbFile.File<TMeta>) => {
+    (acc, file: FileWithMeta<TMeta>) => {
       const prevIndex = acc.findIndex((item) => item.path === file.path)
 
       if (prevIndex === -1) {
@@ -458,11 +327,11 @@ function combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBas
 
       return acc
     },
-    [] as Array<KubbFile.File<TMeta>>,
+    [] as Array<FileWithMeta<TMeta>>,
   )
 }
 
-export async function getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): Promise<string> {
+export async function getSource<TMeta extends FileMetaBase = FileMetaBase>(file: FileWithMeta<TMeta>): Promise<string> {
   // only use .js, .ts or .tsx files for ESM imports
 
   if (file.language ? !['typescript', 'javascript'].includes(file.language) : !FileManager.isJavascript(file.baseName)) {

package/src/PackageManager.ts

@@ -5,7 +5,7 @@ import { pathToFileURL } from 'node:url'
 import { findUp, findUpSync } from 'find-up'
 import { coerce, satisfies } from 'semver'
 
-import { read, readSync } from './fs/read'
+import { read, readSync } from '@kubb/fs'
 
 type PackageJSON = {
   dependencies?: Record<string, string>

package/src/PluginManager.ts

@@ -1,18 +1,18 @@
 import PQueue from 'p-queue'
 
-import { FileManager } from './FileManager.ts'
+import { readSync } from '@kubb/fs'
+import { FileManager, type ResolvedFile } from './FileManager.ts'
 import { isPromise, isPromiseRejectedResult } from './PromiseManager.ts'
 import { PromiseManager } from './PromiseManager.ts'
 import { ValidationPluginError } from './errors.ts'
-import { readSync } from './fs/read.ts'
 import { LogLevel } from './logger.ts'
 import { pluginCore } from './plugin.ts'
 import { transformReservedWord } from './transformers/transformReservedWord.ts'
 import { EventEmitter } from './utils/EventEmitter.ts'
 import { setUniqueName } from './utils/uniqueName.ts'
 
+import type * as KubbFile from '@kubb/fs/types'
 import type { PossiblePromise } from '@kubb/types'
-import type { KubbFile } from './FileManager.ts'
 import type { Logger } from './logger.ts'
 import type { PluginCore } from './plugin.ts'
 import type {
@@ -63,7 +63,7 @@ type Options = {
   /**
    * Task for the FileManager
    */
-  task: (file: KubbFile.ResolvedFile) => Promise<KubbFile.ResolvedFile>
+  task: (file: ResolvedFile) => Promise<ResolvedFile>
 }
 
 type Events = {
@@ -634,7 +634,7 @@ export class PluginManager {
 
     // default transform
     if (!plugin.transform) {
-      plugin.transform = function transform(code) {
+      plugin.transform = function transform(_path, code) {
         return code
       }
     }

package/src/build.ts

@@ -1,15 +1,13 @@
 import c from 'tinyrainbow'
 
-import { FileManager } from './FileManager.ts'
+import { clean, read } from '@kubb/fs'
+import { FileManager, type ResolvedFile } from './FileManager.ts'
 import { PluginManager } from './PluginManager.ts'
 import { isPromise } from './PromiseManager.ts'
 import { isInputPath } from './config.ts'
-import { clean } from './fs/clean.ts'
-import { read } from './fs/read.ts'
 import { LogLevel, createLogger, randomCliColour } from './logger.ts'
 import { URLPath } from './utils/URLPath.ts'
 
-import type { KubbFile } from './FileManager.ts'
 import type { Logger } from './logger.ts'
 import type { Plugin, PluginContext, PluginParameter, TransformResult } from './types.ts'
 
@@ -62,7 +60,7 @@ async function setup(options: BuildOptions): Promise<PluginManager> {
     await clean(config.output.path)
   }
 
-  const task = async (file: KubbFile.ResolvedFile): Promise<KubbFile.ResolvedFile> => {
+  const task = async (file: ResolvedFile): Promise<ResolvedFile> => {
     const { path } = file
 
     let source: string | null = await FileManager.getSource(file)
@@ -81,7 +79,7 @@ async function setup(options: BuildOptions): Promise<PluginManager> {
     if (source) {
       source = await pluginManager.hookReduceArg0({
         hookName: 'transform',
-        parameters: [source, path],
+        parameters: [path, source],
         reduce: transformReducer,
       })
 
@@ -91,13 +89,13 @@ async function setup(options: BuildOptions): Promise<PluginManager> {
           await pluginManager.hookForPlugin({
             pluginKey: file.meta?.pluginKey,
             hookName: 'writeFile',
-            parameters: [source, path],
+            parameters: [path, source],
           })
         }
 
         await pluginManager.hookFirst({
           hookName: 'writeFile',
-          parameters: [source, path],
+          parameters: [path, source],
         })
       }
     }

package/src/config.ts

@@ -1,5 +1,32 @@
 import type { PossiblePromise } from '@kubb/types'
-import type { CLIOptions, Config, InputPath, UserConfig } from './types.ts'
+import type { Config, InputPath, UserConfig } from './types.ts'
+
+type Args = {
+  /**
+   * Path to `kubb.config.js`
+   */
+  config?: string
+  /**
+   * Watch changes on input
+   */
+  watch?: boolean
+
+  /**
+   * Log level to report when using the CLI
+   *
+   * `silent` will hide all information that is not relevant
+   *
+   * `info` will show all information possible(not related to the PluginManager)
+   *
+   * `debug` will show all information possible(related to the PluginManager), handy for seeing logs
+   * @default `silent`
+   */
+  logLevel?: string
+  /**
+   * Run Kubb with Bun
+   */
+  bun?: boolean
+}
 
 /**
  * Type helper to make it easier to use kubb.config.js
@@ -11,7 +38,7 @@ export function defineConfig(
     | PossiblePromise<UserConfig | Array<UserConfig>>
     | ((
         /** The options derived from the CLI flags */
-        cliOptions: CLIOptions,
+        args: Args,
       ) => PossiblePromise<UserConfig | Array<UserConfig>>),
 ): typeof options {
   return options

package/src/index.ts

@@ -1,7 +1,8 @@
 export { build, build as default, safeBuild } from './build.ts'
 export { defineConfig, isInputPath } from './config.ts'
 export { Warning } from './errors.ts'
-export { FileManager, KubbFile } from './FileManager.ts'
+export { FileManager } from './FileManager.ts'
+export type { FileMetaBase } from './FileManager.ts'
 export { Generator } from './Generator.ts'
 export { PackageManager } from './PackageManager.ts'
 export { createPlugin } from './plugin.ts'
@@ -11,5 +12,3 @@ export type * from './types.ts'
 
 // biome-ignore lint/suspicious/noEmptyInterface: <explanation>
 export interface _Register {}
-
-export * as Kubb from './kubb.ts'

package/src/logger.ts

@@ -1,9 +1,9 @@
 import seedrandom from 'seedrandom'
 import c, { createColors } from 'tinyrainbow'
 
-import { writeLog } from './fs/write.ts'
 import { EventEmitter } from './utils/EventEmitter.ts'
 
+import type { ConsolaInstance } from 'consola'
 import type { Ora } from 'ora'
 import type { Formatter } from 'tinyrainbow'
 
@@ -14,6 +14,12 @@ export const LogLevel = {
   debug: 'debug',
 } as const
 
+export const LogMapper = {
+  silent: Number.NEGATIVE_INFINITY,
+  info: 3,
+  debug: 4,
+} as const
+
 export type LogLevel = keyof typeof LogLevel
 
 type Events = {
@@ -29,8 +35,8 @@ export type Logger = {
    */
   name?: string
   logLevel: LogLevel
-
   spinner?: Ora
+  consola?: ConsolaInstance
   on: EventEmitter<Events>['on']
   emit: EventEmitter<Events>['emit']
 }
@@ -39,9 +45,10 @@ type Props = {
   name?: string
   logLevel: LogLevel
   spinner?: Ora
+  consola?: ConsolaInstance
 }
 
-export function createLogger({ logLevel, name, spinner }: Props): Logger {
+export function createLogger({ logLevel, name, spinner, consola }: Props): Logger {
   const events = new EventEmitter<Events>()
 
   events.on('start', (message) => {
@@ -70,16 +77,11 @@ export function createLogger({ logLevel, name, spinner }: Props): Logger {
     throw error
   })
 
-  events.on('debug', async (messages) => {
-    if (logLevel === LogLevel.debug) {
-      await writeLog(messages.join('\n'))
-    }
-  })
-
   const logger: Logger = {
     name,
     logLevel,
     spinner,
+    consola,
     on: (...args) => {
       return events.on(...args)
     },

package/src/types.ts

@@ -1,8 +1,9 @@
+import type * as KubbFile from '@kubb/fs/types'
 import type { PossiblePromise } from '@kubb/types'
-import type { FileManager, KubbFile } from './FileManager.ts'
+import type { FileManager } from './FileManager.ts'
 import type { PluginManager } from './PluginManager.ts'
 import type { OptionsPlugins, PluginUnion } from './kubb.ts'
-import type { LogLevel, Logger } from './logger.ts'
+import type { Logger } from './logger.ts'
 import type { Cache } from './utils/cache.ts'
 
 // config
@@ -96,33 +97,6 @@ export type Config<TInput = Input> = {
   }
 }
 
-export type CLIOptions = {
-  /**
-   * Path to `kubb.config.js`
-   */
-  config?: string
-  /**
-   * Watch changes on input
-   */
-  watch?: string
-
-  /**
-   * Log level to report when using the CLI
-   *
-   * `silent` will hide all information that is not relevant
-   *
-   * `info` will show all information possible(not related to the PluginManager)
-   *
-   * `debug` will show all information possible(related to the PluginManager), handy for seeing logs
-   * @default `silent`
-   */
-  logLevel?: LogLevel
-  /**
-   * Run Kubb with Bun
-   */
-  bun?: boolean
-}
-
 // plugin
 
 export type UnionPlugins = PluginUnion
@@ -269,7 +243,7 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
    * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
    * @type hookParallel
    */
-  writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, source: string | undefined, path: KubbFile.Path) => PossiblePromise<string | void>
+  writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path, source: string | undefined) => PossiblePromise<string | void>
   /**
    * End of the plugin lifecycle.
    * @type hookParallel

package/src/utils/TreeNode.ts

@@ -2,8 +2,8 @@ import dirTree from 'directory-tree'
 
 import { FileManager } from '../FileManager.ts'
 
+import type * as KubbFile from '@kubb/fs/types'
 import type { DirectoryTree, DirectoryTreeOptions } from 'directory-tree'
-import type { KubbFile } from '../FileManager.ts'
 
 export type TreeNodeOptions = DirectoryTreeOptions