Son CV dans un terminal web en Javascript! https://terminal-cv.gregandev.fr
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

173 lines
4.1 KiB

1 year ago
# Nano Colors
<img align="right" width="64" height="60"
src="./img/logo.svg"
title="Nano Colors logo by Roman Shamin">
A tiny and fast Node.js library for formatting terminal text with ANSI colors.
* It is **2 times faster** than `chalk`. Both loading and calls.
* **No dependencies.** It takes **5 times less space** in `node_modules`
than `chalk`.
* **Actively maintained.** Used in many big projects
like PostCSS or Browserslist.
* **Auto-detects color support.** You can also toggle color mode manually.
* **Tree-shakable.** We use a dual [ESM]/[CJS] package.
* Supports Node.js ≥ 6, Deno and universal Node.js/browser projects.
```js
import { green, bold } from 'nanocolors'
console.log(
green(`Task ${bold('1')} was finished`)
)
```
<p align="center">
<img src="./img/example.png" alt="Nano Colors output" width="600">
</p>
API was heavily inspired
by [**@jorgebucaran**](https://github.com/jorgebucaran/)’s
[`colorette`](https://github.com/jorgebucaran/colorette) with few cool hacks
copied from [**@lukeed**](https://github.com/lukeed/)’s
[`kleur`](https://github.com/lukeed/kleur).
<a href="https://evilmartians.com/?utm_source=nanocolors">
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg"
alt="Sponsored by Evil Martians" width="236" height="54">
</a>
[ESM]: https://github.com/ai/nanocolors/blob/main/index.js
[CJS]: https://github.com/ai/nanocolors/blob/main/index.cjs
## Benchmarks
Function calling time:
```
$ ./test/benchmark.js
chalk 11,608,010 ops/sec
cli-color 752,419 ops/sec
ansi-colors 3,601,857 ops/sec
kleur 15,185,239 ops/sec
kleur/colors 21,113,231 ops/sec
colorette 19,712,884 ops/sec
nanocolors 21,176,376 ops/sec
```
Library loading time:
```
$ ./test/loading.js
chalk 3.465 ms
cli-color 21.849 ms
ansi-colors 1.101 ms
kleur 1.628 ms
kleur/colors 0.508 ms
colorette 2.610 ms
nanocolors 0.486 ms
```
The space in `node_modules` including sub-dependencies:
```
$ ./test/size.js
Data from packagephobia.com
chalk 101 kB
cli-color 1249 kB
ansi-colors 25 kB
kleur 21 kB
colorette 16 kB
nanocolors 16 kB
```
Test configuration: ThinkPad X1 Carbon Gen 9, Fedora 34, Node.js 16.8.
## Replacing `chalk`
1. Replace import and use named exports:
```diff
- import chalk from 'chalk'
+ import { red, bold } from 'nanocolors'
```
2. Unprefix calls:
```diff
- chalk.red(text)
+ red(text)
```
3. Replace chains to nested calls:
```diff
- chalk.red.bold(text)
+ red(bold(text))
```
## API
### Individual Colors
Nano Colors exports functions:
| Colors | Background Colors | Modifiers |
| --------- | ------------------- | ----------------- |
| `black` | `bgBlack` | dim |
| `red` | `bgRed` | **bold** |
| `green` | `bgGreen` | hidden |
| `yellow` | `bgYellow` | _italic_ |
| `blue` | `bgBlue` | <u>underline</u> |
| `magenta` | `bgMagenta` | ~~strikethrough~~ |
| `cyan` | `bgCyan` | reset |
| `white` | `bgWhite` | |
| `gray` | | |
Functions are not chainable. You need to wrap it inside each other:
```js
import { black, bgYellow } from 'nanocolors'
console.log(bgYellow(black(' WARN ')))
```
Functions will use colors only if Nano Colors auto-detect that current
environment supports colors.
You can get support level in `isColorSupported`:
```js
import { isColorSupported } from 'nanocolors'
if (isColorSupported) {
console.log('With colors')
}
```
### Conditional Support
You can manually switch colors on/off and override color support auto-detection:
```js
import { createColors } from 'nanocolors'
const { red } = createColors(options.enableColors)
```
On `undefined` argument, `createColors` will use value
from color support auto-detection.
### Deno
Nano Colors has build-in [Deno support](https://deno.land/x/nanocolors).
```js
import { red } from 'https://deno.land/x/nanocolors/mod.ts'
```