@kubb/core 3.0.0-alpha.0 → 3.0.0-alpha.10

package/src/PackageManager.ts

@@ -68,7 +68,7 @@ export class PackageManager {
 
       return module?.default ?? module
     } catch (e) {
-      console.log(e)
+      console.error(e)
       return undefined
     }
   }

package/src/PluginManager.ts

@@ -1,11 +1,7 @@
-import PQueue from 'p-queue'
-
-import { readSync } from '@kubb/fs'
-import { FileManager, type ResolvedFile } from './FileManager.ts'
+import { FileManager } from './FileManager.ts'
 import { isPromise, isPromiseRejectedResult } from './PromiseManager.ts'
 import { PromiseManager } from './PromiseManager.ts'
 import { ValidationPluginError } from './errors.ts'
-import { LogLevel } from './logger.ts'
 import { pluginCore } from './plugin.ts'
 import { transformReservedWord } from './transformers/transformReservedWord.ts'
 import { EventEmitter } from './utils/EventEmitter.ts'
@@ -41,6 +37,7 @@ type Argument0<H extends keyof PluginLifecycle> = Parameters<RequiredPluginLifec
 type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookReduceArg0' | 'hookSeq'
 
 type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  message: string
   strategy: Strategy
   hookName: H
   plugin: Plugin
@@ -59,15 +56,10 @@ type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseRe
 
 type Options = {
   logger: Logger
-
-  /**
-   * Task for the FileManager
-   */
-  task: (file: ResolvedFile) => Promise<ResolvedFile>
 }
 
 type Events = {
-  execute: [executer: Executer]
+  executing: [executer: Executer]
   executed: [executer: Executer]
   error: [error: Error]
 }
@@ -89,21 +81,17 @@ export class PluginManager {
 
   readonly executed: Array<Executer> = []
   readonly logger: Logger
+  readonly options: Options
   readonly #core: Plugin<PluginCore>
 
   readonly #usedPluginNames: Record<string, number> = {}
   readonly #promiseManager: PromiseManager
 
-  readonly queue: PQueue
-
   constructor(config: Config, options: Options) {
     this.config = config
+    this.options = options
     this.logger = options.logger
-    this.queue = new PQueue({ concurrency: 1 })
-    this.fileManager = new FileManager({
-      task: options.task,
-      queue: this.queue,
-    })
+    this.fileManager = new FileManager()
     this.#promiseManager = new PromiseManager({
       nullCheck: (state: SafeParseResult<'resolveName'> | null) => !!state?.result,
     })
@@ -120,18 +108,17 @@ export class PluginManager {
       getPlugins: this.#getSortedPlugins.bind(this),
     })
 
-    // call core.api.call with empty context so we can transform `api()` to `api: {}`
-    this.#core = this.#parse(core as unknown as UserPlugin, this as any, core.api.call(null as any)) as Plugin<PluginCore>
+    // call core.context.call with empty context so we can transform `context()` to `context: {}`
+    this.#core = this.#parse(core as unknown as UserPlugin, this as any, core.context.call(null as any)) as Plugin<PluginCore>
 
     this.plugins = [this.#core, ...plugins].map((plugin) => {
-      return this.#parse(plugin as UserPlugin, this, this.#core.api)
+      return this.#parse(plugin as UserPlugin, this, this.#core.context)
     })
 
     return this
   }
 
   getFile<TOptions = object>({ name, mode, extName, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginKey: Plugin['key'] }> {
-    let source = ''
     const baseName = `${name}${extName}` as const
     const path = this.resolvePath({ baseName, mode, pluginKey, options })
 
@@ -139,19 +126,13 @@ export class PluginManager {
       throw new Error(`Filepath should be defined for resolvedName "${name}" and pluginKey [${JSON.stringify(pluginKey)}]`)
     }
 
-    try {
-      source = readSync(path)
-    } catch (_e) {
-      //
-    }
-
     return {
       path,
       baseName,
       meta: {
         pluginKey,
       },
-      source,
+      sources: [],
     }
   }
 
@@ -161,14 +142,18 @@ export class PluginManager {
         pluginKey: params.pluginKey,
         hookName: 'resolvePath',
         parameters: [params.baseName, params.mode, params.options as object],
+        message: `Resolving path '${params.baseName}'`,
       })
 
       if (paths && paths?.length > 1) {
-        this.logger.emit('debug', [
-          `Cannot return a path where the 'pluginKey' ${
-            params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
-          } is not unique enough\n\nPaths: ${JSON.stringify(paths, undefined, 2)}\n\nFalling back on the first item.\n`,
-        ])
+        this.logger.emit('debug', {
+          date: new Date(),
+          logs: [
+            `Cannot return a path where the 'pluginKey' ${
+              params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
+            } is not unique enough\n\nPaths: ${JSON.stringify(paths, undefined, 2)}\n\nFalling back on the first item.\n`,
+          ],
+        })
       }
 
       return paths?.at(0)
