npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-color-log

v12.0.1

Published

The more powerful JavaScript logger for NodeJS and browsers.

Downloads

178,142

Readme

Banner

Test npm version npm downloads

Node Color Log

The more powerful JavaScript logger for NodeJS and browsers.

node-color-log is a logger package for NodeJS and browsers. It provides more functions than the origin console.log. You can log text with colorful font and colorful background. Also, it has 4 levels log, including debug, info, warnand error. Give you much better experience while developing JavaScript 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.

API

log()

log with attributes, the order of setters can change.

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

append() can appends the contents in one line. (Note: old joint is now deprecated.)

color() and bgColor() includes: black, red, green, yellow, blue, magenta, cyan, white.

reset() can clear the previous attributes in the same line.

Usage:

// normal log
logger.log(message)
// Attribute log
logger.color('red').bgColor('blue')
      .bold().italic().dim().reverse().underscore().strikethrough()
      .log(message);
// use `append`` to joint contents, and use `log` to print out at the end
logger.color('red').bold().append('message_style_1')
      .bgColor('white').italic().append('message_style_2')
      .strikethrough().log('message_style_3');

// use `reset` to clean the attributes
logger.bgColor('red').append('background red color message')
      .reset() // by calling this, background is reset
      .log('default background color message');

// log multiple arguments
logger.log(obj1, arr2, str3);

setLogStream

You can redirect the logs to the stream.

for example, you can write the log into the file:

fileStream = fs.createWriteStream('test.log'),
logger.setLogStream(fileStream)

logger.log("hi");
logger.error("hello", "world");

fileStream.close()

you can use less -R test.log to see the result.

fontColorLog(), bgColorLog(), colorLog()

  • message here must be a string.

  • Color includes: black, red, green, yellow, blue, magenta, cyan, white.

  • setting is optional. Keys in setting need to be boolean, and all are false by default.

Parameters:

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
}

Usage:

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

success(), debug(), info(), warn(), error()

With prefix that has background color

Usage:

// Success level, with prefix "[SUCCESS]"
logger.success(message);
// debug level, with prefix "[DEBUG]"
logger.debug(message);
// Info level, with prefix "[INFO]"
logger.info(message);
// Warn level, with prefix "[WARN]"
logger.warn(message);
// Error level, with prefix "[ERROR]"
logger.error(message);


// Level logs enable multiple arguments
logger.debug(obj1, arr2, str3);

The output looks like:

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

setLevel() & LOGGER environment variable

If you want to set mask for levels, simply add the line at the front. Levels below the setting level will all be hidden. There are four levels, which are success, debug, info, warn, error, or disable in lower-case.

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

logger.setLevel("disable"); // hide every logs

Or, you can set the environment variable LOGGER, such as LOGGER=info npm start, where it's equal to setLevel("info").

setLevelNoColor(), setLevelColor()

Level logs print in colors as a default.

You can set setLevelNoColor() to turn off the setting, and use setLevelColor() to reverse it.

None color mode is helpful for text files or browser environments.

logger.setLevelNoColor();

setDate()

The default time format is toISOString, but you can change it by using setDate(callback)

logger.setDate(() => (new Date()).toLocaleTimeString())
logger.info("This is an info message") // 5:17:59 pm [INFO] This is an info message

createNamedLogger()

You can create a named logger by calling createNamedLogger()

logger1 = logger.createNamedLogger("Test 1");
logger2 = logger.createNamedLogger("Test 2");
logger1.info('something happened'); // 2022-08-20T04:56:17.834Z [Test 1] [INFO] something happened
logger2.info('something happened'); // 2022-08-20T04:56:17.835Z [Test 2] [INFO] something happened 

Contribute

Any issues and PRs are very welcome!

License

MIT