@kubb/cli 5.0.0-beta.29 → 5.0.0-beta.30

package/src/loggers/githubActionsLogger.ts

@@ -1,8 +1,15 @@
-import process from 'node:process'
 import { styleText } from 'node:util'
-import { formatHrtime, formatMs, formatMsWithColor, getElapsedMs, toCause } from '@internals/utils'
-import { type Config, defineLogger, logLevel as logLevelMap } from '@kubb/core'
-import { buildProgressLine, formatCommandWithArgs, formatMessage } from './utils.ts'
+import { formatHrtime, formatMs, formatMsWithColor, toCause } from '@internals/utils'
+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,27 +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>,
-      hookStarts: new Map<string, [number, number]>(),
       openGroupDepth: 0,
     }
+    const hookTimer = createHookTimer()
 
     function reset() {
       closeAllGroups()
-      state.totalPlugins = 0
-      state.completedPlugins = 0
-      state.failedPlugins = 0
-      state.totalFiles = 0
-      state.processedFiles = 0
-      state.hrStart = process.hrtime()
+      resetProgressCounters(state)
       state.currentConfigs = []
-      state.hookStarts.clear()
+      hookTimer.clear()
     }
 
     function showProgressStep() {
@@ -67,6 +64,32 @@ export const githubActionsLogger = defineLogger({
       }
     }
 
+    // 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 = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
@@ -198,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(
@@ -272,85 +291,12 @@ 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)
-    })
-
-    context.on('kubb:format:end', () => {
-      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
-      }
-
-      const text = getMessage('Lint started')
-
-      if (state.currentConfigs.length === 1) {
-        openGroup('Linting')
-      }
-
-      console.log(text)
-    })
-
-    context.on('kubb:lint:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Lint completed')
-
-      console.log(text)
-
-      if (state.currentConfigs.length === 1) {
-        closeGroup('Linting')
-      }
-    })
-
-    context.on('kubb:hooks:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      if (state.currentConfigs.length === 1) {
-        openGroup('Hooks')
-      }
-
-      console.log(getMessage('Hooks started'))
-    })
-
-    context.on('kubb:hooks:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      console.log(getMessage('Hooks completed'))
-
-      if (state.currentConfigs.length === 1) {
-        closeGroup('Hooks')
-      }
-    })
+    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:hook:start', ({ id, command, args }) => {
       if (logLevel <= logLevelMap.silent) {
@@ -358,7 +304,7 @@ export const githubActionsLogger = defineLogger({
       }
 
       if (id) {
-        state.hookStarts.set(id, process.hrtime())
+        hookTimer.start(id)
       }
 
       const commandWithArgs = formatCommandWithArgs(command, args)
@@ -375,9 +321,8 @@ export const githubActionsLogger = defineLogger({
         return
       }
 
-      const hrStart = id ? state.hookStarts.get(id) : undefined
-      if (id) state.hookStarts.delete(id)
-      const durationStr = hrStart ? ` in ${formatMsWithColor(getElapsedMs(hrStart))}` : ''
+      const ms = id ? hookTimer.end(id) : undefined
+      const durationStr = ms !== undefined ? ` in ${formatMsWithColor(ms)}` : ''
 
       const commandWithArgs = formatCommandWithArgs(command, args)
 

package/src/loggers/plainLogger.ts

@@ -1,10 +1,9 @@
 import { relative } from 'node:path'
-import process from 'node:process'
-import { formatMs, getElapsedMs, toCause } from '@internals/utils'
-import { defineLogger, logLevel as logLevelMap } from '@kubb/core'
+import { formatMs, toCause } from '@internals/utils'
+import { defineLogger, type KubbHooks, logLevel as logLevelMap } from '@kubb/core'
 import { SUMMARY_SEPARATOR } from '../constants.ts'
 import { getSummary } from './utils.ts'
-import { formatCommandWithArgs, formatMessage } from './utils.ts'
+import { createHookTimer, formatCommandWithArgs, formatMessage } from './utils.ts'
 
 /**
  * Plain console adapter for non-TTY environments with simple `console.log` output.
@@ -13,12 +12,22 @@ export const plainLogger = defineLogger({
   name: 'plain',
   install(context, options) {
     const logLevel = options?.logLevel ?? logLevelMap.info
-    const hookStarts = new Map<string, [number, number]>()
+    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
@@ -86,25 +95,8 @@ export const plainLogger = defineLogger({
       console.log(getMessage(`Update available: v${currentVersion} → v${latestVersion}. Run \`npm install -g @kubb/cli\` to update.`))
     })
 
-    context.on('kubb:config:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Configuration started')
-
-      console.log(text)
-    })
-
-    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')
@@ -168,61 +160,12 @@ export const plainLogger = defineLogger({
       console.log(text)
     })
 
-    context.on('kubb:format:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Format started')
-
-      console.log(text)
-    })
-
-    context.on('kubb:format:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Format completed')
-
-      console.log(text)
-    })
-
-    context.on('kubb:lint:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Lint started')
-
-      console.log(text)
-    })
-
-    context.on('kubb:lint:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      const text = getMessage('Lint completed')
-
-      console.log(text)
-    })
-
-    context.on('kubb:hooks:start', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      console.log(getMessage('Hooks started'))
-    })
-
-    context.on('kubb:hooks:end', () => {
-      if (logLevel <= logLevelMap.silent) {
-        return
-      }
-
-      console.log(getMessage('Hooks completed'))
-    })
+    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')
 
     context.on('kubb:hook:start', ({ id, command, args }) => {
       if (logLevel <= logLevelMap.silent) {
@@ -230,7 +173,7 @@ export const plainLogger = defineLogger({
       }
 
       if (id) {
-        hookStarts.set(id, process.hrtime())
+        hookTimer.start(id)
       }
 
       const commandWithArgs = formatCommandWithArgs(command, args)
@@ -242,9 +185,8 @@ export const plainLogger = defineLogger({
         return
       }
 
-      const hrStart = id ? hookStarts.get(id) : undefined
-      if (id) hookStarts.delete(id)
-      const durationStr = hrStart ? ` in ${formatMs(getElapsedMs(hrStart))}` : ''
+      const ms = id ? hookTimer.end(id) : undefined
+      const durationStr = ms !== undefined ? ` in ${formatMs(ms)}` : ''
 
       const commandWithArgs = formatCommandWithArgs(command, args)
 

package/src/loggers/utils.ts

@@ -1,6 +1,7 @@
 import path from 'node:path'
+import process from 'node:process'
 import { styleText } from 'node:util'
-import { canUseTTY, formatHrtime, isGitHubActions, randomCliColor } from '@internals/utils'
+import { canUseTTY, formatHrtime, getElapsedMs, 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'
@@ -127,6 +128,80 @@ export function buildProgressLine(state: ProgressState): string | null {
   return parts.join(styleText('dim', ' | '))
 }
 
+/**
+ * Creates the per-run progress counters shared by the clack and GitHub Actions loggers.
+ */
+export function createProgressCounters(): ProgressState {
+  return {
+    totalPlugins: 0,
+    completedPlugins: 0,
+    failedPlugins: 0,
+    totalFiles: 0,
+    processedFiles: 0,
+    hrStart: process.hrtime(),
+  }
+}
+
+/**
+ * Resets the progress counters in place at the start/end of a generation run.
+ */
+export function resetProgressCounters(state: ProgressState): void {
+  state.totalPlugins = 0
+  state.completedPlugins = 0
+  state.failedPlugins = 0
+  state.totalFiles = 0
+  state.processedFiles = 0
+  state.hrStart = process.hrtime()
+}
+
+/**
+ * Records a finished plugin against the progress counters.
+ */
+export function recordPluginResult(state: ProgressState, success: boolean): void {
+  if (success) {
+    state.completedPlugins++
+  } else {
+    state.failedPlugins++
+  }
+}
+
+/**
+ * Tracks per-hook start times so a logger can report a hook's elapsed duration.
+ * Used by the loggers that key timing by hook `id` (GitHub Actions, plain).
+ */
+export type HookTimer = {
+  start(id: string): void
+  /**
+   * Returns the elapsed milliseconds since `start(id)`, or `undefined` when no start was recorded.
+   */
+  end(id: string): number | undefined
+  clear(): void
+}
+
+/**
+ * Creates a {@link HookTimer} backed by a private `id → hrtime` map.
+ */
+export function createHookTimer(): HookTimer {
+  const starts = new Map<string, [number, number]>()
+
+  return {
+    start(id: string): void {
+      starts.set(id, process.hrtime())
+    },
+    end(id: string): number | undefined {
+      const hrStart = starts.get(id)
+      if (!hrStart) {
+        return undefined
+      }
+      starts.delete(id)
+      return getElapsedMs(hrStart)
+    },
+    clear(): void {
+      starts.clear()
+    },
+  }
+}
+
 /**
  * Join a command and its optional args into a single display string.
  * e.g. ("prettier", ["--write", "."]) → "prettier --write ."

package/dist/package-DlcR7TDy.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"package-DlcR7TDy.cjs","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/package-DmWpQ3SY.js

@@ -1,6 +0,0 @@
-//#region package.json
-var version = "5.0.0-beta.29";
-//#endregion
-export { version as t };
-
-//# sourceMappingURL=package-DmWpQ3SY.js.map

package/dist/package-DmWpQ3SY.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"package-DmWpQ3SY.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}