Enhanced-log NPM

Enhanced Log

Amazing, flexible, extendable library for enhance styling console output

Bower version

Enhanced Log

Install

$ npm install enhanced-log

$ bower install enhanced-log

Or just download dev or prod version

Usage

Browserify:

var log = require('enhanced-log')

Browser:

<script src="log.min.js">

ES6:

import * as log from 'log.min.js'

log has several chainable methods for styling your console output:

// you can combine it what you want and enjoy

log('message')
// equal
console.log('%cmessage', '')

log.info('message')
// equal
console.log('%cmessage', 'color:#03a9f4;')

log.large.capitalize.info('message') 
// equal
console.log('%cmessage', 'color:#03a9f4;text-transform:capitalize;font-size:18px;')

Demo

API

log.`<style>[.<style>...](message)`

Return new instance of log object, so you can cached it for further use

var error = log.large.danger

error.bold('Something going wrong') 
// console.log('%cSomething going wrong', 'font-weight:bold;color:#e51c23;font-size:18px;')

List of chainable styling methods:

large
huge
small
info
success
warning
danger
underline
overline
linethrough
capitalize
uppercase
lowercase
bold
italic
code
divider
callout
box

This methods very similar to CSS classes:

each can apply defined styles to output

log.large      // "font-size:18px;"
log.info       // "color:#03a9f4;"
log.large.info // "color:#03a9f4;font-size:18px;"

order doesn't matter

log.info.large // same styles as `log.large.info`

in case of conflict last override previous

log.small.large.huge // equal to log.huge

Few words about `callout`, `divider` and `box`

These methods are modify log string:

log.divider('message') // useful for separating output

==================== message ====================

log.callout('message') // useful for emphasize

▌ 
▌ message
▌

log.box('message') // useful :)

*************
*           *
*  message  *
*           *
*************

Of course these methods are chainable

log.divider.box.callout('message')

▌
▌   *********************************************************
▌   *                                                       *
▌   *  ===================== message =====================  *
▌   *                                                       *
▌   *********************************************************
▌

log.`styles`

Object or function of CSS properties for styling output

log.styles // {}

log.code.styles // function composed() { ... }

// this occurs cuz of styles inheritance

log.code.styles() // {color: "#C7254E", background-color: "#F9F2F4"}

Please do not modify this object, use log.defaults instead

log.`mapper(message)`

Function which modify log message before output

log.divider.mapper('text') // "===================== text ====================="

var success = log.success
// Do not do this, use `log.defaults` instead
success.mapper = function(message){ return 'Ok :: ' + message }

success('text') 
// Ok :: text

If you chain styling methods with mapper functions, this function will composed

success.divider('text')
// ================== Ok :: text ==================

log.`api`

log.api === console // true

By default it is console object, that means each instance of log use console API for logging, but you can define your own logging API and log will work fine with it, see Advanced Usage

log.`method`

log.method // "log"

By default it is "log", that means each instance of log use console["log"] for logging, but you can redefine this behaviour:

var warning = log.warning

warning.method = 'warn'

warning('Warning Message') // console.warn('%cWarning Message', 'color:#ff9800;')

Useful for filtering log messages by types

log.`toString()`

String representation of log instance:

log.code.toString() // "color:#C7254E;background-color:#F9F2F4;"

Useful for applying different styles to single log message. More info here

console.log('%cAmazing, flexible, extendable wrapper for %cconsole.log%c to enhance %cstyling console output', log, log.code, log, log.bold) // try this in your DevTools

log.`toJSON()`

Serialize log instance

log.`off()`

DEPRECATED

Prevent each instance of log from output to console, works globally:

var error = log.large.danger

error.off()

log.info('message') // nothing happens

log.`on()`

DEPRECATED

Resume output to console for each instance of log, works globally too

log.`toggle([state])`

DEPRECATED

Toggle output to console, if state defined, true value will enable output, false - disable

log.toggle(DEBUG) // prevent output if DEBUG === false

log.`defaults`

Object of default styling properties of each styling methods. Used for customizing predefined styling methods:

log.defaults.code
/*
{
    styles: {
        color: "#C7254E", 
        background-color: "#F9F2F4"
    }
}
*/

You can simply change styles properties, mapper function or even method and api from examples above

log.defaults.warning.method = 'warn'
log.defaults.success.mapper = function(message){ return 'Ok :: ' + message }

log.warning('Warning Message')
// equal
console.warn('%cWarning Message', 'color:#ff9800;')

log.success('Success Message')
// equal
console.log('%cOk :: Success Message', 'color:#259b24')

log.`mixin(target)`

Method for defined your own styling methods:

log.mixin({
	muted: {
		styles: {
			color: '#777'
		}
	}
})

log.small.muted('Unimportant Message')
// equal
console.log('%cUnimportant Message', 'color:#777;font-size:10px;')

Or use styles like a function

log.mixin({
    rand: {
        styles: function(){
            return {
                color: '#' + (~~(Math.random()*(1<<24))).toString(16)
            }
        }
    }
})

log.rand.toString() // "color:#b95c4e;"
log.rand.toString() // "color:#f2158c;"
log.rand.toString() // "color:#f60484;"

log.`utils`

Collection of useful utility functions

`.id(arg)`

Just a placeholder - return passing value

let target = {}
expect(log.utils.id(target)).to.be(target)

