@qui-cli/log

@qui-cli Plugin: Standardized winston wrapper


Install

``sh
npm install @qui-cli/log @qui-cli/core
`

Usage

`ts
import { Log } from '@qui-cli/log';
import { Core } from '@qui-cli/core';

// process user-provided command-line arguments
const args = Core.init();

// use Log
Log.debug(args);
`

Configuration

`ts
export type Configuration = Plugin.Configuration & {
logFilePath?: string;
stdoutLevel?: string;
fileLevel?: string;
levels?: CustomLevels;
root?: string;
};
`

$3

Optional path to log file (relative to root).

$3

Log level to display via stdout/console, defaults to 'info';

$3

Log level to write to log file (if logFilePath defined), defaults to 'all';

$3

Custom log levels to use, specified by Log.CustomLevels

$3

Optional root to use as the base for relative logFilePath. If undefined, falls back to the path defined by @qui-cli/root.

Options

Exposes logFilePath, stdoutLevel, and fileLevel to user-provided command line arguments.

Initialization

Log will updating logging settings after user-provided command line arguments are parsed. If stdoutLevel is set to off, logging to the console will be disabled. If configure() has provided a logFilePath value previously and the user provides an additional logFilePath, logs will be written to both paths.

API

`ts
import { Log } from '@qui-cli/log';
`

$3

Get the actual winston logger object.

$3

Directly invoke the winston log()` method

$3

Log a string or object (to be stringified -- in color in the console) at the respective log level.