Cmlog

✏️ Emoji console logger

Installation

Using yarn:

$ yarn add cmlog

Using npm:

$ npm i cmlog

Getting started

import cmlog from "cmlog"

// See types section for all available types
cmlog.debug('export something')
cmlog.warn('Something is going to happen soon')
cmlog.success('Build succeeed in 10 seconds')
cmlog.info('Some extra info is here')
cmlog.error(new Error('Foo'))

Types

A list of all available default types:

• ✅ cmlog.success(...str)
• 🔵 cmlog.info(...str)
• 😥 cmlog.warn(...str)
• 🐛 cmlog.debug(...str)
• ⌛ cmlog.waitting(...str)
• 🔥 cmlog.boosting(...str)
• 👶 cmlog.start(...str)
• ✨ cmlog.done(...str)
• 📦 cmlog.pack(title, ...str)
• ⚪ cmlog.module(title, ...str)
• ❌ cmlog.error(Error)

Split / Blank

• cmlog.split(char, count)
• cmlog.blank(lines)

// default: char = "="; count = 40
cmlog.split()

// output:
// =========================================

// default: lines = 1;
cmlog.blank()

Log object

• cmlog.json(obj, title)

cmlog.json("{foo:bar}","Format")

Terminal log:

⚪ Format
  {
    foo: bar
  }

Dye string

• cmlog.dye(color, ...str)

return: string

Colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white
• gray
• redBright
• greenBright
• yellowBright
• blueBright
• magentaBright
• cyanBright
• whiteBright

Config

import { Cmlog } from "cmlog"

// default config
const cmlog = new Cmlog({
      align    : true, // whether to align info
      maxLength: 8, // (align:true) the max spacings to add
      debug    : true, // whether to show debug log
      time     : false // whether to show time info
})

License

MIT