@@ -176,22 +161,28 @@ export class PluginManager {
     return this.hookFirstSync({
       hookName: 'resolvePath',
       parameters: [params.baseName, params.mode, params.options as object],
+      message: `Resolving path '${params.baseName}'`,
     }).result
   }
+  //TODO refactor by using the order of plugins and the cache of the fileManager instead of guessing and recreating the name/path
   resolveName = (params: ResolveNameParams): string => {
     if (params.pluginKey) {
       const names = this.hookForPluginSync({
         pluginKey: params.pluginKey,
         hookName: 'resolveName',
         parameters: [params.name, params.type],
+        message: `Resolving name '${params.name}' and type '${params.type}'`,
       })
 
       if (names && names?.length > 1) {
-        this.logger.emit('debug', [
-          `Cannot return a name where the 'pluginKey' ${
-            params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
-          } is not unique enough\n\nNames: ${JSON.stringify(names, undefined, 2)}\n\nFalling back on the first item.\n`,
-        ])
+        this.logger.emit('debug', {
+          date: new Date(),
+          logs: [
+            `Cannot return a name where the 'pluginKey' ${
+              params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
+            } is not unique enough\n\nNames: ${JSON.stringify(names, undefined, 2)}\n\nFalling back on the first item.\n`,
+          ],
+        })
       }
 
       return transformReservedWord(names?.at(0) || params.name)
@@ -200,6 +191,7 @@ export class PluginManager {
     const name = this.hookFirstSync({
       hookName: 'resolveName',
       parameters: [params.name, params.type],
+      message: `Resolving name '${params.name}' and type '${params.type}'`,
     }).result
 
     return transformReservedWord(name)
@@ -215,17 +207,21 @@ export class PluginManager {
   /**
    * Run a specific hookName for plugin x.
    */
-  hookForPlugin<H extends PluginLifecycleHooks>({
+  async hookForPlugin<H extends PluginLifecycleHooks>({
     pluginKey,
     hookName,
     parameters,
+    message,
   }: {
     pluginKey: Plugin['key']
     hookName: H
     parameters: PluginParameter<H>
-  }): Promise<Array<ReturnType<ParseResult<H>> | null>> | null {
+    message: string
+  }): Promise<Array<ReturnType<ParseResult<H>> | null>> {
     const plugins = this.getPluginsByKey(hookName, pluginKey)
 
+    this.logger.emit('progress_start', { id: hookName, size: plugins.length, message: 'Running plugins...' })
+
     const promises = plugins
       .map((plugin) => {
         return this.#execute<H>({
@@ -233,11 +229,16 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         })
       })
       .filter(Boolean)
 
-    return Promise.all(promises)
+    const items = await Promise.all(promises)
+
+    this.logger.emit('progress_stop', { id: hookName })
+
+    return items
   }
   /**
    * Run a specific hookName for plugin x.
@@ -247,23 +248,28 @@ export class PluginManager {
     pluginKey,
     hookName,
     parameters,
+    message,
   }: {
     pluginKey: Plugin['key']
     hookName: H
     parameters: PluginParameter<H>
+    message: string
   }): Array<ReturnType<ParseResult<H>>> | null {
     const plugins = this.getPluginsByKey(hookName, pluginKey)
 
-    return plugins
+    const result = plugins
       .map((plugin) => {
         return this.#executeSync<H>({
           strategy: 'hookFirst',
           hookName,
           parameters,
           plugin,
+          message,
         })
       })
       .filter(Boolean)
+
+    return result
   }
 
   /**
@@ -273,32 +279,41 @@ export class PluginManager {
     hookName,
     parameters,
     skipped,
+    message,
   }: {
     hookName: H
     parameters: PluginParameter<H>
     skipped?: ReadonlySet<Plugin> | null
+    message: string
   }): Promise<SafeParseResult<H>> {
-    const promises = this.#getSortedPlugins()
-      .filter((plugin) => {
-        return skipped ? skipped.has(plugin) : true
-      })
-      .map((plugin) => {
-        return async () => {
-          const value = await this.#execute<H>({
-            strategy: 'hookFirst',
-            hookName,
-            parameters,
-            plugin,
-          })
+    const plugins = this.#getSortedPlugins(hookName).filter((plugin) => {
+      return skipped ? skipped.has(plugin) : true
+    })
 
-          return Promise.resolve({
-            plugin,
-            result: value,
-          } as SafeParseResult<H>)
-        }
-      })
+    this.logger.emit('progress_start', { id: hookName, size: plugins.length })
 
-    return this.#promiseManager.run('first', promises)
+    const promises = plugins.map((plugin) => {
+      return async () => {
+        const value = await this.#execute<H>({
+          strategy: 'hookFirst',
+          hookName,
+          parameters,
+          plugin,
+          message,
+        })
+
+        return Promise.resolve({
+          plugin,
+          result: value,
+        } as SafeParseResult<H>)
+      }
+    })
+
+    const result = await this.#promiseManager.run('first', promises)
+
+    this.logger.emit('progress_stop', { id: hookName })
+
+    return result
   }
 
   /**
@@ -308,24 +323,26 @@ export class PluginManager {
     hookName,
     parameters,
     skipped,
+    message,
   }: {
     hookName: H
     parameters: PluginParameter<H>
     skipped?: ReadonlySet<Plugin> | null
+    message: string
   }): SafeParseResult<H> {
     let parseResult: SafeParseResult<H> = null as unknown as SafeParseResult<H>
+    const plugins = this.#getSortedPlugins(hookName).filter((plugin) => {
+      return skipped ? skipped.has(plugin) : true
+    })
 
-    for (const plugin of this.#getSortedPlugins()) {
-      if (skipped?.has(plugin)) {
-        continue
-      }
-
+    for (const plugin of plugins) {
       parseResult = {
         result: this.#executeSync<H>({
           strategy: 'hookFirst',
           hookName,
           parameters,
           plugin,
+          message,
         }),
         plugin,
       } as SafeParseResult<H>
@@ -334,6 +351,7 @@ export class PluginManager {
         break
       }
     }
+
     return parseResult
   }
 
@@ -343,17 +361,23 @@ export class PluginManager {
   async hookParallel<H extends PluginLifecycleHooks, TOuput = void>({
     hookName,
     parameters,
+    message,
   }: {
     hookName: H
     parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined
+    message: string
   }): Promise<Awaited<TOuput>[]> {
-    const promises = this.#getSortedPlugins().map((plugin) => {
+    const plugins = this.#getSortedPlugins(hookName)
+    this.logger.emit('progress_start', { id: hookName, size: plugins.length })
+
+    const promises = plugins.map((plugin) => {
       return () =>
         this.#execute({
           strategy: 'hookParallel',
           hookName,
           parameters,
           plugin,
+          message,
         }) as Promise<TOuput>
     })
 
@@ -361,12 +385,14 @@ export class PluginManager {
 
     results.forEach((result, index) => {
       if (isPromiseRejectedResult<Error>(result)) {
-        const plugin = this.#getSortedPlugins()[index]
+        const plugin = this.#getSortedPlugins(hookName)[index]
 
         this.#catcher<H>(result.reason, plugin, hookName)
       }
     })
 
+    this.logger.emit('progress_stop', { id: hookName })
+
     return results.filter((result) => result.status === 'fulfilled').map((result) => (result as PromiseFulfilledResult<Awaited<TOuput>>).value)
   }
 
@@ -377,15 +403,18 @@ export class PluginManager {
     hookName,
     parameters,
     reduce,
+    message,
   }: {
     hookName: H
     parameters: PluginParameter<H>
     reduce: (reduction: Argument0<H>, result: ReturnType<ParseResult<H>>, plugin: Plugin) => PossiblePromise<Argument0<H> | null>
+    message: string
   }): Promise<Argument0<H>> {
     const [argument0, ...rest] = parameters
+    const plugins = this.#getSortedPlugins(hookName)
 
     let promise: Promise<Argument0<H>> = Promise.resolve(argument0)
-    for (const plugin of this.#getSortedPlugins()) {
+    for (const plugin of plugins) {
       promise = promise
         .then((arg0) => {
           const value = this.#execute({
@@ -393,10 +422,11 @@ export class PluginManager {
             hookName,
             parameters: [arg0, ...rest] as PluginParameter<H>,
             plugin,
+            message,
           })
           return value
         })
-        .then((result) => reduce.call(this.#core.api, argument0, result as ReturnType<ParseResult<H>>, plugin)) as Promise<Argument0<H>>
+        .then((result) => reduce.call(this.#core.context, argument0, result as ReturnType<ParseResult<H>>, plugin)) as Promise<Argument0<H>>
     }
 
     return promise
@@ -405,31 +435,34 @@ export class PluginManager {
   /**
    * Chains plugins
    */
-  async hookSeq<H extends PluginLifecycleHooks>({ hookName, parameters }: { hookName: H; parameters?: PluginParameter<H> }): Promise<void> {
-    const promises = this.#getSortedPlugins().map((plugin) => {
+  async hookSeq<H extends PluginLifecycleHooks>({
+    hookName,
+    parameters,
+    message,
+  }: { hookName: H; parameters?: PluginParameter<H>; message: string }): Promise<void> {
+    const plugins = this.#getSortedPlugins(hookName)
+    this.logger.emit('progress_start', { id: hookName, size: plugins.length })
+
+    const promises = plugins.map((plugin) => {
       return () =>
         this.#execute({
           strategy: 'hookSeq',
           hookName,
           parameters,
           plugin,
+          message,
         })
     })
 
-    return this.#promiseManager.run('seq', promises)
+    await this.#promiseManager.run('seq', promises)
+
+    this.logger.emit('progress_stop', { id: hookName })
   }
 
   #getSortedPlugins(hookName?: keyof PluginLifecycle): Plugin[] {
     const plugins = [...this.plugins].filter((plugin) => plugin.name !== 'core')
 
     if (hookName) {
-      if (this.logger.logLevel === LogLevel.info) {
-        const containsHookName = plugins.some((item) => item[hookName])
-        if (!containsHookName) {
-          this.logger.emit('warning', `No hook ${hookName} found`)
-        }
-      }
-
       return plugins.filter((item) => item[hookName])
     }
     // TODO add test case for sorting with pre/post
@@ -482,9 +515,15 @@ export class PluginManager {
       const corePlugin = plugins.find((plugin) => plugin.name === 'core' && plugin[hookName])
 
       if (corePlugin) {
-        this.logger.emit('debug', [`No hook '${hookName}' for pluginKey '${JSON.stringify(pluginKey)}' found, falling back on the '@kubb/core' plugin`])
+        this.logger.emit('debug', {
+          date: new Date(),
+          logs: [`No hook '${hookName}' for pluginKey '${JSON.stringify(pluginKey)}' found, falling back on the '@kubb/core' plugin`],
+        })
       } else {
-        this.logger.emit('debug', [`No hook '${hookName}' for pluginKey '${JSON.stringify(pluginKey)}' found, no fallback found in the '@kubb/core' plugin`])
+        this.logger.emit('debug', {
+          date: new Date(),
+          logs: [`No hook '${hookName}' for pluginKey '${JSON.stringify(pluginKey)}' found, no fallback found in the '@kubb/core' plugin`],
+        })
       }
       return corePlugin ? [corePlugin] : []
     }
@@ -496,6 +535,8 @@ export class PluginManager {
     if (executer) {
       this.events.emit('executed', executer)
       this.executed.push(executer)
+
+      this.logger.emit('progressed', { id: executer.hookName, message: `${executer.plugin.name}: ${executer.message}` })
     }
   }
 
@@ -511,11 +552,13 @@ export class PluginManager {
     hookName,
     parameters,
     plugin,
+    message,
   }: {
     strategy: Strategy
     hookName: H
     parameters: unknown[] | undefined
     plugin: PluginWithLifeCycle
+    message: string
   }): Promise<ReturnType<ParseResult<H>> | null> | null {
     const hook = plugin[hookName]
     let output: unknown
@@ -524,12 +567,15 @@ export class PluginManager {
       return null
     }
 
-    this.events.emit('execute', { strategy, hookName, parameters, plugin })
+    this.events.emit('executing', { strategy, hookName, parameters, plugin, message })
+    const promise = new Promise((resolve) => {
+      resolve(undefined)
+    })
 
-    const task = Promise.resolve()
+    const task = promise
       .then(() => {
         if (typeof hook === 'function') {
-          const possiblePromiseResult = (hook as Function).apply({ ...this.#core.api, plugin }, parameters) as Promise<ReturnType<ParseResult<H>>>
+          const possiblePromiseResult = (hook as Function).apply({ ...this.#core.context, plugin }, parameters) as Promise<ReturnType<ParseResult<H>>>
 
           if (isPromise(possiblePromiseResult)) {
             return Promise.resolve(possiblePromiseResult)
@@ -548,6 +594,7 @@ export class PluginManager {
           strategy,
           hookName,
           plugin,
+          message,
         })
 
         return result
@@ -573,11 +620,13 @@ export class PluginManager {
     hookName,
     parameters,
     plugin,
+    message,
   }: {
     strategy: Strategy
     hookName: H
     parameters: PluginParameter<H>
     plugin: PluginWithLifeCycle
+    message: string
   }): ReturnType<ParseResult<H>> | null {
     const hook = plugin[hookName]
     let output: unknown
@@ -586,13 +635,23 @@ export class PluginManager {
       return null
     }
 
-    this.events.emit('execute', { strategy, hookName, parameters, plugin })
+    this.events.emit('executing', { strategy, hookName, parameters, plugin, message })
 
     try {
       if (typeof hook === 'function') {
-        const fn = (hook as Function).apply({ ...this.#core.api, plugin }, parameters) as ReturnType<ParseResult<H>>
+        const fn = (hook as Function).apply({ ...this.#core.context, plugin }, parameters) as ReturnType<ParseResult<H>>
 
         output = fn
+
+        this.#addExecutedToCallStack({
+          parameters,
+          output,
+          strategy,
+          hookName,
+          plugin,
+          message,
+        })
+
         return fn
       }
 
@@ -604,6 +663,7 @@ export class PluginManager {
         strategy,
         hookName,
         plugin,
+        message,
       })
 
       return hook
@@ -624,7 +684,7 @@ export class PluginManager {
   #parse<TPlugin extends UserPluginWithLifeCycle>(
     plugin: TPlugin,
     pluginManager: PluginManager,
-    context: PluginCore['api'] | undefined,
+    context: PluginCore['context'] | undefined,
   ): Plugin<GetPluginFactoryOptions<TPlugin>> {
     const usedPluginNames = pluginManager.#usedPluginNames
 
@@ -632,20 +692,11 @@ export class PluginManager {
 
     const key = [plugin.name, usedPluginNames[plugin.name]].filter(Boolean) as [typeof plugin.name, string]
 
-    // default transform
-    if (!plugin.transform) {
-      plugin.transform = function transform(_path, code) {
-        return code
-      }
-    }
-
-    if (plugin.api && typeof plugin.api === 'function') {
-      const api = (plugin.api as Function).call(context) as typeof plugin.api
-
+    if (plugin.context && typeof plugin.context === 'function') {
       return {
         ...plugin,
         key,
-        api,
+        context: (plugin.context as Function).call(context) as typeof plugin.context,
       } as unknown as Plugin<GetPluginFactoryOptions<TPlugin>>
     }
 
@@ -678,6 +729,6 @@ export class PluginManager {
   }
 
   static get hooks() {
-    return ['buildStart', 'resolvePath', 'resolveName', 'load', 'transform', 'writeFile', 'buildEnd'] as const
+    return ['buildStart', 'resolvePath', 'resolveName', 'buildEnd'] as const
   }
 }