Skip to content
🎉 Stylish-log "A beautiful way to see your web console logs"
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demos
.gitignore
.npmignore
LICENSE.txt
README.md
package.json
stylish-log.js

README.md

stylish-log

A stylish console.log

Transform your console.log into a customized logs. This does not override the default console.log, it just add a new way to debug with CSS styles.

How to install

npm install stylish-log

Then you call it with import or require:

import log from 'stylish-log'

//OR

const log = require('stylish-log');

How to use

There are 4 stylish-log methods that you can use:

  • log.show
  • log.info
  • log.warn
  • log.danger

The default styles for these methods are:

const styles = {
  default: 'color: gray; font-weight: bold;',
  info: 'color: blue; font-weight: bold;',
  warn: 'color: #ffc107;',
  danger: 'color: lightcoral; font-weight: bold;'
}

Basic examples

See how this example are shown in console

log.show('default')();
log.info('info')();
log.warn('warn')();
log.danger('danger')();

demo1

You can pass how many values you want to stylish-log methods, if you have more than just one, the first string message becomes a "label message" for your log. Take a look:

const arrObj = [
  {
    "obj1": "lorem value",
    "obj2": "lorem value"
  },
  {
    "obj1_2": "lorem value",
    "obj2_2": "lorem value"
  }
]
const arr = ['arr', 'arr2', 'arr3'];

const fn = function(){
  console.log('A function');
}

//call stylish-log for each value passing a custom message label

log.show('label message:', arrObj)();
log.info('label message:', arr)();
log.warn('label message:', arr, arrObj)();
log.danger('label message:', fn)();

See how this example are shown in console

demo2

How to change the default style

You have total freedom to override the default styles for each method

log.styles.default = 'font-size: 14px; color: #795548; text-transform: uppercase;';
log.styles.info = 'font-size: 14px; background: #4fc3f7; color: white;';
log.styles.warn = 'font-size: 14px; color: black; background: linear-gradient(to right, #ffa726, #ffe0b2)';
log.styles.danger = 'font-size: 14px; color: white; text-shadow: 0 1px 0 black, 0 0 8px red;';

demo3

As you can see even gradients are supported.

Another example with images:

log.styles.default = 'background: url(https://i.imgflip.com/1plo8j.jpg) left bottom no-repeat; background-size: contain; display: block; padding: 150px 80px';

log.show('')();

Assuming that the padding is respectively height and width you can set an image to console. In this case the default style was overrided and then log.show('')() was called, passing an empty string to initiate the image log.

demo4;

What about emojis? Yes you can!

log.styles.default = 'font-size: 50px;';

log.show('🐴', 'go horse')();

demo5

Important

You should have noticed about the double ()() call from the methods in the examples. There was an initial version (not published) that you could just call the methods with single (), the reason of the double ()() are the stack trace in the console. You can see the difference between below:

log.show('testing single () call');

stack2

log.show('testing double ()() call')();

stack4

Why?

In fact, this module is just a stylish console.log which provides a simple way to customize your logs with CSS styles. You can take the same effect using the example console.log(%c My log message, 'color: gray; font-weight: bold;') this will generate the same result as log.show('My log message')().

If you prefer an elegant and useful way to style your console, feel free to use and enjoy it.

TODO

  • Custom methods
  • Preview improvements
  • Icons

A special thanks to @UltCombo
You can’t perform that action at this time.