Progress & Event Logging Plugin

The loggerPlugin provides beautiful CLI progress bars and event logging for Fabric generation.

Use loggerPlugin when: You need visual progress feedback during file generation.

Perfect for: CLI tools, developer experience, debugging, build monitoring.

Key features:

• Beautiful CLI progress bars (@clack/prompts)
• Real-time percentage and file count

Usage

Register the logger plugin for progress tracking.

Example: Enable progress bar.

import { createFabric } from '@kubb/fabric-core'
import { loggerPlugin } from '@kubb/fabric-core/plugins'

const fabric = createFabric()

fabric.use(loggerPlugin, {
  progress: true,
})

Plugin Options

progress

Enables or disables the integrated CLI progress bar powered by @clack/prompts.

TIP

The progress bar provides real-time visual feedback during file generation.

Type:	boolean
Required:	false
Default:	true

Example:

fabric.use(loggerPlugin, {
  progress: true, // Show progress bar
})

Features

• CLI Progress Bar: Displays a beautiful progress bar with colored output and symbols using @clack/prompts.

Examples

Basic Logging

import { createFabric } from '@kubb/fabric-core'
import { loggerPlugin, fsPlugin } from '@kubb/fabric-core/plugins'
import { typescriptParser } from '@kubb/fabric-core/parsers'

const fabric = createFabric()

// Add logger first to capture all events
fabric.use(loggerPlugin, {
  progress: true,
})

fabric.use(fsPlugin, {
  clean: { path: './output' },
})

fabric.use(typescriptParser)

await fabric.addFile({
  baseName: 'api.ts',
  path: './output/api.ts',
  sources: [
    { value: 'export const API_URL = "https://api.example.com"', isExportable: true },
  ],
  imports: [],
  exports: [],
})

await fabric.write()

Disable Progress in CI

import { createFabric } from '@kubb/fabric-core'
import { loggerPlugin } from '@kubb/fabric-core/plugins'

const fabric = createFabric()

const isCI = process.env.CI === 'true'

fabric.use(loggerPlugin, {
  progress: !isCI, // Disable progress bar in CI
})

See Also

• Events — Lifecycle events reference
• createFabric — Create a Fabric instance
• fsPlugin — Write files to disk