winston-console-for-electron

A modified version of Winston's Console Transport to support Electron applications. Created mainly for use in VSCodeVim, an extension for VSCode, but it's generic enough to be used for other Electron applications.

Installation

npm i --save winston-console-for-electron

Usage

• Requires winston > 3.0

import * as winston from 'winston';
import { ConsoleForElectron } from 'winston-console-for-electron';

let logger = winston.createLogger({
  transports: [new ConsoleForElectron()],
});

Options

• level: Level of messages that this transport should log (default 'info').
• silent: Boolean flag indicating whether to suppress output (default false).
• colorize: Boolean flag indicating if we should colorize output (default false).
• timestamp: Boolean flag indicating if we should prepend output with timestamps (default false). If function is specified, its return value will be used instead of timestamps.
• json: Boolean flag indicating whether or not the output should be JSON. If true, will log out multi-line JSON objects. (default false)
• stringify: Boolean flag indiciating if the output should be passed through JSON.stringify, resulting in single-line output. Most useful when used in conjunction with the json flag. (default false)
• prettyPrint: Boolean flag indicating if we should util.inspect the meta (default false). If function is specified, its return value will be the string representing the meta.
• depth Numeric indicating how many times to recurse while formatting the object with util.inspect (only used with prettyPrint: true) (default null, unlimited)
• showLevel: Boolean flag indicating if we should prepend output with level (default true).
• formatter: If function is specified, its return value will be used instead of default output. (default undefined)
• stderrLevels: Array of strings containing the levels to log to stderr instead of stdout, for example ['error', 'debug', 'info']. (default ['error', 'debug'])
• prefix: Prefix to log

Inspirations/Alternatives

• https://github.com/dustinblackman/winston-electron - does not support Winston 3.0
• https://www.npmjs.com/package/winston-electron-console - looked sketchy; source code is nowhere to be found