Motivation

We are lazy! Let's make it as easy as possible to config.

Installation

npm install --save enhance-console-log

Setup

Just import and call on your entry point.

const enhanceConsoleLog = require('enhance-console-log')
enhanceConsoleLog()

Configuration

// Default configuration
enhanceConsoleLog({
    dateFormat: 'YYYY-MM-DD HH:mm:ss.SSS',
    separator: '\t---',
    levelColor: {
        'debug': '#a0a0a0', 
        'log': '#dbdbdb', 
        'info': '#55a6e8', 
        'warn': '#f7b737',
        'error': '#b21111', 
    },
    // disabled some log level
    disabledLevel: {
        warn: true,
        log: process.env.NODE_ENV === 'production'
    }
})

Simple Usage

Just call the following console log functions: debug, log, info, warn and error.

console.debug('This is console.debug()')
console.log('This is console.log()')
console.info('This is console.info()')
console.warn('This is console.warn()')
console.error('This is console.error()')

You will get the following logs with colors if your terminal supports it.

2019-03-09 00:57:48.741 DEBUG   --- This is console.debug()
2019-03-09 00:57:48.741 LOG     --- This is console.log()
2019-03-09 00:57:48.741 INFO    --- This is console.info()
2019-03-09 00:57:48.741 WARN    --- This is console.warn()
2019-03-09 00:57:48.741 ERROR   --- This is console.error()

Helper Logging Function

We provide some logging helper patch directly to the console object.

console.debugWithPrefix(prefix: string)
console.logWithPrefix(prefix: string)
console.infoWithPrefix(prefix: string)
console.warnWithPrefix(prefix: string)
console.errorWithPrefix(prefix: string)

Example

const orderInfoLog = console.infoWithPrefix('order:111111')
const orderLog = console.logWithPrefix('order:111111')

orderInfoLog('created')
orderLog('trying to update')
orderInfoLog('updated')

You will get the following logs:

2019-03-09 00:57:48.742 INFO    --- [order:111111] created
2019-03-09 00:57:48.742 LOG     --- [order:111111] trying to update
2019-03-09 00:57:48.742 INFO    --- [order:111111] updated

License

MIT License

Copyright @ 2019 Nantaphop Phuengphae

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.