Class Logger

Simple Logger utility for consistent CLI output. Supports multiple log levels and configuration.

Index

Constructors

Properties

Constructors

constructor

new Logger(): Logger
Returns Logger

Properties

`Private`config

config: LoggerConfig = ...

Methods

configure

configure(
    config: Partial<Omit<LoggerConfig, "icons" | "colors">> & {
        icons?: Partial<LoggerIcons>;
        colors?: Partial<LoggerColors>;
    },
): void
Configure the logger with partial settings.
Parameters
- config: Partial<Omit<LoggerConfig, "icons" | "colors">> & {
  icons?: Partial<LoggerIcons>;
  colors?: Partial<LoggerColors>;
  }
Returns void
- Defined in src/utils/logger.ts:89

setLevel

setLevel(level: LogLevel): void
Set the current log level.
Parameters
- level: LogLevel
Returns void
- Defined in src/utils/logger.ts:106

getLevel

getLevel(): LogLevel
Get the current log level.

Returns LogLevel
- Defined in src/utils/logger.ts:113

isSilent

isSilent(): boolean
Check if logger is in silent mode.

Returns boolean
- Defined in src/utils/logger.ts:120

resolveLogLevel

resolveLogLevel(
options: { silent?: boolean; debug?: boolean; logLevel?: string },
currentLevel: LogLevel,
): LogLevel
Resolves the log level based on CLI options and current configuration. Priority: Silent > Debug > LogLevel Option > Current Level
Parameters
- options: { silent?: boolean; debug?: boolean; logLevel?: string }
- currentLevel: LogLevel
Returns LogLevel
- Defined in src/utils/logger.ts:128

`Private`getTimestamp

getTimestamp(): string
Returns string
- Defined in src/utils/logger.ts:145

style

style(
message: string,
options?: { color?: StyleColorName; bold?: boolean; hex?: string },
): string
Apply styling to a message (color, bold, hex).
Parameters
- message: string
  Text to style
- Optionaloptions: { color?: StyleColorName; bold?: boolean; hex?: string }
  Styling options
Returns string
Styled string with ANSI codes
- Defined in src/utils/logger.ts:155

bold

bold(message: string): string
Apply bold styling to a message.
Parameters
- message: string
  Text to make bold
Returns string
Bold string with ANSI codes
- Defined in src/utils/logger.ts:171

heading

heading(
message: string,
options?: { color?: StyleColorName; hex?: string },
): string
Format a heading (bold + color).
Parameters
- message: string
  Heading text
- Optionaloptions: { color?: StyleColorName; hex?: string }
  Color options (default: blue)
Returns string
Styled heading string
- Defined in src/utils/logger.ts:181

label

label(message: string): string
Format a label (yellow text).
Parameters
- message: string
  Label text
Returns string
Yellow-styled string
- Defined in src/utils/logger.ts:194

notice

notice(message: string): string
Format a notice (yellow text, alias for label).
Parameters
- message: string
  Notice text
Returns string
Yellow-styled string
- Defined in src/utils/logger.ts:203

muted

muted(message: string): string
Format muted/secondary text (gray).
Parameters
- message: string
  Text to mute
Returns string
Gray-styled string
- Defined in src/utils/logger.ts:212

`Private`getColor

getColor(colorName: string): ColorFunction
Parameters
- colorName: string
Returns ColorFunction
- Defined in src/utils/logger.ts:216

`Private`format

format(
    levelLabel: string,
    iconKey: keyof LoggerIcons,
    message: string,
    colorKey: keyof LoggerColors,
): string
Parameters
- levelLabel: string
- iconKey: keyof LoggerIcons
- message: string
- colorKey: keyof LoggerColors
Returns string
- Defined in src/utils/logger.ts:220

`Private`writeStdout

writeStdout(message: string): void
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:251

`Private`writeStderr

writeStderr(message: string): void
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:256

debug

debug(message: string, ...args: unknown[]): void
Log a debug message (only visible if level is DEBUG). Format: [DEBUG 🔎 TIMESTAMP] ::: message
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in src/utils/logger.ts:265

info

info(message: string): void
Log an info message. Standard CLI: Icon Message Verbose/Timestamp: [INFO 📄 TIMESTAMP] ::: message
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:278

success

success(message: string): void
Log a success message.
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:285

warn

warn(message: string): void
Log a warning message. Outputs to stderr as warnings are diagnostic messages.
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:295

error

error(message: string, error?: unknown): void
Log an error message.
Parameters
- message: string
- Optionalerror: unknown
Returns void
- Defined in src/utils/logger.ts:302

`Private`logGeneric

logGeneric(
    level: LogLevel,
    label: string,
    iconKey: keyof LoggerIcons,
    message: string,
    colorKey: keyof LoggerColors,
    logFn: LogFunction,
    force?: boolean,
): void
Parameters
- level: LogLevel
- label: string
- iconKey: keyof LoggerIcons
- message: string
- colorKey: keyof LoggerColors
- logFn: LogFunction
- force: boolean = false
Returns void
- Defined in src/utils/logger.ts:345

`Private`shouldShowDetails

shouldShowDetails(): boolean
Returns boolean
- Defined in src/utils/logger.ts:363

`Private`logSimple

logSimple(
    level: LogLevel,
    iconKey: keyof LoggerIcons,
    message: string,
    colorKey: keyof LoggerColors,
    logFn: LogFunction,
): void
Parameters
- level: LogLevel
- iconKey: keyof LoggerIcons
- message: string
- colorKey: keyof LoggerColors
- logFn: LogFunction
Returns void
- Defined in src/utils/logger.ts:367

`Private`colorizeMessage

colorizeMessage(
    level: LogLevel,
    message: string,
    colorFn: ColorFunction,
): string
Parameters
- level: LogLevel
- message: string
- colorFn: ColorFunction
Returns string
- Defined in src/utils/logger.ts:380

raw

raw(message: string): void
Print a raw message (useful for banners or tables). Treated as INFO level - respects silent mode.
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:388

output

output(message: string): void
Print output data (results, tables, JSON). Always prints regardless of log level - use for user-requested data. This is different from raw() which respects silent mode.
Parameters
- message: string
Returns void
- Defined in src/utils/logger.ts:399