Package Exports

node-color-log

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-color-log) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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');

Logger level can be set like this. Logs belongs to this level and above that level will be printed.

logger.setLevel("error"); // it can be any log level.

Some parameters:

These are the argument definition used by the logger functions:

message put into logger need to be a string.
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 all are false by default.

const color = 'red';
const message = 'any string 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

setLevel()

If you want to set mask for levels, simply add the line at the front. Levels below the setting level will all be hidden.

logger.setLevel("info"); //  debug < info < warn < error
logger.debug("This `debug` will be hidden");

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

Contribute

Any issues and PRs are very welcome!

License

MIT

node-color-log