Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
The kleur npm package is a library for formatting terminal text with ANSI colors. It provides a simple and chainable API to style strings that are output to the console with various colors, backgrounds, and text styles.
Coloring text
This feature allows you to apply text color to your console output. The example shows how to color the text green.
const kleur = require('kleur');
console.log(kleur.green('Hello world!'));
Chaining styles
Kleur supports chaining multiple styles together. In this example, the text 'Error!' is styled to be red, bold, and underlined.
const kleur = require('kleur');
console.log(kleur.red().bold().underline('Error!'));
Background colors
You can also set background colors for your text. Here, the text 'Info' has a blue background with white foreground color.
const kleur = require('kleur');
console.log(kleur.bgBlue().white('Info'));
Conditional styling
Kleur allows conditional styling, where you can enable or disable colors based on certain conditions. In this example, the red color is applied only if the environment is not production.
const kleur = require('kleur');
const enabled = process.env.NODE_ENV !== 'production';
console.log(kleur.enabled(enabled).red('Only styled if not in production'));
Chalk is a popular npm package similar to kleur that allows for styling terminal strings. It offers a more extensive API and additional features like template literal support and custom themes, but it is slightly larger in size compared to kleur.
Colors is another package that provides ANSI color formatting for text in the terminal. It extends String.prototype to add color properties, which some developers may find less clean than the functional approach taken by kleur.
Ansi-colors is a lightweight package that focuses on performance. Like kleur, it does not extend String.prototype and has a chainable API, but it has fewer dependencies and is designed to be as minimal as possible.
String.prototype
modificationsAs of v3.0
the Chalk-style syntax (magical getter) is no longer used.
Please visit History for migration paths supporting that syntax.
$ npm install --save kleur
import kleur from 'kleur';
// basic usage
kleur.red('red text');
// chained methods
kleur.blue().bold().underline('howdy partner');
// nested methods
kleur.bold(`${ white().bgRed('[ERROR]') } ${ kleur.red().italic('Something happened')}`);
const { bold, green } = require('kleur');
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'));
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'));
Toggle color support as needed; kleur
includes simple auto-detection which may not cover all cases.
import kleur from 'kleur';
// manually disable
kleur.enabled = false;
// or use another library to detect support
kleur.enabled = require('color-support').level > 0;
console.log(kleur.red('I will only be colored red if the terminal supports colors'));
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 or nested 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*
* Not widely supported
When you only need a few colors, it doesn't make sense to import all of kleur
because, as small as it is, kleur
is not treeshakeable, and so most of its code will be doing nothing. In order to fix this, you can import from the kleur/colors
submodule which fully supports tree-shaking.
The caveat with this approach is that color functions are not chainable~!
Each function receives and colorizes its input. You may combine colors, backgrounds, and modifiers by nesting function calls within other functions.
// or: import * as kleur from 'kleur/colors';
import { red, underline, bgWhite } from 'kleur/colors';
red('red text');
//~> kleur.red('red text');
underline(red('red underlined text'));
//~> kleur.underline().red('red underlined text');
bgWhite(underline(red('red underlined text w/ white background')));
//~> kleur.bgWhite().underline().red('red underlined text w/ white background');
Note: All the same colors, backgrounds, and modifiers are available.
Conditional Support
The kleur/colors
submodule also allows you to toggle color support, as needed.
It includes the same initial assumptions as kleur
, in an attempt to have colors enabled by default.
Unlike kleur
, this setting exists as kleur.$.enabled
instead of kleur.enabled
:
import * as kleur from 'kleur/colors';
// or: import { $, red } from 'kleur/colors';
// manually disabled
kleur.$.enabled = false;
// or use another library to detect support
kleur.$.enabled = require('color-support').level > 0;
console.log(red('I will only be colored red if the terminal supports colors'));
Using Node v10.13.0
chalk :: 5.303ms
kleur :: 0.488ms
kleur/colors :: 0.369ms
ansi-colors :: 1.504ms
# All Colors
ansi-colors x 183,435 ops/sec ±0.96% (94 runs sampled)
chalk x 677,371 ops/sec ±0.17% (94 runs sampled)
kleur x 718,990 ops/sec ±0.51% (91 runs sampled)
kleur/colors x 862,421 ops/sec ±0.19% (95 runs sampled)
# Stacked colors
ansi-colors x 23,647 ops/sec ±1.14% (90 runs sampled)
chalk x 332,056 ops/sec ±0.57% (94 runs sampled)
kleur x 75,924 ops/sec ±0.32% (98 runs sampled)
kleur/colors x 103,509 ops/sec ±0.30% (96 runs sampled)
# Nested colors
ansi-colors x 67,278 ops/sec ±0.72% (96 runs sampled)
chalk x 124,868 ops/sec ±0.34% (96 runs sampled)
kleur x 136,444 ops/sec ±0.16% (97 runs sampled)
kleur/colors x 143,956 ops/sec ±0.25% (95 runs sampled)
This project originally forked ansi-colors
.
Beginning with kleur@3.0
, the Chalk-style syntax (magical getter) has been replaced with function calls per key:
// Old:
c.red.bold.underline('old');
// New:
c.red().bold().underline('new');
As I work more with Rust, the newer syntax feels so much better & more natural!
If you prefer the old syntax, you may migrate to ansi-colors
or newer chalk
releases.
Versions below kleur@3.0
have been officially deprecated.
MIT © Luke Edwards
FAQs
The fastest Node.js library for formatting terminal text with ANSI colors~!
We found that kleur demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.