import {ColorLogger} from 'typhonjs-color-logger/src/ColorLogger.js'

public class | source

ColorLogger

Provides a color coded logger for ANSI terminal usage. In addition to providing a global scope logger typhonjs-color-logger is optionally plugin enabled via typhonjs-plugin-manager and can self-register on an eventbus with all methods exposed as event bindings.

In the future an option to use CSS colors for browser usage will be enabled.

There are several format options to display additional data / info including location where the log method is invoked in addition to a time stamp. By default the time stamp option is disabled.

When passing in an Error for logging the stack trace of the error will be used for info and trace creation. The trace method will automatically generate a stack trace.

format: [LogLevel] [Time] [File] log text

Log level and color:

fatal: light red
error: red
warn: yellow
info: green
debug: blue
verbose: purple
trace: light cyan

Each log method for the log levels above have two alternate versions that are accessed by appending Compact, NoColor or Raw to the method name. Or if using event bindings appending :compact, :nocolor or :raw. The no color option with, well, no color outputting the message with the current log format and the raw format will output just the raw message with no format or color applied.

In addition trace inclusive and exclusive regexp filtering is available to eliminate spurious code removing it from the stack trace. By default the typhonjs-color-logger and backbone-esnext-events is excluded from trace results. Additionally the following events from typhonjs-plugin-manager are handled to automatically add and remove trace filters from plugins added & removed via the event bindings: typhonjs:plugin:manager:added:plugin, typhonjs:plugin:manager:plugin:changed:eventbus, and typhonjs:plugin:manager:removed:plugin. To skip auto filter registration for a particular plugin set logAutoFilter to false in the associated plugins options.

See:

Example:

import logger from 'typhonjs-color-logger';

// simple usage
logger.error('An error occurred!');

import PluginManager    from 'typhonjs-plugin-manager';
import eventbus         from 'backbone-esnext-eventbus';

const pluginManager = new PluginManager({ eventbus });

// This will automatically wire up typhonjs-color-logger to the eventbus.
pluginManager.add({ name: typhonjs-color-logger });

// simple usage
eventbus.trigger('log:error', 'An error occurred!');

Constructor Summary

Public Constructor
public	constructor(options: ColorLoggerOptions) Instantiates ColorLogger allowing optional options to be set.

Member Summary

Private Members
private	_exclusiveTraceFilters: Map<string, TraceFilter> Stores all exclusive trace filters.
private	_inclusiveTraceFilters: Map<string, TraceFilter> Stores all inclusive trace filters.
private	_logLevel: *
private	_options: ColorLoggerOptions Stores ColorLogger options.

Method Summary

Public Methods
public	addFilter(config: TraceFilterData): boolean Adds a new trace filter.
public	addFilters(filterConfigs: Array<TraceFilterData>): boolean Initializes multiple trace filters in a single call.
public	debug(msg: ...*): string Display debug (blue) log.
public	debugCompact(msg: ...*): string Display debug (blue) log; objects compacted.
public	debugNoColor(msg: ...*): string Display debug log.
public	debugRaw(msg: ...*): string Display raw debug log (no style / no color).
public	error(msg: ...*): string Display error(red) log.
public	errorCompact(msg: ...*): string Display error(red) log; objects compacted.
public	errorNoColor(msg: ...*): string Display error log.
public	errorRaw(msg: ...*): string Display raw error log (no style / no color).
public	fatal(msg: ...*): string Display fatal (light red) log.
public	fatalCompact(msg: ...*): string Display fatal (light red) log; objects compacted.
public	fatalNoColor(msg: ...*): string Display fatal log.
public	fatalRaw(msg: ...*): string Display raw fatal log (no style / no color).
public	getAllFilterData(enabled: boolean \| undefined): Array<TraceFilterData> Gets the filter data for a trace filter by name.
public	getFilterData(type: string, name: string): TraceFilterData \| undefined Gets the filter data for a trace filter by name.
public	getFilterEnabled(type: string, name: string): boolean Gets a trace filter enabled state.
public	getLogLevel(): * Get the log level
public	getOptions(): ColorLoggerOptions Returns a copy of the logger options.
public	info(msg: ...*): string Display info (green) log.
public	infoCompact(msg: ...*): string Display info (green) log; objects compacted.
public	infoNoColor(msg: ...*): string Display info log.
public	infoRaw(msg: ...*): string Display raw info log (no style / no color).
public	isLevelEnabled(level: string): boolean Returns whether the given log level is enabled.
public	isValidLogLevel(level: string): boolean Returns true if the given level is a valid log level.
public	removeAllFilters() Removes all trace filters.
public	removeFilter(type: string, name: string): boolean Removes a trace filter by name
public	setFilterEnabled(type: string, name: string, enabled: boolean): boolean Sets a trace filters enabled state.
public	setLogLevel(level: string): boolean Sets the current log level.
public	setOptions(options: ColorLoggerOptions) Set optional parameters.
public	trace(msg: ...*): string Display trace (purple) log.
public	traceCompact(msg: ...*): string Display trace (purple) log; objects compacted.
public	traceNoColor(msg: ...*): string Display trace log.
public	traceRaw(msg: ...*): string Display raw trace log (no style / no color).
public	verbose(msg: ...*): string Display verbose (purple) log.
public	verboseCompact(msg: ...*): string Display verbose (purple) log; objects compacted.
public	verboseNoColor(msg: ...*): string Display verbose log.
public	verboseRaw(msg: ...*): string Display raw verbose log (no style / no color).
public	warn(msg: ...*): string Display warning (yellow) log.
public	warnCompact(msg: ...*): string Display warning (yellow) log; objects compacted.
public	warnNoColor(msg: ...*): string Display warning log.
public	warnRaw(msg: ...*): string Display raw warn log (no style / no color).

