@kubb/cli 5.0.0-beta.3 → 5.0.0-beta.31

package/src/loggers/githubActionsLogger.ts

@@ -1,8 +1,15 @@
 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'
+import { type Config, defineLogger, type KubbHooks, logLevel as logLevelMap } from '@kubb/core'
+import {
+  buildProgressLine,
+  createHookTimer,
+  createProgressCounters,
+  formatCommandWithArgs,
+  formatMessage,
+  recordPluginResult,
+  resetProgressCounters,
+} from './utils.ts'
 
 /**
  * GitHub Actions logger using group annotations for collapsible sections in CI.
@@ -12,23 +19,17 @@ export const githubActionsLogger = defineLogger({
   install(context, options) {
     const logLevel = options?.logLevel ?? logLevelMap.info
     const state = {
-      totalPlugins: 0,
-      completedPlugins: 0,
-      failedPlugins: 0,
-      totalFiles: 0,
-      processedFiles: 0,
-      hrStart: process.hrtime(),
+      ...createProgressCounters(),
       currentConfigs: [] as Array<Config>,
+      openGroupDepth: 0,
     }
+    const hookTimer = createHookTimer()
 
     function reset() {
-      state.totalPlugins = 0
-      state.completedPlugins = 0
-      state.failedPlugins = 0
-      state.totalFiles = 0
-      state.processedFiles = 0
-      state.hrStart = process.hrtime()
+      closeAllGroups()
+      resetProgressCounters(state)
       state.currentConfigs = []
+      hookTimer.clear()
     }
 
     function showProgressStep() {
@@ -48,10 +49,45 @@ export const githubActionsLogger = defineLogger({
 
     function openGroup(name: string) {
       console.log(`::group::${name}`)
+      state.openGroupDepth++
     }
 
     function closeGroup(_name: string) {
       console.log('::endgroup::')
+      if (state.openGroupDepth > 0) state.openGroupDepth--
+    }
+
+    function closeAllGroups() {
+      while (state.openGroupDepth > 0) {
+        console.log('::endgroup::')
+        state.openGroupDepth--
+      }
+    }
+
+    // Opens a group (only for single-config runs) then logs the step message.
+    function onGroupStart<E extends keyof KubbHooks>(event: E, message: string, group: string): void {
+      context.on(event, () => {
+        if (logLevel <= logLevelMap.silent) {
+          return
+        }
+        if (state.currentConfigs.length === 1) {
+          openGroup(group)
+        }
+        console.log(getMessage(message))
+      })
+    }
+
+    // Logs the step message then closes the matching group (single-config runs).
+    function onGroupEnd<E extends keyof KubbHooks>(event: E, message: string, group: string): void {
+      context.on(event, () => {
+        if (logLevel <= logLevelMap.silent) {
+          return
+        }
+        console.log(getMessage(message))
+        if (state.currentConfigs.length === 1) {
+          closeGroup(group)
+        }
+      })
     }
 
     context.on('kubb:info', ({ message, info = '' }) => {
@@ -87,6 +123,10 @@ export const githubActionsLogger = defineLogger({
     context.on('kubb:error', ({ error }) => {
       const caused = toCause(error)
 
+      // Always release any unclosed groups so a thrown :start without a matching :end
+      // (e.g., when getConfigs or kubb.setup throws) doesn't leak an open section.
+      closeAllGroups()
+
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -116,6 +156,10 @@ export const githubActionsLogger = defineLogger({
       reset()
     })
 
+    context.on('kubb:version:new', ({ currentVersion, latestVersion }) => {
+      console.log(`::notice::Update available for Kubb: v${currentVersion} → v${latestVersion}. Run \`npm install -g @kubb/cli\` to update.`)
+    })
+
     context.on('kubb:config:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
@@ -177,11 +221,7 @@ export const githubActionsLogger = defineLogger({
         return
       }
 
-      if (success) {
-        state.completedPlugins++
-      } else {
-        state.failedPlugins++
-      }
+      recordPluginResult(state, success)
 
       const durationStr = formatMsWithColor(duration)
       const text = getMessage(
@@ -235,12 +275,12 @@ export const githubActionsLogger = defineLogger({
       showProgressStep()
     })
 
-    context.on('kubb:file:processing:update', () => {
+    context.on('kubb:files:processing:update', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      state.processedFiles++
+      state.processedFiles += files.length
     })
 
     context.on('kubb:generation:end', ({ config }) => {
@@ -251,102 +291,48 @@ export const githubActionsLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('kubb:format:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Format started')
-
-      if (state.currentConfigs.length === 1) {
-        openGroup('Formatting')
-      }
-
-      console.log(text)
-    })
+    onGroupStart('kubb:format:start', 'Format started', 'Formatting')
+    onGroupEnd('kubb:format:end', 'Format completed', 'Formatting')
+    onGroupStart('kubb:lint:start', 'Lint started', 'Linting')
+    onGroupEnd('kubb:lint:end', 'Lint completed', 'Linting')
+    onGroupStart('kubb:hooks:start', 'Hooks started', 'Hooks')
+    onGroupEnd('kubb:hooks:end', 'Hooks completed', 'Hooks')
 
-    context.on('kubb:format:end', () => {
+    context.on('kubb:hook:start', ({ id, command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage('Format completed')
-
-      console.log(text)
-
-      if (state.currentConfigs.length === 1) {
-        closeGroup('Formatting')
-      }
-    })
-
-    context.on('kubb:lint:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
+      if (id) {
+        hookTimer.start(id)
       }
 
-      const text = getMessage('Lint started')
+      const commandWithArgs = formatCommandWithArgs(command, args)
+      const text = getMessage(`Hook ${styleText('dim', commandWithArgs)} started`)
 
       if (state.currentConfigs.length === 1) {
-        openGroup('Linting')
+        openGroup(`Hook ${commandWithArgs}`)
       }
-
       console.log(text)
     })
 
-    context.on('kubb:lint:end', () => {
+    context.on('kubb:hook:end', ({ id, command, args, success, error }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage('Lint completed')
-
-      console.log(text)
-
-      if (state.currentConfigs.length === 1) {
-        closeGroup('Linting')
-      }
-    })
+      const ms = id ? hookTimer.end(id) : undefined
+      const durationStr = ms !== undefined ? ` in ${formatMsWithColor(ms)}` : ''
 
-    context.on('kubb:hook:start', async ({ id, command, args }) => {
       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
-      }
-
-      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,
-        },
-      })
-    })
-
-    context.on('kubb:hook:end', ({ command, args }) => {
-      if (logLevel <= logLevelMap.silent) {
-        return
+      if (success) {
+        console.log(getMessage(`${styleText('green', '✓')} Hook ${styleText('dim', commandWithArgs)} completed${durationStr}`))
+      } else {
+        const reason = error?.message ? ` (${error.message})` : ''
+        console.log(`::error::Hook ${commandWithArgs} failed${durationStr}${reason}`)
       }
 
-      const commandWithArgs = formatCommandWithArgs(command, args)
-      const text = getMessage(`Hook ${styleText('dim', commandWithArgs)} completed`)
-
-      console.log(text)
-
       if (state.currentConfigs.length === 1) {
         closeGroup(`Hook ${commandWithArgs}`)
       }
@@ -375,5 +361,10 @@ export const githubActionsLogger = defineLogger({
     context.on('kubb:lifecycle:end', () => {
       reset()
     })
+
+    return (_commandWithArgs: string, _hookId: 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

@@ -1,10 +1,9 @@
 import { relative } from 'node:path'
 import { formatMs, toCause } from '@internals/utils'
-import { defineLogger, logLevel as logLevelMap } from '@kubb/core'
+import { defineLogger, type KubbHooks, 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 { formatCommandWithArgs, formatMessage } from './utils.ts'
+import { getSummary } from './utils.ts'
+import { createHookTimer, formatCommandWithArgs, formatMessage } from './utils.ts'
 
 /**
  * Plain console adapter for non-TTY environments with simple `console.log` output.
@@ -13,11 +12,22 @@ export const plainLogger = defineLogger({
   name: 'plain',
   install(context, options) {
     const logLevel = options?.logLevel ?? logLevelMap.info
+    const hookTimer = createHookTimer()
 
     function getMessage(message: string): string {
       return formatMessage(message, logLevel)
     }
 
+    // Registers a handler that logs a fixed message, skipped at silent level.
+    function onStep<E extends keyof KubbHooks>(event: E, message: string): void {
+      context.on(event, () => {
+        if (logLevel <= logLevelMap.silent) {
+          return
+        }
+        console.log(getMessage(message))
+      })
+    }
+
     context.on('kubb:info', ({ message, info }) => {
       if (logLevel <= logLevelMap.silent) {
         return
@@ -73,29 +83,20 @@ export const plainLogger = defineLogger({
       }
     })
 
-    context.on('kubb:lifecycle:start', () => {
-      console.log('Kubb CLI 🧩')
+    context.on('kubb:lifecycle:start', ({ version }) => {
+      console.log(`Kubb CLI v${version}`)
     })
 
-    context.on('kubb:config:start', () => {
+    context.on('kubb:version:new', ({ currentVersion, latestVersion }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage('Configuration started')
-
-      console.log(text)
+      console.log(getMessage(`Update available: v${currentVersion} → v${latestVersion}. Run \`npm install -g @kubb/cli\` to update.`))
     })
 
-    context.on('kubb:config:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Configuration completed')
-
-      console.log(text)
-    })
+    onStep('kubb:config:start', 'Configuration started')
+    onStep('kubb:config:end', 'Configuration completed')
 
     context.on('kubb:generation:start', () => {
       const text = getMessage('Generation started')
@@ -133,14 +134,14 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('kubb:file:processing:update', ({ file, config }) => {
+    context.on('kubb:files:processing:update', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage(`Writing ${relative(config.root, file.path)}`)
-
-      console.log(text)
+      for (const { file, config } of files) {
+        console.log(getMessage(`Writing ${relative(config.root, file.path)}`))
+      }
     })
 
     context.on('kubb:files:processing:end', () => {
@@ -159,81 +160,42 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('kubb:format:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Format started')
+    onStep('kubb:format:start', 'Format started')
+    onStep('kubb:format:end', 'Format completed')
+    onStep('kubb:lint:start', 'Lint started')
+    onStep('kubb:lint:end', 'Lint completed')
+    onStep('kubb:hooks:start', 'Hooks started')
+    onStep('kubb:hooks:end', 'Hooks completed')
 
-      console.log(text)
-    })
-
-    context.on('kubb:format:end', () => {
+    context.on('kubb:hook:start', ({ id, command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage('Format completed')
-
-      console.log(text)
-    })
-
-    context.on('kubb:lint:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
+      if (id) {
+        hookTimer.start(id)
       }
 
-      const text = getMessage('Lint started')
-
-      console.log(text)
+      const commandWithArgs = formatCommandWithArgs(command, args)
+      console.log(getMessage(`Hook ${commandWithArgs} started`))
     })
 
-    context.on('kubb:lint:end', () => {
+    context.on('kubb:hook:end', ({ id, command, args, success, error }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      const text = getMessage('Lint completed')
+      const ms = id ? hookTimer.end(id) : undefined
+      const durationStr = ms !== undefined ? ` in ${formatMs(ms)}` : ''
 
-      console.log(text)
-    })
-
-    context.on('kubb: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) {
-        return
+      if (success) {
+        console.log(getMessage(`✓ Hook ${commandWithArgs} completed${durationStr}`))
+      } else {
+        const reason = error?.message ? ` (${error.message})` : ''
+        console.log(getMessage(`✗ Hook ${commandWithArgs} failed${durationStr}${reason}`))
       }
-
-      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,
-        },
-      })
-    })
-
-    context.on('kubb:hook:end', ({ command, args }) => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const commandWithArgs = formatCommandWithArgs(command, args)
-      const text = getMessage(`Hook ${commandWithArgs} completed`)
-
-      console.log(text)
     })
 
     context.on('kubb:generation:summary', ({ config, pluginTimings, status, hrStart, failedPlugins, filesCreated }) => {
@@ -250,5 +212,10 @@ export const plainLogger = defineLogger({
       console.log(summary.join('\n'))
       console.log(SUMMARY_SEPARATOR)
     })
+
+    return (_commandWithArgs: string, _hookId: 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'