Colors are cool

KISS, customizable and extensible module for do colorful console.log only for NodeJS. Simple, easy.

• Auto-detects color support
• Clean and focused
• Extensible and configurable

Install

$ npm i --save coolors

Usage

var coolors = require('coolors');
console.log(coolors('My cool console log', 'red'));

Configurable

var coolors = require('coolors');
console.log(coolors('My cool console log', {
    text: 'yellow',
    background: 'red',
    bold: true,
    underline: true,
    inverse: true,
    strikethrough: true
}));

Check example.js for view more examples

Options

Decorators

Styles will display correctly if font used in your console supports them.

• bold
• dim
• italic (not widely supported)
• underline
• inverse
• hidden
• strikethrough (not widely supported)

We can use like:

var coolors = require('coolors');
console.log(coolors('My cool console log', 'bold'));

Colors

Foreground	Background
black	bgBlack
red	bgRed
green	bgGreen
yellow	bgYellow
blue	bgBlue
magenta	bgMagenta
cyan	bgCyan
white	bgWhite

We can use like:

var coolors = require('coolors');
console.log(coolors('My cool console log', 'red'));
console.log(coolors('My cool console log 2', 'bgRed'));

Extend

You can extend and create your own custom logs creating something like this

// coolorsExtended.js
var coolors = require('coolors');
function rainbowLog(msg){
    var colorsText = coolors.availableStyles().text;
    var rainbowColors = colorsText.splice(3);
    var lengthRainbowColors = rainbowColors.length;
    var msgInLetters = msg.split('');
    var rainbowEndText = '';
    var i = 0;
    msgInLetters.forEach(function(letter){
        if(letter != ' '){
            if(i === lengthRainbowColors) i = 0;
            rainbowEndText += coolors(letter, rainbowColors[i]);
            i++;
        }else{
            rainbowEndText += ' ';
        }
    });
    return rainbowEndText;
}
coolors.addPlugin('rainbow', rainbowLog);
module.exports = coolors;

// app.js
var coolorsExtended = require('./coolorsExtended');
console.log(coolorsExtended('This its a creative example extending core with a cool rainbow style', 'rainbow'));
console.log(coolorsExtended('My cool console log', 'red'));

If you want extend more you can check this

TODO

• Add example of extend to do a console log with differents colors for type words. Something like:

    { 
         special: 'cyan',
         number: 'yellow',
         boolean: 'yellow',
         undefined: 'grey',
         null: 'bold',
         string: 'green',
         date: 'magenta',
         regexp: 'red' 
    }   
  

License

The MIT License (MIT)

Copyright (c) 2014 Coders Brothers

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.