chalk-template

Terminal string styling with tagged template literals

Install

1npm install chalk-template

Usage

For printing to standard output (stdout):

1import chalkTemplate from 'chalk-template';
2import chalk from 'chalk';
3
4console.log(chalkTemplate`
5CPU: {red ${cpu.totalPercent}%}
6RAM: {green ${ram.used / ram.total * 100}%}
7DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
8`);
9
10console.log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
11
12const miles = 18;
13const calculateFeet = miles => miles * 5280;
14
15console.log(chalkTemplate`
16	There are {bold 5280 feet} in a mile.
17	In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}.
18`);
19
20console.log(chalkTemplate`
21	There are also {#FF0000 shorthand hex styles} for
22	both the {#ABCDEF foreground}, {#:123456 background},
23	or {#ABCDEF:123456 both}.
24`);

For printing to standard error (stderr):

1import {chalkTemplateStderr} from 'chalk-template';
2
3console.error(chalkTemplateStderr`
4CPU: {red ${cpu.totalPercent}%}
5RAM: {green ${ram.used / ram.total * 100}%}
6DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
7`);

API

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

Template styles are chained exactly like normal Chalk styles. The following two statements are equivalent:

1import chalk from 'chalk';
2import chalkTemplate from 'chalk-template';
3
4console.log(chalk.bold.rgb(10, 100, 200)('Hello!'));
5console.log(chalkTemplate`{bold.rgb(10,100,200) Hello!}`);

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

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

Template function

This function can be useful if you need to wrap the template function. However, prefer the default export whenever possible.

Note: It's up to you to properly escape the input.

1import {template} from 'chalk-template';
2
3console.log(template('Today is {red hot}'));

1import {templateStderr} from 'chalk-template';
2
3console.error(templateStderr('Today is {red hot}'));

Create template functions using a custom Chalk instance

The makeTemplate and makeTaggedTemplate functions are exported so functions can be created using a custom Chalk instance.

Note: When using a function created with makeTemplate, it's up to you to properly escape the input.

1import {Chalk} from 'chalk'
2import {makeTemplate, makeTaggedTemplate} from 'chalk-template';
3
4const template = makeTemplate(new Chalk({level: 3}));
5const chalkTemplate = makeTaggedTemplate(new Chalk({level: 3}));
6
7console.log(template('Today is {red hot}'));
8console.log(chalkTemplate`Today is {red hot}`);

Related

• chalk - Terminal string styling done right
• chalk-cli - Style text from the terminal

Maintainers

• Sindre Sorhus
• Josh Junon