cschalk-next v6.1.5

Terminal string styling done right

Highlights

• Expressive API
• Highly performant
• Ability to nest styles
• 256/Truecolor color support
• Auto-detects color support
• Doesn't extend String.prototype
• Clean and focused
• Actively maintained
• Used by ~50,000 packages as of January 1, 2020

Install

$ npm install cschalk

Usage

const cschalk = require('cschalk');

console.log(cschalk.blue('Hello world!'));

cschalk comes with an easy to use composable API where you just chain and nest the styles you want.

const cschalk = require('cschalk');
const log = console.log;

// Combine styled and normal strings
log(cschalk.blue('Hello') + ' World' + cschalk.red('!'));

// Compose multiple styles using the chainable API
log(cschalk.blue.bgRed.bold('Hello world!'));

// Pass in multiple arguments
log(cschalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));

// Nest styles
log(cschalk.red('Hello', cschalk.underline.bgBlue('world') + '!'));

// Nest styles of the same type even (color, underline, background)
log(cschalk.green(
	'I am a green line ' +
	cschalk.blue.underline.bold('with a blue substring') +
	' that becomes green again!'
));

// ES2015 template literal
log(`
CPU: ${cschalk.red('90%')}
RAM: ${cschalk.green('40%')}
DISK: ${cschalk.yellow('70%')}
`);

// ES2015 tagged template literal
log(cschalk`
CPU: {red ${cpu.totalPercent}%}
RAM: {green ${ram.used / ram.total * 100}%}
DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
`);

// Use RGB colors in terminal emulators that support it.
log(cschalk.keyword('orange')('Yay for orange colored text!'));
log(cschalk.rgb(123, 45, 67).underline('Underlined reddish color'));
log(cschalk.hex('#DEADED').bold('Bold gray!'));

Easily define your own themes:

const cschalk = require('cschalk');

const error = cschalk.bold.red;
const warning = cschalk.keyword('orange');

console.log(error('Error!'));
console.log(warning('Warning!'));

Take advantage of console.log string substitution:

const name = 'Sindre';
console.log(cschalk.green('Hello %s'), name);
//=> 'Hello Sindre'

API

cschalk.<style>[.<style>...](string, [string...])

Example: cschalk.red.bold.underline('Hello', 'world');

Chain styles and call the last one as a method with a string argument. Order doesn't matter, and later styles take precedent in case of a conflict. This simply means that cschalk.red.yellow.green is equivalent to cschalk.green.

Multiple arguments will be separated by space.

cschalk.level

Specifies the level of color support.

Color support is automatically detected, but you can override it by setting the level property. You should however only do this in your own code as it applies globally to all cschalk consumers.

If you need to change this in a reusable module, create a new instance:

const ctx = new cschalk.Instance({level: 0});

cschalk.supportsColor

Detect whether the terminal supports color. Used internally and handled for you, but exposed for convenience.

Can be overridden by the user with the flags --color and --no-color. For situations where using --color is not possible, use the environment variable FORCE_COLOR=1 (level 1), FORCE_COLOR=2 (level 2), or FORCE_COLOR=3 (level 3) to forcefully enable color, or FORCE_COLOR=0 to forcefully disable. The use of FORCE_COLOR overrides all other color support checks.

Explicit 256/Truecolor mode can be enabled using the --color=256 and --color=16m flags, respectively.

cschalk.stderr and cschalk.stderr.supportsColor

cschalk.stderr contains a separate instance configured with color support detected for stderr stream instead of stdout. Override rules from cschalk.supportsColor apply to this too. cschalk.stderr.supportsColor is exposed for convenience.

Styles

Modifiers

• reset - Resets the current color chain.
• bold - Make text bold.
• dim - Emitting only a small amount of light.
• italic - Make text italic. (Not widely supported)
• underline - Make text underline. (Not widely supported)
• inverse- Inverse background and foreground colors.
• hidden - Prints the text, but makes it invisible.
• strikethrough - Puts a horizontal line through the center of the text. (Not widely supported)
• visible- Prints the text only when cschalk has a color level > 0. Can be useful for things that are purely cosmetic.

Colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white
• blackBright (alias: gray, grey)
• redBright
• greenBright
• yellowBright
• blueBright
• magentaBright
• cyanBright
• whiteBright

