ci-logger

CI Logger

CI Logger is a very simple logger designed for CI environments - no colors, no timestamps - just data. Log entries can be formatted to indicate the results of a previous message, and the process can be terminated of an error is logged.

Usage

const logger = require('ci-logger');

logger.log({message: 'Retrieving data from somewhere...'});
// Retrieving data from somewhere...

logger.log({message: 'Error retrieving data', isResult: true, level: logger.levels.warn});
//  ⮡ Error retrieving data

logger.log({message: 'Error retrieving data', isResult: true, level: logger.levels.error, exitOnError: true, errorCode: 2});
//  ⮡ Error retrieving data
// Fatal error - exiting

The log method must be passed an object with the following possible properties:

• The message property contains the message to be logged and is the only required property. It can be any value except undefined or null.
• The level enumeration, exposed by the module, has three possible values: levels.info, levels.warn, and levels.error. The default value is levels.info.
• The isResult property is a boolean value intended to indicate the result of an operation, primarily intended to simplify reading busy CI console logs. If isResult is true, the logged message is formatted to indicate it is the result of the preceeding message. If false, the message is not altered. The default value is false.
• The exitOnError property is a boolean value indicating whether the process should exit if an error is logged. If true, the error will be logged, a fatal error message will be logged, and process.exit will be called with the errorCode value (an integer). The default value of exitOnError is true, and the default value of errorCode is 1.