What is colorette?
The colorette npm package is a Node.js library for colorizing text in the terminal. It provides a simple API to add colors and styles to console output, which can be useful for creating more readable and organized logs, command-line tools, and scripts.
What are colorette's main functionalities?
Text coloring
Colorette allows you to color text output in the terminal. You can use predefined color functions to wrap your text and make it appear in the specified color when logged to the console.
const { red, green, blue } = require('colorette');
console.log(red('This is red text'));
console.log(green('This is green text'));
console.log(blue('This is blue text'));
Text styling
In addition to coloring, colorette provides functions to apply various text styles such as bold, underline, and italic.
const { bold, underline, italic } = require('colorette');
console.log(bold('This is bold text'));
console.log(underline('This is underlined text'));
console.log(italic('This is italic text'));
Combining styles
Colorette allows you to combine multiple styles and colors for a single piece of text. This can be useful for highlighting important information or creating visually distinct messages in the terminal.
const { red, bold, bgGreen } = require('colorette');
console.log(bold(red(bgGreen('Red text on green background'))));
Other packages similar to colorette
chalk
Chalk is a popular npm package similar to colorette that allows for styling and coloring terminal text. It offers a chainable API and additional color options. Chalk is known for its ease of use and extensive customization capabilities, but it might be slightly larger in size compared to colorette.
ansi-colors
Ansi-colors is another npm package for coloring terminal text. It focuses on performance and is dependency-free. It provides a similar API to colorette but with a different implementation approach. Ansi-colors may offer better performance in certain scenarios.
kleur
Kleur is a lightweight alternative to colorette with zero dependencies. It offers a similar API for text coloring and formatting. Kleur is designed for performance and has a minimalistic approach, which might make it faster in some cases.
Colorette
Color your terminal using pure idiomatic JavaScript.
Colorette is a Node.js library for embellishing your CLI tools with colors and styles using ANSI escape codes.
- ~1.5x faster than alternatives (run the benchmarks).
- No wonky prototype-based method chains.
- Automatic color support detection.
- ~80 LOC and no dependencies.
NO_COLOR
friendly.
Quickstart
npm i colorette
Import the styles you need. Here's the list of styles you can use.
import { red, blue, bold } from "colorette"
Wrap your strings in one or more styles to produce the finish you're looking for.
console.log(bold(blue("Engage!")))
Mix it with template literals to interpolate variables, expressions and create multi-line strings easily.
console.log(`
Beets are ${red("red")},
Plums are ${blue("blue")},
${bold("Colorette!")}.
`)
Using console.log
's string substitution can be useful too.
console.log(bold("Total: $%f"), 1.99)
You can also nest styles without breaking existing escape codes.
console.log(red(`Red Shirt ${blue("Blue Shirt")} Red Shirt`))
Feeling adventurous? Try the pipeline operator.
console.log("Make it so!" |> bold |> blue)
Supported styles
Colorette supports the standard and bright color variations out-of-the-box. See this issue if you were looking for TrueColor support.
Colors | Background Colors | Bright Colors | Bright Background Colors | Modifiers |
---|
black | bgBlack | blackBright | bgBlackBright | dim |
red | bgRed | redBright | bgRedBright | bold |
green | bgGreen | greenBright | bgGreenBright | hidden |
yellow | bgYellow | yellowBright | bgYellowBright | italic |
blue | bgBlue | blueBright | bgBlueBright | underline |
magenta | bgMagenta | magentaBright | bgMagentaBright | strikethrough |
cyan | bgCyan | cyanBright | bgCyanBright | reset |
white | bgWhite | whiteBright | bgWhiteBright | |
gray | | | | |
API
style(string)
Returns a string wrapped in the corresponding ANSI escape codes.
red("Red Alert")
options.enabled
Color will be enabled if your terminal supports it, FORCE_COLOR
is defined in process.env
and if NO_COLOR
isn't, but you can always override it if you want.
import { options } from "colorette"
options.enabled = false
Run the benchmarks
npm i -C bench && node bench
colorette × 759,429 ops/sec
chalk × 524,034 ops/sec
kleur × 490,347 ops/sec
colors × 255,661 ops/sec
ansi-colors × 317,605 ops/sec
License
MIT