`.result(arg)`

If passed function, call it and return result, otherwise just return passing value

let target = {}
expect(log.utils.result(target)).to.be(target)
expect(log.utils.result(() => { return target })).to.be(target)

`.compose(func, func[, func...])`

Returns the composition of a list of functions

let f = (x) => x*2
,   g = (x) => x+2

expect(log.utils.compose(f, g)(2)).to.be(8)
expect(log.utils.compose(g, f)(2)).to.be(6)

`.extend(target[, source...])`

Canonical extend, copy all properties from the source objects to target

`.createStyles(styles)`

Convert object to valid CSS style string

log.utils.createStyles({}) // ""
log.utils.createStyles({color: 'red', padding: '20px', 'font-size': '18px'}) // "color:red;padding:20px;font-size:18px;"

`.parseStyles(styles)`

Convert css style string to object

log.utils.parseStyles('color:red;padding:20px;') // {color: "red", padding: "20px"}

`.divider(text[, symbol, length])`

Create a divider string, support optional symbol and length arguments

log.utils.divider('message')          // "==================== message ===================="
log.utils.divider('message', '-')     // "-------------------- message --------------------"
log.utils.divider('message', 20)      // "===== message ====="
log.utils.divider('message', '-', 20) // "----- message -----"
log.utils.divider('-', 20)            // "-------------------"
log.utils.divider(20, '-')            // "-------------------"
log.utils.divider('-')                // "-------------------------------------------------"
log.utils.divider(20)                 // "==================="

`.callout(text[, symbol])`

Create an ASCII callout

log.utils.callout('message', '|') // useful for emphasize

| 
| message
|

`.box(text[, symbol, padding])`

Create an ASCII box, support optional symbol and padding arguments

log.utils.box('message')

*************
*           *
*  message  *
*           *
*************

log.utils.box('multiline\nmessage', '#', { left: 3, right: 3 })

#################
#               #
#   multiline   #
#   message     #
#               #
#################

Advanced Usage

Create your own logger

For example you want sent logs to your backend or implement DOM logger

// define simple DOM logger
var DOMLoggerApi = {
    $wrapper: $('#log-wrapper'),
    log: function(message, styles){
    	var $logMessage = $('<span/>')
    	$logMessage.text(message.replace('%c', ''))
    	$logMessage[0].style.cssText = styles
    	this.$wrapper.append($logMessage).append('<hr/>')
    }
}

// extend `log`
log.mixin({
    dom: {
        api: DOMLoggerApi
    }
})

// use it
log.dom.info('text') // will output this message with styles to #log-wrapper

Taking advantage of the fact that `log` is function

log instanceof Function // true

That means you can use .call, .apply and .bind for calling log with different context.

log is smart, so it will use passed context like a custom logger.

For example DOMLoggerApi from example above can be used as follows:

var DOMLogger = { api: DOMLoggerApi }

log.info.call(DOMLogger, 'text')

log.info.apply(DOMLogger, ['text'])

log.info.bind(DOMLogger, 'text')()

DOMLogger.log = log.info
DOMLogger.log('text')

log console.log sexy

@everything-registry/sub-chunk-1586 @infinitebrahmanuniverse/nolb-enh

11 years ago

11 years ago

11 years ago

11 years ago

enhanced-log v2.6.0

Enhanced Log

Table of Contents

Install

Usage

API

log.`<style>[.<style>...](message)`

Few words about `callout`, `divider` and `box`

log.`styles`

log.`mapper(message)`

log.`api`

log.`method`

log.`toString()`

log.`toJSON()`

log.`off()`

log.`on()`

log.`toggle([state])`

log.`defaults`

log.`mixin(target)`

log.`utils`

`.id(arg)`

`.result(arg)`

`.compose(func, func[, func...])`

`.extend(target[, source...])`

`.createStyles(styles)`

`.parseStyles(styles)`

`.divider(text[, symbol, length])`

`.callout(text[, symbol])`

`.box(text[, symbol, padding])`

Advanced Usage

Create your own logger

Taking advantage of the fact that `log` is function

Enhanced Log

Table of Contents

Install

Usage

API

log.<style>[.<style>...](message)

Few words about callout, divider and box

log.styles

log.mapper(message)

log.api

log.method

log.toString()

log.toJSON()

log.off()

log.on()

log.toggle([state])

log.defaults

log.mixin(target)

log.utils

.id(arg)

.result(arg)

.compose(func, func[, func...])

.extend(target[, source...])

.createStyles(styles)

.parseStyles(styles)

.divider(text[, symbol, length])

.callout(text[, symbol])

.box(text[, symbol, padding])

Advanced Usage

Create your own logger

Taking advantage of the fact that log is function

log.`<style>[.<style>...](message)`

Few words about `callout`, `divider` and `box`

log.`styles`

log.`mapper(message)`

log.`api`

log.`method`

log.`toString()`

log.`toJSON()`

log.`off()`

log.`on()`

log.`toggle([state])`

log.`defaults`

log.`mixin(target)`

log.`utils`

`.id(arg)`

`.result(arg)`

`.compose(func, func[, func...])`

`.extend(target[, source...])`

`.createStyles(styles)`

`.parseStyles(styles)`

`.divider(text[, symbol, length])`

`.callout(text[, symbol])`

`.box(text[, symbol, padding])`

Taking advantage of the fact that `log` is function