Logzy NPM | npm.io

Features

Zero dependencies!
Ultralight! ~1.5kb min
Flexible and user friendly API
Supports Object debugging
Provides utils for advanced nesting
Adds life to the console.log
Ridiculously easy to use
Really fast

Installation

npm i -D logzy

API

log()

Custom function for stylizing console messages.

/**
 * Custom function for stylizing console messages.
 *
 * @param keys Array of strings, accepts one or more values.
 * @param message Custom message, can be anything.
 * @param [debug] Enables debug mode for objects (optional).
 */
log(keys, message, debug)

// Examples

import { log } from 'logzy'

// Outputs a stylized message
log(['cyan'], 'custom message...')
log(['lime', 'bold', 'underline'], 33 * 77)
log(['black', 'bold', 'bg_white'], message)

// Outputs a stylized `console` object
log(['cyan', 'italic'], console, 'inspect')

// Outputs a stylized object in `json` format
log(['sky', 'italic', 'bold'], { a: 'b', c: 'd', e: 'f' }, 'json')

Nesting & Customization

Logzy comes with a built-in tiny utilities designed for nesting and raw customization.

These utils must be wrapped with console.log to actually output the styled message.

/**
 * Tiny utility function designed for nesting and raw customization.
 * Basically the same as the main `log()` function but without `console.log` wrapper.
 *
 * @param keys Array of strings, accepts one or more values.
 * @param message Custom message, can be anything.
 * @param [debug] Enables debug mode for objects (optional).
 */
log.$(keys, message, debug)

// Examples

import { log } from 'logzy'

console.log(log.$(['cyan', 'bold'], 'logzy is fire'))

// Examples

import { log, cl } from 'logzy'

const { $, bold, cyan, reset } = log

cl($(['cyan', 'bold', 'underline'], 'logzy is fire'))

cl(`${$(['lime', 'bold'], 'logzy')} is ${$(['rose', 'italic'], 'fire')}`)

cl(`${bold}${cyan}custom message...${reset}`)

Debugging

Also, Logzy supports object outputs with a node's inspect utility and native JSON.stringify method under the hood.

By default, debug mode is disabled.

// Examples

import { log } from 'logzy'

// enables node's inspect utility
log(['cyan', 'italic'], console, 'inspect')

const obj = {
  a: 'logzy',
  b: {
    c: {
      d: [1, 2, 3]
    },
    e: {
      f: true
    }
  }
}

// enables JSON.stringify method
log(['lime', 'bold'], obj, 'json')

Keys

List of all available keys

Text Colors	Background Colors	Text Styles
amber	bg_amber	bold
black	bg_black	crossout
blue	bg_blue	darken
cyan	bg_cyan	hidden
gray	bg_gray	invert
green	bg_green	italic
indigo	bg_indigo	reset
lime	bg_lime	underline
magenta	bg_magenta
pink	bg_pink
red	bg_red
rose	bg_rose
silver	bg_silver
sky	bg_sky
white	bg_white
yellow	bg_yellow