Private Methods
private	_applyFilters(value: string): boolean Applies any exclusive then inclusive filters against a given value.
private	_output(level: string, compact: boolean, nocolor: boolean, raw: boolean, msg: ...*): string \| undefined Display log message.
private	getTraceInfo(error: Error, isTrace: boolean): {info: string, trace: String[]} Generates log information from where the logger invocation originated.

Public Constructors

public constructor(options: ColorLoggerOptions) source

Instantiates ColorLogger allowing optional options to be set.

Params:

Name	Type	Attribute	Description
options	ColorLoggerOptions	optional	Optional ColorLoggerOptions to set.

Name

Type

Attribute

Description

options

ColorLoggerOptions

optional

Optional ColorLoggerOptions to set.

Private Members

private _exclusiveTraceFilters: Map<string, TraceFilter> source

Stores all exclusive trace filters.

private _inclusiveTraceFilters: Map<string, TraceFilter> source

Stores all inclusive trace filters.

private _logLevel: * source

private _options: ColorLoggerOptions source

Stores ColorLogger options.

Public Methods

public addFilter(config: TraceFilterData): boolean source

Adds a new trace filter.

Params:

Name	Type	Attribute	Description
config	TraceFilterData		The filter config to add.

Name

Type

Attribute

Description

config

TraceFilterData

The filter config to add.

Return:

boolean

True if the filter was added.

public addFilters(filterConfigs: Array<TraceFilterData>): boolean source

Initializes multiple trace filters in a single call.

Params:

Name	Type	Attribute	Description
filterConfigs	Array<TraceFilterData>		An array of filter config object hash entries.

Name

Type

Attribute

Description

filterConfigs

Array<TraceFilterData>

An array of filter config object hash entries.

Return:

boolean

If true all filters were added successfully.

public debug(msg: ...*): string source

Display debug (blue) log.

Params:

Name	Type	Attribute	Description
msg	...*		log message.

Name

Type

Attribute

Description

msg

...*

log message.

ColorLogger

See:

Example:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(options: ColorLoggerOptions) source

Params:

Private Members

private _exclusiveTraceFilters: Map<string, TraceFilter> source

private _inclusiveTraceFilters: Map<string, TraceFilter> source

private _logLevel: * source

private _options: ColorLoggerOptions source

Public Methods

public addFilter(config: TraceFilterData): boolean source

Params:

Return:

public addFilters(filterConfigs: Array<TraceFilterData>): boolean source

Params:

Return:

public debug(msg: ...*): string source

Params:

Return:

public debugCompact(msg: ...*): string source

Params:

Return:

public debugNoColor(msg: ...*): string source

Params:

Return:

public debugRaw(msg: ...*): string source

Params:

Return:

public error(msg: ...*): string source

Params:

Return:

public errorCompact(msg: ...*): string source

Params:

Return:

public errorNoColor(msg: ...*): string source

Params:

Return:

public errorRaw(msg: ...*): string source

Params:

Return:

public fatal(msg: ...*): string source

Params:

Return:

public fatalCompact(msg: ...*): string source

Params:

Return:

public fatalNoColor(msg: ...*): string source

Params:

Return:

public fatalRaw(msg: ...*): string source

Params:

Return:

public getAllFilterData(enabled: boolean | undefined): Array<TraceFilterData> source

Params:

Return:

public getFilterData(type: string, name: string): TraceFilterData | undefined source

Params:

Return:

public getFilterEnabled(type: string, name: string): boolean source

Params:

Return:

public getLogLevel(): * source

Return:

public getOptions(): ColorLoggerOptions source

Return:

public info(msg: ...*): string source

Params:

Return:

public infoCompact(msg: ...*): string source

Params:

Return:

public infoNoColor(msg: ...*): string source

Params:

Return:

public infoRaw(msg: ...*): string source