Skip to content

marvinhagemeister/kolorist

Folders and files

NameName
Last commit message
Last commit date
Apr 22, 2023
Feb 3, 2023
Apr 22, 2023
May 25, 2020
Feb 19, 2020
Apr 22, 2023
Feb 19, 2020
Feb 2, 2023
Feb 3, 2023
Apr 22, 2023
Feb 19, 2020
Mar 17, 2021
Jan 12, 2021

Repository files navigation

kolorist

Tiny library to put colors into stdin/stdout 🎉

Screenshot of terminal colors

Usage

npm install --save-dev kolorist
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:

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:

import { red, stripColors } from 'kolorist';

console.log(stripColors(red('foo')));
// Logs 'foo'

License

MIT, see the license file.