khaosdoctor/knoblr

:clipboard: Simple logging library for Node projects

Knoblr

Knoblr is a simple logging library to help node developers.

• Knoblr
  • What is
  • Installing
  • Using
    • API
  • Customizing usage
    • Datetime formats
    • Displaying the timestamp
    • Displaying log type
    • Log colors
    • Reset

What is

It basically adds a funcionality of displaying three types of logs:

• Warns
• Errors
• Info

Very simple. And it comes along with a timestamp, and color codes!

Installing

Just perform a npm install --save knoblr

Using

In your file require the logger:

const log = require('knoblr');

Then you can use like this:

const log = require('knoblr');

log.warn('This is a warn text');
log.error('This is an error text');
log.info('This is an info text');

This will be the output:

API

There's also an API to help developers get their error messages straight and format them as they please. All you need to do is set a second parameter to true:

const log = require('knoblr');

var warnString = log.warn('This is a warn text', true); //this will return a string instead
var errorString = log.error('This is an error text', true); //this will return a string instead
var infoString = log.info('This is an info text', true); //this will return a string instead

Customizing usage

There are options to customize the output of the log, such as:

• Datetime formats
• Whether or not to display the timestamp
• Displaying log type
• Logging colors

Datetime formats

Knoblr uses Moment.js to issue times and formats, so all the Moment's formats will be compatible with Knoblr.

Refer to this url to know more about formats.

In order to set the time formats you can do:

const log = require('knoblr');

log.setTimeFormat("Your format Here");

log.warn('This is a warn text with your timestamp');
log.error('This is an error text with your timestamp');
log.info('This is an info text with your timestamp');

The default time format is YYYY-MM-DD HH:mm:ss (In other words its <4-digit year>/<2-digit month>/<2-digit-day> <24h hours>:<2-digit minutes>:<2-digit seconds>).

Displaying the timestamp

You have the choice not to display the timestamp along with the log, just set:

const log = require('knoblr');

log.displayTimestamp = false;

log.warn('This is a warn text without the timestamp');
log.error('This is an error text without the timestamp');
log.info('This is an info text without the timestamp');

Displaying log type

Same as before, you can choose not to show {WARN}, {INFO} and {ERROR} texts during logs, for that to happen all you have to do is:

const log = require('knoblr');

log.displayLogType = false;

log.warn('This is a warn text without the log type');
log.error('This is an error text without the log type');
log.info('This is an info text without the log type');

Log colors

Knoblr uses Chalk as colorizer, so you can set an instance of chalk using Knoblr return implementation object.

Knoblr exposes chalk as an instance so the you don't need to require it:

const log = require("../dist/log.js");
log.setLogColor('info', log.colors.green);
log.setLogColor('warn', log.colors.cyan);
log.setLogColor('error', log.colors.bgYellow);

log.warn('This will be cyan');
log.error('This will have an awesome yellow bg');
log.info('This will be green');

Reset

If you want to switch back to the original values just perform a log.reset().

Check the basetest file to get a glimpse of all commands.

This will be the output of the tests:

License

MIT @ Lucas Santos

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

knoblr's Issues

Support spread args

Support for spread args such as: knoblr.info(1,2,3,4,5) to log as [date] => {type} 1 2 3 4 5

Conversion to Typescript

Remove duplicated code

There's some code duplication there which is lowering the code climate grade, remove it

Render object as tree

Print out deep objects, not only [object Object]

Remove extra spaces when no tags

when the user takes out a tag, a space remains, remove it.

Create channels to post messages (to emails, etc)

Create a channel object that will allow the user to set a default location to the logs

• File
• Email
• console