1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<div align="center">
<img src="shots/logo.png" alt="kleur" height="120" />
</div>
<div align="center">
<a href="https://npmjs.org/package/kleur">
<img src="https://badgen.now.sh/npm/v/kleur" alt="version" />
</a>
<a href="https://travis-ci.org/lukeed/kleur">
<img src="https://badgen.now.sh/travis/lukeed/kleur" alt="travis" />
</a>
<a href="https://npmjs.org/package/kleur">
<img src="https://badgen.now.sh/npm/dm/kleur" alt="downloads" />
</a>
<a href="https://packagephobia.now.sh/result?p=kleur">
<img src="https://packagephobia.now.sh/badge?p=kleur" alt="install size" />
</a>
</div>
<div align="center">The fastest Node.js library for formatting terminal text with ANSI colors~!</div>
## Features
* No dependencies
* Super [lightweight](#load-time) & [performant](#performance)
* Supports [nested](#nested-methods) & [chained](#chained-methods) colors
* No `String.prototype` modifications
* Conditional [color support](#conditional-support)
* Familiar [API](#api)
---
As of `v3.0` the Chalk-style syntax (magical getter) is no longer used.<br>If you need or require that syntax, consider using [`ansi-colors`](https://github.com/doowb/ansi-colors), which maintains `chalk` parity.
---
## Install
```
$ npm install --save kleur
```
## Usage
```js
const { red, white, blue, bold } = require('kleur');
// basic usage
red('red text');
// chained methods
blue().bold().underline('howdy partner');
// nested methods
bold(`${ white().bgRed('[ERROR]') } ${ red().italic('Something happened')}`);
```
### Chained Methods
```js
console.log(bold().red('this is a bold red message'));
console.log(bold().italic('this is a bold italicized message'));
console.log(bold().yellow().bgRed().italic('this is a bold yellow italicized message'));
console.log(green().bold().underline('this is a bold green underlined message'));
```
<img src="shots/1.png" width="300" />
### Nested Methods
```js
const { yellow, red, cyan } = require('kleur');
console.log(yellow(`foo ${red().bold('red')} bar ${cyan('cyan')} baz`));
console.log(yellow('foo ' + red().bold('red') + ' bar ' + cyan('cyan') + ' baz'));
```
<img src="shots/2.png" width="300" />
### Conditional Support
Toggle color support as needed; `kleur` includes simple auto-detection which may not cover all cases.
```js
const kleur = require('kleur');
// manually disable
kleur.enabled = false;
// or use another library to detect support
kleur.enabled = require('color-support').level;
console.log(kleur.red('I will only be colored red if the terminal supports colors'));
```
## API
Any `kleur` method returns a `String` when invoked with input; otherwise chaining is expected.
> It's up to the developer to pass the output to destinations like `console.log`, `process.stdout.write`, etc.
The methods below are grouped by type for legibility purposes only. They each can be [chained](#chained-methods) or [nested](#nested-methods) with one another.
***Colors:***
> black — red — green — yellow — blue — magenta — cyan — white — gray — grey
***Backgrounds:***
> bgBlack — bgRed — bgGreen — bgYellow — bgBlue — bgMagenta — bgCyan — bgWhite
***Modifiers:***
> reset — bold — dim — italic* — underline — inverse — hidden — strikethrough*
<sup>* <em>Not widely supported</em></sup>
## Benchmarks
> Using Node v10.13.0
### Load time
```
chalk :: 14.543ms
kleur :: 0.474ms
ansi-colors :: 1.923ms
```
### Performance
```
# All Colors
ansi-colors x 199,381 ops/sec ±1.04% (96 runs sampled)
chalk x 12,107 ops/sec ±2.07% (87 runs sampled)
kleur x 715,334 ops/sec ±0.30% (93 runs sampled)
# Stacked colors
ansi-colors x 24,494 ops/sec ±1.03% (93 runs sampled)
chalk x 2,650 ops/sec ±2.06% (85 runs sampled)
kleur x 75,798 ops/sec ±0.19% (97 runs sampled)
# Nested colors
ansi-colors x 77,766 ops/sec ±0.32% (94 runs sampled)
chalk x 5,596 ops/sec ±1.85% (86 runs sampled)
kleur x 137,660 ops/sec ±0.31% (93 runs sampled)
```
## Credits
This project originally forked [Brian Woodward](https://github.com/doowb)'s awesome [`ansi-colors`](https://github.com/doowb/ansi-colors) library.
Beginning with `kleur@3.0`, the Chalk-style syntax (magical getter) has been replaced with function calls per key:
```js
// Old:
c.red.bold.underline('old');
// New:
c.red().bold().underline('new');
```
> <sup><em>As I work more with Rust, the newer syntax feels so much better & more natural!</em></sup>
If you prefer the old syntax, you may migrate to `ansi-colors`. Versions below `kleur@3.0` have been deprecated.
## License
MIT © [Luke Edwards](https://lukeed.com)
|
