@kubb/core 3.0.0-alpha.9 → 3.0.0-beta.2

package/src/PluginManager.ts

@@ -28,15 +28,10 @@ import type {
 
 type RequiredPluginLifecycle = Required<PluginLifecycle>
 
-/**
- * Get the type of the first argument in a function.
- * @example Arg0<(a: string, b: number) => void> -> string
- */
-type Argument0<H extends keyof PluginLifecycle> = Parameters<RequiredPluginLifecycle[H]>[0]
-
-type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookReduceArg0' | 'hookSeq'
+type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookSeq'
 
 type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
+  message: string
   strategy: Strategy
   hookName: H
   plugin: Plugin
@@ -58,7 +53,7 @@ type Options = {
 }
 
 type Events = {
-  execute: [executer: Executer]
+  executing: [executer: Executer]
   executed: [executer: Executer]
   error: [error: Error]
 }
@@ -66,13 +61,13 @@ type Events = {
 type GetFileProps<TOptions = object> = {
   name: string
   mode?: KubbFile.Mode
-  extName: KubbFile.Extname
+  extname: KubbFile.Extname
   pluginKey: Plugin['key']
   options?: TOptions
 }
 
 export class PluginManager {
-  readonly plugins: PluginWithLifeCycle[]
+  readonly plugins = new Set<Plugin<GetPluginFactoryOptions<any>>>()
   readonly fileManager: FileManager
   readonly events: EventEmitter<Events> = new EventEmitter()
 
@@ -95,8 +90,6 @@ export class PluginManager {
       nullCheck: (state: SafeParseResult<'resolveName'> | null) => !!state?.result,
     })
 
-    const plugins = config.plugins || []
-
     const core = pluginCore({
       config,
       logger: this.logger,
@@ -109,16 +102,17 @@ export class PluginManager {
 
     // 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.#core, ...(config.plugins || [])].forEach((plugin) => {
+      const parsedPlugin = this.#parse(plugin as UserPlugin, this, this.#core.context)
 
-    this.plugins = [this.#core, ...plugins].map((plugin) => {
-      return this.#parse(plugin as UserPlugin, this, this.#core.context)
+      this.plugins.add(parsedPlugin)
     })
 
     return this
   }
 
-  getFile<TOptions = object>({ name, mode, extName, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginKey: Plugin['key'] }> {
-    const baseName = `${name}${extName}` as const
+  getFile<TOptions = object>({ name, mode, extname, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginKey: Plugin['key'] }> {
+    const baseName = `${name}${extname}` as const
     const path = this.resolvePath({ baseName, mode, pluginKey, options })
 
     if (!path) {
@@ -141,10 +135,12 @@ 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', {
+          date: new Date(),
           logs: [
             `Cannot return a path where the 'pluginKey' ${
               params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
@@ -158,6 +154,7 @@ 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
@@ -167,10 +164,12 @@ export class PluginManager {
         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', {
+          date: new Date(),
           logs: [
             `Cannot return a name where the 'pluginKey' ${
               params.pluginKey ? JSON.stringify(params.pluginKey) : '"'
@@ -185,6 +184,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)
@@ -204,14 +204,16 @@ export class PluginManager {
     pluginKey,
     hookName,
     parameters,
+    message,
   }: {
     pluginKey: Plugin['key']
     hookName: H
     parameters: PluginParameter<H>
+    message: string
   }): Promise<Array<ReturnType<ParseResult<H>> | null>> {
     const plugins = this.getPluginsByKey(hookName, pluginKey)
 
-    this.logger.emit('progress_start', { id: hookName, size: plugins.length })
+    this.logger.emit('progress_start', { id: hookName, size: plugins.length, message: 'Running plugins...' })
 
     const promises = plugins
       .map((plugin) => {
@@ -220,6 +222,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         })
       })
       .filter(Boolean)
@@ -238,10 +241,12 @@ 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)
 
@@ -252,6 +257,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         })
       })
       .filter(Boolean)
@@ -266,10 +272,12 @@ export class PluginManager {
     hookName,
     parameters,
     skipped,
+    message,
   }: {
     hookName: H
     parameters: PluginParameter<H>
     skipped?: ReadonlySet<Plugin> | null
+    message: string
   }): Promise<SafeParseResult<H>> {
     const plugins = this.#getSortedPlugins(hookName).filter((plugin) => {
       return skipped ? skipped.has(plugin) : true
@@ -284,6 +292,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         })
 
         return Promise.resolve({
@@ -307,10 +316,12 @@ 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) => {
@@ -324,6 +335,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         }),
         plugin,
       } as SafeParseResult<H>
@@ -342,9 +354,11 @@ 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 plugins = this.#getSortedPlugins(hookName)
     this.logger.emit('progress_start', { id: hookName, size: plugins.length })
@@ -356,6 +370,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         }) as Promise<TOuput>
     })
 
@@ -375,42 +390,13 @@ export class PluginManager {
   }
 
   /**
-   * Chain all plugins, `reduce` can be passed through to handle every returned value. The return value of the first plugin will be used as the first parameter for the plugin after that.
+   * Chains plugins
    */
