PWA
CI / build (push) Has been skipped
CI / deploy (push) Successful in 1m24s

This commit is contained in:
eewing
2026-02-19 07:41:49 -06:00
parent 5776a1fdb1
commit c0fae761da
10919 changed files with 874329 additions and 13511 deletions
+53
View File
@@ -0,0 +1,53 @@
# kolorist
Tiny library to put colors into stdin/stdout :tada:
![Screenshot of terminal colors](.github/demo.png)
## Usage
```bash
npm install --save-dev kolorist
```
```js
import { red, cyan } from 'kolorist';
console.log(red(`Error: something failed in ${cyan('my-file.js')}.`));
```
You can also disable or enable colors globally via the following environment variables:
- disable:
- `NODE_DISABLE_COLORS`
- `NO_COLOR`
- `TERM=dumb`
- `FORCE_COLOR=0`
- enable:
- `FORCE_COLOR=1`
- `FORCE_COLOR=2`
- `FORCE_COLOR=3`
On top of that you can disable colors right from node:
```js
import { options, red } from 'kolorist';
options.enabled = false;
console.log(red('foo'));
// Logs a string without colors
```
You can also strip colors from a string:
```js
import { red, stripColors } from 'kolorist';
console.log(stripColors(red('foo')));
// Logs 'foo'
```
### License
`MIT`, see [the license file](./LICENSE).