jslogmgr v0.1.7

jsLogMgr

"The most effective debugging tool is still careful thought, coupled with judiciously placed print statements." - Brian Kernighan

Javascript-based logger extension to the console API. The basic design principle behind this implementation is to provide an API extension to the console API while providing some of the benefit of a more robust and configurable logging library.

Features

1. Ability to create loggers for specific code contexts (classes, functions, etc),
2. Configurable control over:

• color styling of log statements by level,
• date, context, message formatting of logging statements (coming soon)
• log output by level,

3. API consistency with the console API for easy replacement and adoption.

Installation

NPM

$ npm install --save jslogmgr

Usage

import JsLogManager from 'jslogmgr';

class Rainbow {
    constructor () {
        // create the log manager.
        this.logManager = new JsLogManager();
        
        // create a logger, by contextual name.
        this.logger = this.logManager.getLogger('Rainbow');
        this.logger.info('Welcome to Rainbow, version 1.0');
    }

    run() {
        this.logger.time('blackmore');
        this.logger.trace('Application starting...');
        this.logger.debug('This is a debug message');
        this.logger.info('This is an informational message');
        this.logger.warn('This is a warning message');
        this.logger.error('This is an error message');
        this.logger.fatal('This is a fatal message');
        this.logger.timeEnd('blackmore');
    }
}

will result in:

Configuration

jsLogger is configurable to allow you to specify a minimum level of output you desire, style output by level, specify your date formatting and (coming soon) format your log output.

Minimum level output

If you want to suppress all output below ERROR when deploying your application, you can set this up by defining the minumum level in the configuration with LoggerConfig.setLevel(logLevel.ERROR).

Output styling by level

If you would like to change the styling of the log output by level, you can accomplish this by the LoggerConfig.setLevelStyling(level, styling) method. the styling parameter can take any combination of chalk styling attributes. See the Styles section of the chalk page.

Date formatting

You can also change the data format of the log messages by supplying any moment based date format string to LoggerConfig.setDateFormat(format).

Contributing

Use Github issues for feature requests and bug reports.

We actively welcome pull requests.

For setting up & starting the project locally, use:

$ git clone https://github.com/nhpace/jsLogMgr
$ cd jsLogMgr
$ npm install
$ npm run dev

LICENSE

MIT