Class Logger

Main DevLogr Logger class providing structured logging with visual enhancements. Now simplified with extracted responsibilities for better maintainability.

Constructors

constructor

new Logger(prefix: string): Logger
Parameters
- prefix: string
Returns Logger
- Defined in logger.ts:262

Accessors

singleSpinnerListr

get singleSpinnerListr(): null | Listr<any, "default", "simple">
Returns null | Listr<any, "default", "simple">
- Defined in logger.ts:775

Methods

`Static`setLevel

setLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in logger.ts:275

`Static`resetLevel

resetLevel(): void
Returns void
- Defined in logger.ts:279

info

info(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:287

error

error(message: string, error?: unknown, ...args: unknown[]): void
Parameters
- message: string
- Optionalerror: unknown
- ...args: unknown[]
Returns void
- Defined in logger.ts:291

warning

warning(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:296

warn

warn(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:300

debug

debug(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:304

trace

trace(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:308

success

success(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:312

title

title(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:316

task

task(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:320

plain

plain(message: string, ...args: unknown[]): void
Parameters
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:324

startSpinner

startSpinner(text?: string, _options?: Omit<SpinnerOptions, "text">): void
Parameters
- Optionaltext: string
- Optional_options: Omit<SpinnerOptions, "text">
Returns void
- Defined in logger.ts:333

updateSpinnerText

updateSpinnerText(text: string): void
Parameters
- text: string
Returns void
- Defined in logger.ts:341

stopSpinner

stopSpinner(): void
Returns void
- Defined in logger.ts:348

completeSpinner

completeSpinner(
type: "error" | "info" | "success" | "warning",
text?: string,
): void
Parameters
- type: "error" | "info" | "success" | "warning"
- Optionaltext: string
Returns void
- Defined in logger.ts:356

completeSpinnerWithSuccess

completeSpinnerWithSuccess(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:381

completeSpinnerWithError

completeSpinnerWithError(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:384

completeSpinnerWithWarning

completeSpinnerWithWarning(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:387

completeSpinnerWithInfo

completeSpinnerWithInfo(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:390

succeedSpinner

succeedSpinner(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:393

failSpinner

failSpinner(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:396

warnSpinner

warnSpinner(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:399

infoSpinner

infoSpinner(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in logger.ts:402

startNamedSpinner

startNamedSpinner(key: string, text: string): void
Start a named spinner that can run concurrently with other named spinners. Uses SpinnerUtils for multi-spinner management.
Parameters
- key: string
  Unique identifier for this spinner
- text: string
  Text to display with the spinner
Returns void
- Defined in logger.ts:417

updateNamedSpinnerText

updateNamedSpinnerText(key: string, text: string): void
Update the text of a named spinner.
Parameters
- key: string
  Unique identifier of the spinner
- text: string
  New text to display
Returns void
- Defined in logger.ts:442

stopNamedSpinner

stopNamedSpinner(key: string): void
Stop a named spinner without completion message.
Parameters
- key: string
  Unique identifier of the spinner
Returns void
- Defined in logger.ts:456

succeedNamedSpinner

succeedNamedSpinner(key: string, text?: string): void
Complete a named spinner with success status.
Parameters
- key: string
  Unique identifier of the spinner
- Optionaltext: string
  Optional success message
Returns void
- Defined in logger.ts:471

failNamedSpinner

failNamedSpinner(key: string, text?: string): void
Complete a named spinner with failure status.
Parameters
- key: string
  Unique identifier of the spinner
- Optionaltext: string
  Optional failure message
Returns void
- Defined in logger.ts:492

warnNamedSpinner

warnNamedSpinner(key: string, text?: string): void
Complete a named spinner with warning status.
Parameters
- key: string
  Unique identifier of the spinner
- Optionaltext: string
  Optional warning message
Returns void
- Defined in logger.ts:511

infoNamedSpinner

infoNamedSpinner(key: string, text?: string): void
Complete a named spinner with info status.
Parameters
- key: string
  Unique identifier of the spinner
- Optionaltext: string
  Optional info message
Returns void
- Defined in logger.ts:530

isNamedSpinnerActive

isNamedSpinnerActive(key: string): boolean
Check if a named spinner is currently active.
Parameters
- key: string
  Unique identifier of the spinner
Returns boolean
True if the spinner is active, false otherwise
- Defined in logger.ts:549

runTasks

runTasks<T = Record<string, unknown>>(
    title: string,
    tasks: ListrTask<T, any, any>[],
    options?: {
        concurrent?: boolean;
        exitOnError?: boolean;
        context?: T;
        rendererOptions?: Record<string, unknown>;
    },
): Promise<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- title: string
- tasks: ListrTask<T, any, any>[]
- Optionaloptions: {
      concurrent?: boolean;
      exitOnError?: boolean;
      context?: T;
      rendererOptions?: Record<string, unknown>;
  }
Returns Promise<T>
- Defined in logger.ts:563

createTaskList

createTaskList<T = Record<string, unknown>>(
    tasks: ListrTask<T, any, any>[],
    options?: {
        concurrent?: boolean;
        exitOnError?: boolean;
        context?: T;
        level?: string;
    },
): Listr<T, typeof DevLogrRenderer>
Type Parameters
- T = Record<string, unknown>
Parameters
- tasks: ListrTask<T, any, any>[]
- Optionaloptions: { concurrent?: boolean; exitOnError?: boolean; context?: T; level?: string }
Returns Listr<T, typeof DevLogrRenderer>
- Defined in logger.ts:576

runConcurrentTasks

runConcurrentTasks<T = Record<string, unknown>>(
    title: string,
    tasks: ListrTask<T, any, any>[],
    contextOrOptions?: T | { context?: T; level?: string },
): Promise<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- title: string
- tasks: ListrTask<T, any, any>[]
- OptionalcontextOrOptions: T | { context?: T; level?: string }
Returns Promise<T>
- Defined in logger.ts:589

runSequentialTasks

runSequentialTasks<T = Record<string, unknown>>(
    title: string,
    tasks: ListrTask<T, any, any>[],
    contextOrOptions?: T | { context?: T; level?: string },
): Promise<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- title: string
- tasks: ListrTask<T, any, any>[]
- OptionalcontextOrOptions: T | { context?: T; level?: string }
Returns Promise<T>
- Defined in logger.ts:598

spacer

spacer(): void
Returns void
- Defined in logger.ts:611

separator

separator(title?: string): void
Parameters
- Optionaltitle: string
Returns void
- Defined in logger.ts:617

log

log(
    level: LogLevel,
    logLevel: string,
    message: string,
    ...args: unknown[],
): void
Parameters
- level: LogLevel
- logLevel: string
- message: string
- ...args: unknown[]
Returns void
- Defined in logger.ts:665

buildSpinnerOptions

buildSpinnerOptions(
    text: string,
    level: string,
    options?: Record<string, unknown>,
): SpinnerOptions
Parameters
- text: string
- level: string
- options: Record<string, unknown> = {}
Returns SpinnerOptions
- Defined in logger.ts:700

outputDevLogrFormattedTask

outputDevLogrFormattedTask(message: string, symbol?: string): void
Parameters
- message: string
- Optionalsymbol: string
Returns void
- Defined in logger.ts:731

getConfig

getConfig(): LogConfig
Returns LogConfig
- Defined in logger.ts:766

getPrefix

getPrefix(): string
Returns string
- Defined in logger.ts:770

isSpinnerActive

isSpinnerActive(): boolean
Returns boolean
- Defined in logger.ts:781

clearSpinnerState

clearSpinnerState(): void
Returns void
- Defined in logger.ts:786

Class Logger

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Logger

Accessors

singleSpinnerListr

Returns null | Listr<any, "default", "simple">

Methods

StaticsetLevel

Parameters

Returns void

StaticresetLevel

Returns void

info

Parameters

Returns void

error

Parameters

Returns void

warning

Parameters

Returns void

warn

Parameters

Returns void

debug

Parameters

Returns void

trace

Parameters

Returns void

success

Parameters

Returns void

title

Parameters

Returns void

task

Parameters

Returns void

plain

Parameters

Returns void

startSpinner

Parameters

Returns void

updateSpinnerText

Parameters

Returns void

stopSpinner

Returns void

completeSpinner

Parameters

Returns void

completeSpinnerWithSuccess

Parameters

Returns void

completeSpinnerWithError

Parameters

Returns void

completeSpinnerWithWarning

Parameters

Returns void

completeSpinnerWithInfo

Parameters

Returns void

succeedSpinner

Parameters

Returns void

failSpinner

Parameters

Returns void

warnSpinner

Parameters

Returns void

`Static`setLevel

`Static`resetLevel