Eight Colors

Eight colors for the console

Install

npm i eight-colors

Features

• Eight Colors: black, red, green, yellow, blue, magenta, cyan, white
• Background and Bright
• Styles: reset, bold, faint, italic, underline, inverse, hidden, strike
• Remove colors
• Log colors
• ESM/CJS
• TypeScript
• env NO_COLOR FORCE_COLOR and flags --no-color --color
• 0 dependencies
• 2.6K Size

Usage

1const EC = require("eight-colors");
2
3// text color
4console.log(EC.red('red string'));
5
6// background color
7console.log(EC.bg.red('red background'));
8
9// bright color
10console.log(EC.br.red('bright red string'));
11
12// bright background color
13console.log(EC.br.bg.red('bright red background'));
14
15// style
16console.log(EC.italic('italic text'));
17console.log(EC.underline('underline text'));
18console.log(EC.green(EC.underline('green underline text')));
19
20// remove color
21const redString = EC.red('red string');
22console.log(redString);
23const string = EC.remove(redString);
24console.assert(string === 'red string');
25
26// log color
27const res = EC.logRed('string1', 'string2');
28console.assert(EC.remove(res) === 'string1 string2');
29
30EC.logGreen('log green');
31EC.logRed('log red');
32EC.logCyan('log cyan');
33EC.logBlack('log black');
34EC.logWhite('log white');
35
36EC.log('log 2 arguments', '2');
37EC.logGreen('logGreen 2 arguments', '2');
38EC.logMagenta('logMagenta 3 arguments', '2', '3');
39
40// disabled color
41EC.disabled = true;
42EC.logRed('disabled = true log default');
43EC.disabled = false;
44EC.logRed('disabled = false log red');
45

APIs

1EC.black(str)
2EC.red(str)
3EC.green(str)
4EC.yellow(str)
5EC.blue(str)
6EC.magenta(str)
7EC.cyan(str)
8EC.white(str)
9
10EC.bg.black(str)
11EC.bg.red(str)
12EC.bg.green(str)
13EC.bg.yellow(str)
14EC.bg.blue(str)
15EC.bg.magenta(str)
16EC.bg.cyan(str)
17EC.bg.white(str)
18
19EC.br.black(str)
20EC.br.red(str)
21EC.br.green(str)
22EC.br.yellow(str)
23EC.br.blue(str)
24EC.br.magenta(str)
25EC.br.cyan(str)
26EC.br.white(str)
27
28EC.br.bg.black(str)
29EC.br.bg.red(str)
30EC.br.bg.green(str)
31EC.br.bg.yellow(str)
32EC.br.bg.blue(str)
33EC.br.bg.magenta(str)
34EC.br.bg.cyan(str)
35EC.br.bg.white(str)
36
37EC.reset(str)
38EC.bold(str)
39EC.faint(str)
40EC.italic(str)
41EC.underline(str)
42EC.inverse(str)
43EC.hidden(str)
44EC.strike(str)
45
46EC.remove(str)
47
48EC.log(str)
49EC.logBlack(str)
50EC.logRed(str)
51EC.logGreen(str)
52EC.logYellow(str)
53EC.logBlue(str)
54EC.logMagenta(str)
55EC.logCyan(str)
56EC.logWhite(str)
57
58EC.disabled = true|false

Browser Console

Usage is the same as above, and provides an additional UMD bundle (1.35 KB)

1<script src="path-to/eight-colors/dist/eight-colors.js"></script>
2<script>
3    const EC = window['eight-colors'];
4    console.log(EC.red('red string'));
5</script>

• firefox does not support

Links

• https://en.wikipedia.org/wiki/ANSI_escape_code
• https://handwiki.org/wiki/ANSI_escape_code