-  hookReduceArg0<H extends PluginLifecycleHooks>({
+  async hookSeq<H extends PluginLifecycleHooks>({
     hookName,
     parameters,
-    reduce,
-  }: {
-    hookName: H
-    parameters: PluginParameter<H>
-    reduce: (reduction: Argument0<H>, result: ReturnType<ParseResult<H>>, plugin: Plugin) => PossiblePromise<Argument0<H> | null>
-  }): Promise<Argument0<H>> {
-    const [argument0, ...rest] = parameters
-    const plugins = this.#getSortedPlugins(hookName)
-
-    let promise: Promise<Argument0<H>> = Promise.resolve(argument0)
-    for (const plugin of plugins) {
-      promise = promise
-        .then((arg0) => {
-          const value = this.#execute({
-            strategy: 'hookReduceArg0',
-            hookName,
-            parameters: [arg0, ...rest] as PluginParameter<H>,
-            plugin,
-          })
-          return value
-        })
-        .then((result) => reduce.call(this.#core.context, argument0, result as ReturnType<ParseResult<H>>, plugin)) as Promise<Argument0<H>>
-    }
-
-    return promise
-  }
-
-  /**
-   * Chains plugins
-   */
-  async hookSeq<H extends PluginLifecycleHooks>({ hookName, parameters }: { hookName: H; parameters?: PluginParameter<H> }): Promise<void> {
+    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 })
 
@@ -421,6 +407,7 @@ export class PluginManager {
           hookName,
           parameters,
           plugin,
+          message,
         })
     })
 
@@ -433,12 +420,7 @@ export class PluginManager {
     const plugins = [...this.plugins].filter((plugin) => plugin.name !== 'core')
 
     if (hookName) {
-      const containsHookName = plugins.some((item) => item[hookName])
-      if (!containsHookName) {
-        this.logger.emit('debug', { logs: [`No hook ${hookName} found`] })
-      }
-
-      return plugins.filter((item) => item[hookName])
+      return plugins.filter((plugin) => hookName in plugin)
     }
     // TODO add test case for sorting with pre/post
 
@@ -470,7 +452,7 @@ export class PluginManager {
     const [searchPluginName, searchIdentifier] = pluginKey
 
     const pluginByPluginName = plugins
-      .filter((plugin) => plugin[hookName])
+      .filter((plugin) => hookName in plugin)
       .filter((item) => {
         const [name, identifier] = item.key
 
@@ -487,14 +469,16 @@ export class PluginManager {
     if (!pluginByPluginName?.length) {
       // fallback on the core plugin when there is no match
 
-      const corePlugin = plugins.find((plugin) => plugin.name === 'core' && plugin[hookName])
+      const corePlugin = plugins.find((plugin) => plugin.name === 'core' && hookName in plugin)
 
       if (corePlugin) {
         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', {
+          date: new Date(),
           logs: [`No hook '${hookName}' for pluginKey '${JSON.stringify(pluginKey)}' found, no fallback found in the '@kubb/core' plugin`],
         })
       }
@@ -509,7 +493,7 @@ export class PluginManager {
       this.events.emit('executed', executer)
       this.executed.push(executer)
 
-      this.logger.emit('progress', { id: executer.hookName, data: `${executer.plugin.name}` })
+      this.logger.emit('progressed', { id: executer.hookName, message: `${executer.plugin.name}: ${executer.message}` })
     }
   }
 
@@ -525,11 +509,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
@@ -538,7 +524,7 @@ 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)
     })
@@ -565,6 +551,7 @@ export class PluginManager {
           strategy,
           hookName,
           plugin,
+          message,
         })
 
         return result
@@ -590,11 +577,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
@@ -603,13 +592,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.context, plugin }, parameters) as ReturnType<ParseResult<H>>
 
         output = fn
+
+        this.#addExecutedToCallStack({
+          parameters,
+          output,
+          strategy,
+          hookName,
+          plugin,
+          message,
+        })
+
         return fn
       }
 
@@ -621,6 +620,7 @@ export class PluginManager {
         strategy,
         hookName,
         plugin,
+        message,
       })
 
       return hook

package/src/PromiseManager.ts

@@ -42,7 +42,7 @@ export function isPromise<T>(result: PossiblePromise<T>): result is Promise<T> {
   return !!result && typeof (result as Promise<unknown>)?.then === 'function'
 }
 
