@kubb/cli 5.0.0-alpha.9 → 5.0.0-beta.10

package/src/loggers/githubActionsLogger.ts

@@ -1,12 +1,10 @@
 import { styleText } from 'node:util'
 import { formatHrtime, formatMs, formatMsWithColor, toCause } from '@internals/utils'
 import { type Config, defineLogger, logLevel as logLevelMap } from '@kubb/core'
-import { runHook } from '../utils/runHook.ts'
 import { buildProgressLine, formatCommandWithArgs, formatMessage } from './utils.ts'
 
 /**
- * GitHub Actions adapter for CI environments
- * Uses Github group annotations for collapsible sections
+ * GitHub Actions logger using group annotations for collapsible sections in CI.
  */
 export const githubActionsLogger = defineLogger({
   name: 'github-actions',
@@ -55,7 +53,7 @@ export const githubActionsLogger = defineLogger({
       console.log('::endgroup::')
     }
 
-    context.on('info', (message, info = '') => {
+    context.on('kubb:info', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -65,7 +63,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('success', (message, info = '') => {
+    context.on('kubb:success', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -75,7 +73,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('warn', (message, info = '') => {
+    context.on('kubb:warn', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -85,7 +83,7 @@ export const githubActionsLogger = defineLogger({
       console.warn(`::warning::${text}`)
     })
 
-    context.on('error', (error) => {
+    context.on('kubb:error', ({ error }) => {
       const caused = toCause(error)
 
       if (logLevel <= logLevelMap.silent) {
@@ -112,12 +110,12 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('lifecycle:start', (version) => {
+    context.on('kubb:lifecycle:start', ({ version }) => {
       console.log(styleText('yellow', `Kubb ${version} 🧩`))
       reset()
     })
 
-    context.on('config:start', () => {
+    context.on('kubb:config:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -129,7 +127,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('config:end', (configs) => {
+    context.on('kubb:config:end', ({ configs }) => {
       state.currentConfigs = configs
 
       if (logLevel <= logLevelMap.silent) {
@@ -143,7 +141,7 @@ export const githubActionsLogger = defineLogger({
       closeGroup('Configuration')
     })
 
-    context.on('generation:start', (config) => {
+    context.on('kubb:generation:start', ({ config }) => {
       reset()
 
       // Initialize progress tracking for this generation
@@ -160,7 +158,7 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('plugin:start', (plugin) => {
+    context.on('kubb:plugin:start', ({ plugin }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -173,7 +171,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('plugin:end', (plugin, { duration, success }) => {
+    context.on('kubb:plugin:end', ({ plugin, duration, success }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -204,7 +202,7 @@ export const githubActionsLogger = defineLogger({
       showProgressStep()
     })
 
-    context.on('files:processing:start', (files) => {
+    context.on('kubb:files:processing:start', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -220,7 +218,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('files:processing:end', () => {
+    context.on('kubb:files:processing:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -236,7 +234,7 @@ export const githubActionsLogger = defineLogger({
       showProgressStep()
     })
 
-    context.on('file:processing:update', () => {
+    context.on('kubb:file:processing:update', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -244,7 +242,7 @@ export const githubActionsLogger = defineLogger({
       state.processedFiles++
     })
 
-    context.on('generation:end', (config) => {
+    context.on('kubb:generation:end', ({ config }) => {
       const text = getMessage(
         config.name ? `${styleText('blue', '✓')} Generation completed for ${styleText('dim', config.name)}` : `${styleText('blue', '✓')} Generation completed`,
       )
@@ -252,7 +250,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('format:start', () => {
+    context.on('kubb:format:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -266,7 +264,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('format:end', () => {
+    context.on('kubb:format:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -280,7 +278,7 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('lint:start', () => {
+    context.on('kubb:lint:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -294,7 +292,7 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('lint:end', () => {
+    context.on('kubb:lint:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -308,37 +306,21 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('hook:start', async ({ id, command, args }) => {
+    context.on('kubb:hook:start', ({ command, args }) => {
+      if (logLevel <= logLevelMap.silent) {
+        return
+      }
+
       const commandWithArgs = formatCommandWithArgs(command, args)
       const text = getMessage(`Hook ${styleText('dim', commandWithArgs)} started`)
 
-      if (logLevel > logLevelMap.silent) {
-        if (state.currentConfigs.length === 1) {
-          openGroup(`Hook ${commandWithArgs}`)
-        }
-        console.log(text)
-      }
-
-      // Skip hook execution if no id is provided (e.g., during benchmarks or tests)
-      if (!id) {
-        return
+      if (state.currentConfigs.length === 1) {
+        openGroup(`Hook ${commandWithArgs}`)
       }
-
-      await runHook({
-        id,
-        command,
-        args,
-        commandWithArgs,
-        context,
-        sink: {
-          // GHA formats errors with the ::error:: annotation
-          onStdout: logLevel > logLevelMap.silent ? (s) => console.log(s) : undefined,
-          onStderr: logLevel > logLevelMap.silent ? (s) => console.error(`::error::${s}`) : undefined,
-        },
-      })
+      console.log(text)
     })
 
-    context.on('hook:end', ({ command, args }) => {
+    context.on('kubb:hook:end', ({ command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -353,7 +335,7 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('generation:summary', (config, { status, hrStart, failedPlugins }) => {
+    context.on('kubb:generation:summary', ({ config, status, hrStart, failedPlugins }) => {
       const pluginsCount = config.plugins?.length ?? 0
       const successCount = pluginsCount - failedPlugins.size
       const duration = formatHrtime(hrStart)
@@ -373,8 +355,13 @@ export const githubActionsLogger = defineLogger({
       }
     })
 
-    context.on('lifecycle:end', () => {
+    context.on('kubb:lifecycle:end', () => {
       reset()
     })
+
+    return (_commandWithArgs: string) => ({
+      onStdout: logLevel > logLevelMap.silent ? (s: string) => console.log(s) : undefined,
+      onStderr: logLevel > logLevelMap.silent ? (s: string) => console.error(`::error::${s}`) : undefined,
+    })
   },
 })

package/src/loggers/plainLogger.ts

@@ -2,13 +2,11 @@ import { relative } from 'node:path'
 import { formatMs, toCause } from '@internals/utils'
 import { defineLogger, logLevel as logLevelMap } from '@kubb/core'
 import { SUMMARY_SEPARATOR } from '../constants.ts'
-import { getSummary } from '../utils/getSummary.ts'
-import { runHook } from '../utils/runHook.ts'
+import { getSummary } from './utils.ts'
 import { formatCommandWithArgs, formatMessage } from './utils.ts'
 
 /**
- * Plain console adapter for non-TTY environments
- * Simple console.log output with indentation
+ * Plain console adapter for non-TTY environments with simple `console.log` output.
  */
 export const plainLogger = defineLogger({
   name: 'plain',
@@ -19,7 +17,7 @@ export const plainLogger = defineLogger({
       return formatMessage(message, logLevel)
     }
 
-    context.on('info', (message, info) => {
+    context.on('kubb:info', ({ message, info }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -29,7 +27,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('success', (message, info = '') => {
+    context.on('kubb:success', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -39,7 +37,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('warn', (message, info) => {
+    context.on('kubb:warn', ({ message, info }) => {
       if (logLevel < logLevelMap.warn) {
         return
       }
@@ -49,7 +47,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('error', (error) => {
+    context.on('kubb:error', ({ error }) => {
       const caused = toCause(error)
 
       const text = getMessage(['✗', error.message].join(' '))
@@ -74,11 +72,11 @@ export const plainLogger = defineLogger({
       }
     })
 
-    context.on('lifecycle:start', () => {
+    context.on('kubb:lifecycle:start', () => {
       console.log('Kubb CLI 🧩')
     })
 
-    context.on('config:start', () => {
+    context.on('kubb:config:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -88,7 +86,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('config:end', () => {
+    context.on('kubb:config:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -98,13 +96,13 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('generation:start', () => {
+    context.on('kubb:generation:start', () => {
       const text = getMessage('Generation started')
 
       console.log(text)
     })
 
-    context.on('plugin:start', (plugin) => {
+    context.on('kubb:plugin:start', ({ plugin }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -113,7 +111,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('plugin:end', (plugin, { duration, success }) => {
+    context.on('kubb:plugin:end', ({ plugin, duration, success }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -124,7 +122,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('files:processing:start', (files) => {
+    context.on('kubb:files:processing:start', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -134,7 +132,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('file:processing:update', ({ file, config }) => {
+    context.on('kubb:file:processing:update', ({ file, config }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -144,7 +142,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('files:processing:end', () => {
+    context.on('kubb:files:processing:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -154,13 +152,13 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('generation:end', (config) => {
+    context.on('kubb:generation:end', ({ config }) => {
       const text = getMessage(config.name ? `Generation completed for ${config.name}` : 'Generation completed')
 
       console.log(text)
     })
 
-    context.on('format:start', () => {
+    context.on('kubb:format:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -170,7 +168,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('format:end', () => {
+    context.on('kubb:format:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -180,7 +178,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('lint:start', () => {
+    context.on('kubb:lint:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -190,7 +188,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('lint:end', () => {
+    context.on('kubb:lint:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -200,33 +198,18 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('hook:start', async ({ id, command, args }) => {
-      const commandWithArgs = formatCommandWithArgs(command, args)
-      const text = getMessage(`Hook ${commandWithArgs} started`)
-
-      if (logLevel > logLevelMap.silent) {
-        console.log(text)
-      }
-
-      // Skip hook execution if no id is provided (e.g., during benchmarks or tests)
-      if (!id) {
+    context.on('kubb:hook:start', ({ command, args }) => {
+      if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      await runHook({
-        id,
-        command,
-        args,
-        commandWithArgs,
-        context,
-        sink: {
-          onStdout: logLevel > logLevelMap.silent ? (s) => console.log(s) : undefined,
-          onStderr: logLevel > logLevelMap.silent ? (s) => console.error(s) : undefined,
-        },
-      })
+      const commandWithArgs = formatCommandWithArgs(command, args)
+      const text = getMessage(`Hook ${commandWithArgs} started`)
+
+      console.log(text)
     })
 
-    context.on('hook:end', ({ command, args }) => {
+    context.on('kubb:hook:end', ({ command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -237,7 +220,7 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('generation:summary', (config, { pluginTimings, status, hrStart, failedPlugins, filesCreated }) => {
+    context.on('kubb:generation:summary', ({ config, pluginTimings, status, hrStart, failedPlugins, filesCreated }) => {
       const summary = getSummary({
         failedPlugins,
         filesCreated,
@@ -251,5 +234,10 @@ export const plainLogger = defineLogger({
       console.log(summary.join('\n'))
       console.log(SUMMARY_SEPARATOR)
     })
+
+    return (_commandWithArgs: string) => ({
+      onStdout: logLevel > logLevelMap.silent ? (s: string) => console.log(s) : undefined,
+      onStderr: logLevel > logLevelMap.silent ? (s: string) => console.error(s) : undefined,
+    })
   },
 })

package/src/loggers/types.ts

@@ -1 +1,7 @@
+/**
+ * Logger adapter selected by `setupLogger` based on the runtime environment.
+ * - `'clack'`: TTY-aware output with spinners and progress bars.
+ * - `'github-actions'`: CI output using `::group::` annotations.
+ * - `'plain'`: Plain `console.log` output for non-TTY environments.
+ */
 export type LoggerType = 'clack' | 'github-actions' | 'plain'

package/src/loggers/utils.ts

@@ -1,13 +1,57 @@
+import path from 'node:path'
 import { styleText } from 'node:util'
-import { canUseTTY, formatHrtime, isGitHubActions } from '@internals/utils'
-import type { Logger, LoggerContext, LoggerOptions } from '@kubb/core'
+import { canUseTTY, formatHrtime, isGitHubActions, randomCliColor } from '@internals/utils'
+import type { Config, Logger, LoggerContext, LoggerOptions, Plugin } from '@kubb/core'
 import { logLevel as logLevelMap } from '@kubb/core'
+import { SUMMARY_MAX_BAR_LENGTH, SUMMARY_TIME_SCALE_DIVISOR } from '../constants.ts'
 import { clackLogger } from './clackLogger.ts'
 import { fileSystemLogger } from './fileSystemLogger.ts'
 import { githubActionsLogger } from './githubActionsLogger.ts'
 import { plainLogger } from './plainLogger.ts'
 import type { LoggerType } from './types.ts'
 
+/**
+ * Output sink for a hook subprocess, controlling how streamed lines and exit output are forwarded.
+ */
+type HookOutputSink = {
+  /**
+   * Called for each streamed stdout line while the hook runs.
+   */
+  onLine?: (line: string) => void
+  /**
+   * Called with stderr content after the hook exits with a non-zero code.
+   */
+  onStderr?: (text: string) => void
+  /**
+   * Called with stdout content after the hook exits with a non-zero code.
+   */
+  onStdout?: (text: string) => void
+}
+
+/**
+ * Output sink combined with stream control for a hook subprocess.
+ */
+export type HookSinkOptions = HookOutputSink & {
+  /**
+   * When `true`, streams process output line-by-line via `onLine`.
+   *
+   * @default false
+   */
+  stream?: boolean
+}
+
+/**
+ * Factory called once per hook command to build the output sink and streaming flag.
+ * The function should set up any logger UI (e.g., spinner) and return callbacks that forward subprocess output to it.
+ */
+export type HookSinkFactory = (commandWithArgs: string) => HookSinkOptions | undefined
+
+/**
+ * Logger variant that may return a {@link HookSinkFactory} from `install`.
+ * The factory is forwarded to hook execution so the logger controls subprocess output routing.
+ */
+type CLILogger = Logger<LoggerOptions, HookSinkFactory | void>
+
 /**
  * Optionally prefix a message with a [HH:MM:SS] timestamp when logLevel >= verbose.
  * Shared across all logger adapters to avoid duplication.
@@ -26,11 +70,29 @@ export function formatMessage(message: string, logLevel: number): string {
 }
 
 type ProgressState = {
+  /**
+   * Total number of plugins scheduled for this generation run.
+   */
   totalPlugins: number
+  /**
+   * Number of plugins that have finished without error.
+   */
   completedPlugins: number
+  /**
+   * Number of plugins that exited with an error.
+   */
   failedPlugins: number
+  /**
+   * Total number of files expected to be written.
+   */
   totalFiles: number
+  /**
+   * Number of files written so far.
+   */
   processedFiles: number
+  /**
+   * `process.hrtime()` snapshot taken at the start of generation, used to compute elapsed time.
+   */
   hrStart: [number, number]
 }
 
@@ -80,27 +142,111 @@ function detectLogger(): LoggerType {
   return 'plain'
 }
 
-const logMapper = {
+const logMapper: Record<LoggerType, CLILogger> = {
   clack: clackLogger,
   plain: plainLogger,
   'github-actions': githubActionsLogger,
-} as const satisfies Record<LoggerType, Logger>
+}
 
-export async function setupLogger(context: LoggerContext, { logLevel }: LoggerOptions): Promise<void> {
+export async function setupLogger(context: LoggerContext, { logLevel }: LoggerOptions): Promise<HookSinkFactory | undefined> {
   const type = detectLogger()
 
-  const logger = logMapper[type] as Logger
+  const logger = logMapper[type]
 
   if (!logger) {
     throw new Error(`Unknown adapter type: ${type}`)
   }
 
-  // Install primary logger
-  const cleanup = await logger.install(context, { logLevel })
+  const makeSink = await logger.install(context, { logLevel })
 
   if (logLevel >= logLevelMap.debug) {
     await fileSystemLogger.install(context, { logLevel })
   }
 
-  return cleanup
+  return typeof makeSink === 'function' ? makeSink : undefined
+}
+
+type SummaryProps = {
+  /**
+   * Set of plugins that failed during this generation run, each with its error.
+   */
+  failedPlugins: Set<{ plugin: Plugin; error: Error }>
+  /**
+   * Overall generation status used to choose success or failure formatting.
+   */
+  status: 'success' | 'failed'
+  /**
+   * `process.hrtime()` snapshot taken at the start of generation, used to compute elapsed time.
+   */
+  hrStart: [number, number]
+  /**
+   * Total number of files written during this generation run.
+   */
+  filesCreated: number
+  /**
+   * Resolved Kubb config for this generation entry, used to read plugin count and output path.
+   */
+  config: Config
+  /**
+   * Per-plugin timing map (plugin name → duration in ms). When provided, a timing bar chart is appended.
+   */
+  pluginTimings?: Map<string, number>
+}
+
+/**
+ * Builds the generation summary lines rendered in the end-of-run box.
+ * Returns an array of styled strings, one per summary row.
+ */
+export function getSummary({ failedPlugins, filesCreated, status, hrStart, config, pluginTimings }: SummaryProps): string[] {
+  const duration = formatHrtime(hrStart)
+
+  const pluginsCount = config.plugins?.length ?? 0
+  const successCount = pluginsCount - failedPlugins.size
+
+  const meta = {
+    plugins:
+      status === 'success'
+        ? `${styleText('green', `${successCount} successful`)}, ${pluginsCount} total`
+        : `${styleText('green', `${successCount} successful`)}, ${styleText('red', `${failedPlugins.size} failed`)}, ${pluginsCount} total`,
+    pluginsFailed: status === 'failed' ? [...failedPlugins].map(({ plugin }) => randomCliColor(plugin.name)).join(', ') : undefined,
+    filesCreated,
+    time: styleText('green', duration),
+    output: path.resolve(config.root, config.output.path),
+  } as const
+
+  const labels = {
+    plugins: 'Plugins:',
+    failed: 'Failed:',
+    generated: 'Generated:',
+    pluginTimings: 'Plugin Timings:',
+    output: 'Output:',
+  }
+  const maxLength = Math.max(0, ...[...Object.values(labels), ...(pluginTimings ? Array.from(pluginTimings.keys()) : [])].map((s) => s.length))
+
+  const summaryLines: string[] = []
+  summaryLines.push(`${labels.plugins.padEnd(maxLength + 2)} ${meta.plugins}`)
+
+  if (meta.pluginsFailed) {
+    summaryLines.push(`${labels.failed.padEnd(maxLength + 2)} ${meta.pluginsFailed}`)
+  }
+
+  summaryLines.push(`${labels.generated.padEnd(maxLength + 2)} ${meta.filesCreated} files in ${meta.time}`)
+
+  if (pluginTimings && pluginTimings.size > 0) {
+    const sortedTimings = Array.from(pluginTimings.entries()).sort((a, b) => b[1] - a[1])
+
+    summaryLines.push(`${labels.pluginTimings}`)
+
+    sortedTimings.forEach(([name, time]) => {
+      const timeStr = time >= 1000 ? `${(time / 1000).toFixed(2)}s` : `${Math.round(time)}ms`
+      const barLength = Math.min(Math.ceil(time / SUMMARY_TIME_SCALE_DIVISOR), SUMMARY_MAX_BAR_LENGTH)
+      const bar = styleText('dim', '█'.repeat(barLength))
+
+      summaryLines.push(`${styleText('dim', '•')} ${name.padEnd(maxLength + 1)}${bar} ${timeStr}`)
+    })
+  }
+
+  summaryLines.push(`${labels.output.padEnd(maxLength + 2)} ${meta.output}`)
+
+  return summaryLines
 }