Background colors

• bgBlack
• bgRed
• bgGreen
• bgYellow
• bgBlue
• bgMagenta
• bgCyan
• bgWhite
• bgBlackBright (alias: bgGray, bgGrey)
• bgRedBright
• bgGreenBright
• bgYellowBright
• bgBlueBright
• bgMagentaBright
• bgCyanBright
• bgWhiteBright

Tagged template literal

cschalk can be used as a tagged template literal.

const cschalk = require('cschalk');

const miles = 18;
const calculateFeet = miles => miles * 5280;

console.log(cschalk`
	There are {bold 5280 feet} in a mile.
	In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}.
`);

Blocks are delimited by an opening curly brace ({), a style, some content, and a closing curly brace (}).

Template styles are chained exactly like normal cschalk styles. The following three statements are equivalent:

console.log(cschalk.bold.rgb(10, 100, 200)('Hello!'));
console.log(cschalk.bold.rgb(10, 100, 200)`Hello!`);
console.log(cschalk`{bold.rgb(10,100,200) Hello!}`);

Note that function styles (rgb(), hsl(), keyword(), etc.) may not contain spaces between parameters.

All interpolated values (cschalk`${foo}`) are converted to strings via the .toString() method. All curly braces ({ and }) in interpolated value strings are escaped.

256 and Truecolor color support

cschalk supports 256 colors and Truecolor (16 million colors) on supported terminal apps.

Colors are downsampled from 16 million RGB values to an ANSI color format that is supported by the terminal emulator (or by specifying {level: n} as a cschalk option). For example, cschalk configured to run at level 1 (basic color support) will downsample an RGB value of #FF0000 (red) to 31 (ANSI escape for red).

Examples:

• cschalk.hex('#DEADED').underline('Hello, world!')
• cschalk.keyword('orange')('Some orange text')
• cschalk.rgb(15, 100, 204).inverse('Hello!')

Background versions of these models are prefixed with bg and the first level of the module capitalized (e.g. keyword for foreground colors and bgKeyword for background colors).

• cschalk.bgHex('#DEADED').underline('Hello, world!')
• cschalk.bgKeyword('orange')('Some orange text')
• cschalk.bgRgb(15, 100, 204).inverse('Hello!')

The following color models can be used:

• rgb - Example: cschalk.rgb(255, 136, 0).bold('Orange!')
• hex - Example: cschalk.hex('#FF8800').bold('Orange!')
• keyword (CSS keywords) - Example: cschalk.keyword('orange').bold('Orange!')
• hsl - Example: cschalk.hsl(32, 100, 50).bold('Orange!')
• hsv - Example: cschalk.hsv(32, 100, 100).bold('Orange!')
• hwb - Example: cschalk.hwb(32, 0, 50).bold('Orange!')
• ansi - Example: cschalk.ansi(31).bgAnsi(93)('red on yellowBright')
• ansi256 - Example: cschalk.bgAnsi256(194)('Honeydew, more or less')

Windows

If you're on Windows, do yourself a favor and use Windows Terminal instead of cmd.exe.

Origin story

colors.js used to be the most popular string styling module, but it has serious deficiencies like extending String.prototype which causes all kinds of problems and the package is unmaintained. Although there are other packages, they either do too much or not enough. cschalk is a clean and focused alternative.

cschalk for enterprise

Available as part of the Tidelift Subscription.

The maintainers of cschalk and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Related

• cschalk-cli - CLI for this module
• ansi-styles - ANSI escape codes for styling strings in the terminal
• supports-color - Detect whether a terminal supports color
• strip-ansi - Strip ANSI escape codes
• strip-ansi-stream - Strip ANSI escape codes from a stream
• has-ansi - Check if a string has ANSI escape codes
• ansi-regex - Regular expression for matching ANSI escape codes
• wrap-ansi - Wordwrap a string with ANSI escape codes
• slice-ansi - Slice a string with ANSI escape codes
• color-convert - Converts colors between different models
• cschalk-animation - Animate strings in the terminal
• gradient-string - Apply color gradients to strings
• cschalk-pipe - Create cschalk style schemes with simpler style strings
• terminal-link - Create clickable links in the terminal

Maintainers

• Sindre Sorhus
• Josh Junon