@druide/color-log NPM

Node Color Log

The more powerful logger for NodeJS.

node-color-log is a package for NodeJS. It provides more functions than the origin console.log. You can log text with colorful font and colorful background. Also, it has four levels log, including debug, info, warnand error. Give you much better experience while developing NodeJS projects.

Demo

Usage

Install

Install package in your project:

npm install node-color-log@latest --save

Import

Put the following code in your js in which you want to log.

const logger = require('node-color-log');

Some parameters:

color includes: black, red, green, yellow, blue, magenta, cyan, white.
setting is optional, which is only used in colorLog, fontColorLog and bgColorlog. Keys in setting need to be boolean, and false by defualt.

let color = 'red';
let message = 'anything you will put into console.log';
const setting = {
    bold: true,
    dim: true,
    underscore: true,
    reverse: true,
    italic: true,
    strikethrough: true
}

`log()`

log with attributes, the order of setters can change.

NOTE: log() need to put behind of attribute setter(at the end).

joint() can connect different style of message in a line.

// normal log
logger.log(message)
// Attribute log
logger.color('red').bgColor('blue')
      .bold().italic().dim().reverse().underscore().strikethrough()
      .log(message);
// Joint log
logger.color('red').bold().log(message_style_1).joint()
      .bgColor('white').italic().log(message_style_2).joint()
      .strikethrough().log(message_style_3);

`fontColorLog()`, `bgColorLog()`, `colorLog()`

// only set font color
logger.fontColorLog('red', message, setting);
// only set background color
logger.bgColorLog('yellow', message, setting);
// set font and background color
logger.colorLog({
    font: 'black',
    bg: 'yellow'
}, message, setting);

`debug()`, `error()`, `info()`, `warn()`

With prefix that has background color

// debug level, with prefix "DEBUG: "
logger.debug(message);
// Error level, with prefix "ERROR: "
logger.error(message);
// Info level, with prefix "INFO: "
logger.info(message);
// Warn level, with prefix "WARN: "
logger.warn(message);

2018-08-14T18:23:09.837Z [DEBUG] This is debug mode
2018-08-14T18:23:09.837Z [ERROR] This is error mode
2018-08-14T18:23:09.838Z [INFO] This is info mode
2018-08-14T18:23:09.838Z [WARN] This is warn mode

To see more example, you can check ./test.js or run npm test to see the result.