@kubb/cli 5.0.0-alpha.8 → 5.0.0-beta.1

package/src/loggers/clackLogger.ts

@@ -2,19 +2,17 @@ import { relative } from 'node:path'
 import process from 'node:process'
 import { styleText } from 'node:util'
 import * as clack from '@clack/prompts'
-import { formatMs, formatMsWithColor, toCause } from '@internals/utils'
-import { createLogger, logLevel as logLevelMap } from '@kubb/core'
-import { getIntro } from '../utils/getIntro.ts'
+import { formatMs, formatMsWithColor, getIntro, toCause } from '@internals/utils'
+import { defineLogger, logLevel as logLevelMap } from '@kubb/core'
 import { getSummary } from '../utils/getSummary.ts'
 import { runHook } from '../utils/runHook.ts'
 import { ClackWritable } from '../utils/Writables.ts'
 import { buildProgressLine, formatCommandWithArgs, formatMessage } from './utils.ts'
 
 /**
- * Clack adapter for local TTY environments
- * Provides a beautiful CLI UI with flat structure inspired by Claude's CLI patterns
+ * TTY logger with beautiful UI and progress indicators for local development.
  */
-export const clackLogger = createLogger({
+export const clackLogger = defineLogger({
   name: 'clack',
   install(context, options) {
     const logLevel = options?.logLevel ?? logLevelMap.info
@@ -74,7 +72,7 @@ export const clackLogger = createLogger({
       state.isSpinning = false
     }
 
-    context.on('info', (message, info = '') => {
+    context.on('kubb:info', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -88,7 +86,7 @@ export const clackLogger = createLogger({
       }
     })
 
-    context.on('success', (message, info = '') => {
+    context.on('kubb:success', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -102,7 +100,7 @@ export const clackLogger = createLogger({
       }
     })
 
-    context.on('warn', (message, info) => {
+    context.on('kubb:warn', ({ message, info }) => {
       if (logLevel < logLevelMap.warn) {
         return
       }
@@ -114,7 +112,7 @@ export const clackLogger = createLogger({
       clack.log.warn(text)
     })
 
-    context.on('error', (error) => {
+    context.on('kubb:error', ({ error }) => {
       const caused = toCause(error)
 
       const text = [styleText('red', '✗'), error.message].join(' ')
@@ -143,33 +141,38 @@ export const clackLogger = createLogger({
       }
     })
 
-    context.on('version:new', (version, latestVersion) => {
+    context.on('kubb:version:new', ({ currentVersion, latestVersion }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
 
-      clack.box(
-        `\`v${version}\` → \`v${latestVersion}\`
+      try {
+        clack.box(
+          `\`v${currentVersion}\` → \`v${latestVersion}\`
 Run \`npm install -g @kubb/cli\` to update`,
-        'Update available for `Kubb`',
-        {
-          width: 'auto',
-          formatBorder: (s: string) => styleText('yellow', s),
-          rounded: true,
-          withGuide: false,
-          contentAlign: 'center',
-          titleAlign: 'center',
-        },
-      )
+          'Update available for `Kubb`',
+          {
+            width: 'auto',
+            formatBorder: (s: string) => styleText('yellow', s),
+            rounded: true,
+            withGuide: false,
+            contentAlign: 'center',
+            titleAlign: 'center',
+          },
+        )
+      } catch {
+        console.log(`Update available for Kubb: v${currentVersion} → v${latestVersion}`)
+        console.log('Run `npm install -g @kubb/cli` to update')
+      }
     })
 
-    context.on('lifecycle:start', async (version) => {
+    context.on('kubb:lifecycle:start', async ({ version }) => {
       console.log(`\n${getIntro({ title: 'The ultimate toolkit for working with APIs', description: 'Ready to start', version, areEyesOpen: true })}\n`)
 
       reset()
     })
 
-    context.on('config:start', () => {
+    context.on('kubb:config:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -180,7 +183,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       startSpinner(getMessage('Configuration loading'))
     })
 
-    context.on('config:end', (_configs) => {
+    context.on('kubb:config:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -190,7 +193,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.outro(text)
     })
 
-    context.on('generation:start', (config) => {
+    context.on('kubb:generation:start', ({ config }) => {
       reset()
 
       // Initialize progress tracking for this generation
@@ -201,7 +204,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.intro(text)
     })
 
-    context.on('plugin:start', (plugin) => {
+    context.on('kubb:plugin:start', ({ plugin }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -223,7 +226,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       state.activeProgress.set(plugin.name, { progressBar, interval })
     })
 
-    context.on('plugin:end', (plugin, { duration, success }) => {
+    context.on('kubb:plugin:end', ({ plugin, duration, success }) => {
       stopSpinner()
 
       const active = state.activeProgress.get(plugin.name)
@@ -254,7 +257,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       showProgressStep()
     })
 
-    context.on('files:processing:start', (files) => {
+    context.on('kubb:files:processing:start', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -271,12 +274,12 @@ Run \`npm install -g @kubb/cli\` to update`,
         size: 30,
       })
 
-      context.emit('info', text)
+      context.emit('kubb:info', { message: text })
       progressBar.start(getMessage(text))
       state.activeProgress.set('files', { progressBar })
     })
 
-    context.on('file:processing:update', ({ file, config }) => {
+    context.on('kubb:file:processing:update', ({ file, config }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -294,7 +297,7 @@ Run \`npm install -g @kubb/cli\` to update`,
 
       active.progressBar.advance(undefined, text)
     })
-    context.on('files:processing:end', () => {
+    context.on('kubb:files:processing:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -315,13 +318,13 @@ Run \`npm install -g @kubb/cli\` to update`,
       showProgressStep()
     })
 
-    context.on('generation:end', (config) => {
+    context.on('kubb:generation:end', ({ config }) => {
       const text = getMessage(config.name ? `Generation completed for ${styleText('dim', config.name)}` : 'Generation completed')
 
       clack.outro(text)
     })
 
-    context.on('format:start', () => {
+    context.on('kubb:format:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -331,7 +334,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.intro(text)
     })
 
-    context.on('format:end', () => {
+    context.on('kubb:format:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -341,7 +344,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.outro(text)
     })
 
-    context.on('lint:start', () => {
+    context.on('kubb:lint:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -351,7 +354,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.intro(text)
     })
 
-    context.on('lint:end', () => {
+    context.on('kubb:lint:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -361,7 +364,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.outro(text)
     })
 
-    context.on('hook:start', async ({ id, command, args }) => {
+    context.on('kubb:hook:start', async ({ id, command, args }) => {
       const commandWithArgs = formatCommandWithArgs(command, args)
       const text = getMessage(`Hook ${styleText('dim', commandWithArgs)} started`)
 
@@ -408,7 +411,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       })
     })
 
-    context.on('hook:end', ({ command, args }) => {
+    context.on('kubb:hook:end', ({ command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -419,7 +422,7 @@ Run \`npm install -g @kubb/cli\` to update`,
       clack.outro(text)
     })
 
-    context.on('generation:summary', (config, { pluginTimings, failedPlugins, filesCreated, status, hrStart }) => {
+    context.on('kubb:generation:summary', ({ config, pluginTimings, failedPlugins, filesCreated, status, hrStart }) => {
       const summary = getSummary({
         failedPlugins,
         filesCreated,
@@ -434,17 +437,21 @@ Run \`npm install -g @kubb/cli\` to update`,
       summary.push('\n')
 
       const borderColor = status === 'success' ? 'green' : 'red'
-      clack.box(summary.join('\n'), getMessage(title), {
-        width: 'auto',
-        formatBorder: (s: string) => styleText(borderColor, s),
-        rounded: true,
-        withGuide: false,
-        contentAlign: 'left',
-        titleAlign: 'center',
-      })
+      try {
+        clack.box(summary.join('\n'), getMessage(title), {
+          width: 'auto',
+          formatBorder: (s: string) => styleText(borderColor, s),
+          rounded: true,
+          withGuide: false,
+          contentAlign: 'left',
+          titleAlign: 'center',
+        })
+      } catch {
+        console.log(summary.join('\n'))
+      }
     })
 
-    context.on('lifecycle:end', () => {
+    context.on('kubb:lifecycle:end', () => {
       reset()
     })
   },

package/src/loggers/fileSystemLogger.ts

@@ -1,7 +1,7 @@
 import { relative, resolve } from 'node:path'
 import process from 'node:process'
 import { formatMs, write } from '@internals/utils'
-import { createLogger } from '@kubb/core'
+import { defineLogger } from '@kubb/core'
 
 type CachedEvent = {
   date: Date
@@ -10,13 +10,10 @@ type CachedEvent = {
 }
 
 /**
- * FileSystem logger for debug log persistence
- * Captures debug and verbose events and writes them to files in .kubb directory
- *
- * Note: Logs are written on lifecycle:end or process exit. If the process crashes
- * before these events, some cached logs may be lost.
+ * FileSystem logger that captures debug events and writes them to `.kubb` directory files.
+ * Note: Logs write on `lifecycle:end` or process exit. Cached logs may be lost if the process crashes before these events.
  */
-export const fileSystemLogger = createLogger({
+export const fileSystemLogger = defineLogger({
   name: 'filesystem',
   install(context) {
     const state = {
@@ -50,54 +47,56 @@ export const fileSystemLogger = createLogger({
         }
       }
 
-      await Promise.all(Object.entries(files).map(([fileName, logs]) => write(fileName, logs.join('\n\n'))))
+      for (const [fileName, logs] of Object.entries(files)) {
+        await write(fileName, logs.join('\n\n'))
+      }
 
       return Object.keys(files)
     }
 
-    context.on('info', (message, info) => {
+    context.on('kubb:info', ({ message, info }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`ℹ ${message} ${info}`],
       })
     })
 
-    context.on('success', (message, info) => {
+    context.on('kubb:success', ({ message, info }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`✓ ${message} ${info}`],
       })
     })
 
-    context.on('warn', (message, info) => {
+    context.on('kubb:warn', ({ message, info }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`⚠ ${message} ${info}`],
       })
     })
 
-    context.on('error', (error) => {
+    context.on('kubb:error', ({ error }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`✗ ${error.message}`, error.stack || 'unknown stack'],
       })
     })
 
-    context.on('debug', (message) => {
+    context.on('kubb:debug', (message) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: message.logs,
       })
     })
 
-    context.on('plugin:start', (plugin) => {
+    context.on('kubb:plugin:start', ({ plugin }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`Generating ${plugin.name}`],
       })
     })
 
-    context.on('plugin:end', (plugin, { duration, success }) => {
+    context.on('kubb:plugin:end', ({ plugin, duration, success }) => {
       const durationStr = formatMs(duration)
 
       state.cachedLogs.add({
@@ -106,18 +105,18 @@ export const fileSystemLogger = createLogger({
       })
     })
 
-    context.on('files:processing:start', (files) => {
+    context.on('kubb:files:processing:start', ({ files }) => {
       state.cachedLogs.add({
         date: new Date(),
         logs: [`Start ${files.length} writing:`, ...files.map((file) => file.path)],
       })
     })
 
-    context.on('generation:end', async (config) => {
+    context.on('kubb:generation:end', async ({ config }) => {
       const writtenFilePaths = await writeLogs(config.name)
       if (writtenFilePaths.length > 0) {
         const files = writtenFilePaths.map((f) => relative(process.cwd(), f))
-        await context.emit('info', 'Debug files written to:', files.join(', '))
+        await context.emit('kubb:info', { message: 'Debug files written to:', info: files.join(', ') })
       }
       reset()
     })

package/src/loggers/githubActionsLogger.ts

@@ -1,14 +1,13 @@
 import { styleText } from 'node:util'
 import { formatHrtime, formatMs, formatMsWithColor, toCause } from '@internals/utils'
-import { type Config, createLogger, logLevel as logLevelMap } from '@kubb/core'
+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 = createLogger({
+export const githubActionsLogger = defineLogger({
   name: 'github-actions',
   install(context, options) {
     const logLevel = options?.logLevel ?? logLevelMap.info
@@ -55,7 +54,7 @@ export const githubActionsLogger = createLogger({
       console.log('::endgroup::')
     }
 
-    context.on('info', (message, info = '') => {
+    context.on('kubb:info', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -65,7 +64,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('success', (message, info = '') => {
+    context.on('kubb:success', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -75,7 +74,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('warn', (message, info = '') => {
+    context.on('kubb:warn', ({ message, info = '' }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -85,7 +84,7 @@ export const githubActionsLogger = createLogger({
       console.warn(`::warning::${text}`)
     })
 
-    context.on('error', (error) => {
+    context.on('kubb:error', ({ error }) => {
       const caused = toCause(error)
 
       if (logLevel <= logLevelMap.silent) {
@@ -112,12 +111,12 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    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 +128,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('config:end', (configs) => {
+    context.on('kubb:config:end', ({ configs }) => {
       state.currentConfigs = configs
 
       if (logLevel <= logLevelMap.silent) {
@@ -143,7 +142,7 @@ export const githubActionsLogger = createLogger({
       closeGroup('Configuration')
     })
 
-    context.on('generation:start', (config) => {
+    context.on('kubb:generation:start', ({ config }) => {
       reset()
 
       // Initialize progress tracking for this generation
@@ -160,7 +159,7 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    context.on('plugin:start', (plugin) => {
+    context.on('kubb:plugin:start', ({ plugin }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -173,7 +172,7 @@ export const githubActionsLogger = createLogger({
       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 +203,7 @@ export const githubActionsLogger = createLogger({
       showProgressStep()
     })
 
-    context.on('files:processing:start', (files) => {
+    context.on('kubb:files:processing:start', ({ files }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -220,7 +219,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('files:processing:end', () => {
+    context.on('kubb:files:processing:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -236,7 +235,7 @@ export const githubActionsLogger = createLogger({
       showProgressStep()
     })
 
-    context.on('file:processing:update', () => {
+    context.on('kubb:file:processing:update', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -244,7 +243,7 @@ export const githubActionsLogger = createLogger({
       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 +251,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('format:start', () => {
+    context.on('kubb:format:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -266,7 +265,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('format:end', () => {
+    context.on('kubb:format:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -280,7 +279,7 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    context.on('lint:start', () => {
+    context.on('kubb:lint:start', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -294,7 +293,7 @@ export const githubActionsLogger = createLogger({
       console.log(text)
     })
 
-    context.on('lint:end', () => {
+    context.on('kubb:lint:end', () => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -308,7 +307,7 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    context.on('hook:start', async ({ id, command, args }) => {
+    context.on('kubb:hook:start', async ({ id, command, args }) => {
       const commandWithArgs = formatCommandWithArgs(command, args)
       const text = getMessage(`Hook ${styleText('dim', commandWithArgs)} started`)
 
@@ -338,7 +337,7 @@ export const githubActionsLogger = createLogger({
       })
     })
 
-    context.on('hook:end', ({ command, args }) => {
+    context.on('kubb:hook:end', ({ command, args }) => {
       if (logLevel <= logLevelMap.silent) {
         return
       }
@@ -353,7 +352,7 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    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,7 +372,7 @@ export const githubActionsLogger = createLogger({
       }
     })
 
-    context.on('lifecycle:end', () => {
+    context.on('kubb:lifecycle:end', () => {
       reset()
     })
   },