Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.12 KB

README.md

File metadata and controls

67 lines (51 loc) · 2.12 KB
Raw

print-colors

print-colors is a very lightweight library for printing colors to the console using a nice and easy to use syntax.

Import the module to your project:

const c = require('print-colors');

To print to your console some "How to use" examples you can use the example(), docs() or help() functions available with the library to print some example to the console.

const c = require('print-colors');

c.example();

In order to affect the color of the text printed to the console with the built in console.log() function, you need to follow the following template:

console.log(c.(background or foreground).(light or dark).(color) + 'Some Text' + c.end);

Examples:

const c = require('print-colors');

console.log(c.foreground.light.red + 'This text will be printed in light red color' + c.end);

console.log(c.foreground.dark.green + 'This text will be printed in dark green color' + c.end);

console.log(c.background.dark.blue + 'This text will be printed with dark blue background color' + c.end);

You can also have combinations of background and foreground colors like so:

console.log(c.background.light.yellow + c.foreground.dark.blue + 'This text will be blue with yellow background color' + c.end);

You can use this set of shortcuts for having a better syntax:

  • bg = background
  • fg = foreground
  • l = light
  • d = dark
  • e = end

So in practice, the above examples can be shortted as follow:

console.log(c.fg.l.red + 'This text will be printed in light red color' + c.e);

console.log(c.fg.d.green + 'This text will be printed in dark green color' + c.e);

console.log(c.bg.d.blue + 'This text will be printed with dark blue background color' + c.e);

console.log(c.bg.l.yellow + c.fg.d.blue + 'This text will be blue with yellow background color' + c.e);

Supported colors:

  • gray
  • red
  • green
  • yellow
  • blue
  • pink
  • cyan
  • white

Note

The following library was tested with Windows CMD.exe. Colors might look different from one console to another since the console colors are many time can be configured by the user...