-export function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T> {
+function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T> {
   return result.status === 'fulfilled'
 }
 

package/src/__snapshots__/barrel.json

@@ -4,25 +4,13 @@
     "baseName": "index.ts",
     "exports": [
       {
-        "name": [
-          "hello"
-        ],
-        "path": "./sub/hello.ts",
-        "extName": ".ts"
+        "path": "./sub/hello.ts"
       },
       {
-        "name": [
-          "world"
-        ],
-        "path": "./sub/world.ts",
-        "extName": ".ts"
+        "path": "./sub/world.ts"
       },
       {
-        "name": [
-          "test"
-        ],
-        "path": "./test.ts",
-        "extName": ".ts"
+        "path": "./test.ts"
       }
     ],
     "sources": [
@@ -47,26 +35,19 @@
     ],
     "id": "feabc02536bd6630458e734990f7e2a21a55c469",
     "name": "index",
-    "extName": ".ts",
-    "imports": []
+    "extname": ".ts",
+    "imports": [],
+    "meta": {}
   },
   {
     "path": "src/sub/index.ts",
     "baseName": "index.ts",
     "exports": [
       {
-        "name": [
-          "hello"
-        ],
-        "path": "./hello.ts",
-        "extName": ".ts"
+        "path": "./hello.ts"
       },
       {
-        "name": [
-          "world"
-        ],
-        "path": "./world.ts",
-        "extName": ".ts"
+        "path": "./world.ts"
       }
     ],
     "sources": [
@@ -85,7 +66,8 @@
     ],
     "id": "c67967bd2363dd9637437671f6fe1ed146debdbf",
     "name": "index",
-    "extName": ".ts",
-    "imports": []
+    "extname": ".ts",
+    "imports": [],
+    "meta": {}
   }
 ]

package/src/__snapshots__/grouped.json

@@ -18,9 +18,10 @@
                 "sources": [],
                 "id": "6af477de6b602aafbb2e1ce0011b1f411a7ab3a5",
                 "name": "file2",
-                "extName": ".ts",
+                "extname": ".ts",
                 "imports": [],
-                "exports": []
+                "exports": [],
+                "meta": {}
               },
               "path": "src/axios/file2.ts"
             },
@@ -32,9 +33,10 @@
                 "sources": [],
                 "id": "a9679944d24c174b2f2fd5b1f19c9861f1d35d0e",
                 "name": "file2",
-                "extName": ".ts",
+                "extname": ".ts",
                 "imports": [],
-                "exports": []
+                "exports": [],
+                "meta": {}
               },
               "path": "src/axios/file1.ts"
             },
@@ -50,9 +52,10 @@
                     "sources": [],
                     "id": "8beaaf5e1b1a6b89a11589c2e3dc5fd7f5eb5e8c",
                     "name": "pet",
-                    "extName": ".ts",
+                    "extname": ".ts",
                     "imports": [],
-                    "exports": []
+                    "exports": [],
+                    "meta": {}
                   },
                   "path": "src/axios/controller/pet.ts"
                 }
@@ -66,9 +69,10 @@
                 "sources": [],
                 "id": "b077038b83c1ef4050649be406937a73c1f41ad3",
                 "name": "index",
-                "extName": ".ts",
+                "extname": ".ts",
                 "imports": [],
-                "exports": []
+                "exports": [],
+                "meta": {}
               },
               "path": "src/axios/index.ts"
             }
@@ -86,9 +90,10 @@
                 "sources": [],
                 "id": "a2d277093a81a74c56c0d094071195302d6bb484",
                 "name": "test",
-                "extName": ".ts",
+                "extname": ".ts",
                 "imports": [],
-                "exports": []
+                "exports": [],
+                "meta": {}
               },
               "path": "src/controller/test.ts"
             }
@@ -102,9 +107,10 @@
             "sources": [],
             "id": "f8e2d98f76d6e33f21aa686d674544b5c7d6fa3e",
             "name": "test",
-            "extName": ".ts",
+            "extname": ".ts",
             "imports": [],
-            "exports": []
+            "exports": [],
+            "meta": {}
           },
           "path": "src/test.ts"
         }

package/src/__snapshots__/ordered.json

@@ -5,9 +5,10 @@
     "sources": [],
     "id": "f8e2d98f76d6e33f21aa686d674544b5c7d6fa3e",
     "name": "test",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   },
   {
     "path": "src/axios/file2.ts",
@@ -15,9 +16,10 @@
     "sources": [],
     "id": "6af477de6b602aafbb2e1ce0011b1f411a7ab3a5",
     "name": "file2",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   },
   {
     "path": "src/axios/file1.ts",
@@ -25,9 +27,10 @@
     "sources": [],
     "id": "a9679944d24c174b2f2fd5b1f19c9861f1d35d0e",
     "name": "file2",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   },
   {
     "path": "src/axios/index.ts",
@@ -35,9 +38,10 @@
     "sources": [],
     "id": "b077038b83c1ef4050649be406937a73c1f41ad3",
     "name": "index",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   },
   {
     "path": "src/controller/test.ts",
@@ -45,9 +49,10 @@
     "sources": [],
     "id": "a2d277093a81a74c56c0d094071195302d6bb484",
     "name": "test",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   },
   {
     "path": "src/axios/controller/pet.ts",
@@ -55,8 +60,9 @@
     "sources": [],
     "id": "8beaaf5e1b1a6b89a11589c2e3dc5fd7f5eb5e8c",
     "name": "pet",
-    "extName": ".ts",
+    "extname": ".ts",
     "imports": [],
-    "exports": []
+    "exports": [],
+    "meta": {}
   }
 ]