Socket
Socket
Sign inDemoInstall

chalk

Package Overview
Dependencies
2
Maintainers
1
Versions
38
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

chalk

Terminal string styling done right


Version published
Maintainers
1
Weekly downloads
288,457,168
decreased by-7.97%

Weekly downloads

Package description

What is chalk?

The chalk npm package is a popular library for styling and coloring text in the terminal. It provides an easy-to-use API for applying various text styles, such as color, background color, bold, underline, and more, to console output in Node.js applications.

What are chalk's main functionalities?

Text color

Change the color of the text. In this example, the text 'Hello world!' will be printed in blue.

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

Background color

Change the background color of the text. Here, 'Hello world!' will have a red background.

console.log(chalk.bgRed('Hello world!'));

Text styles

Apply text styles such as bold, italic, underline, etc. This code sample makes the text 'Hello world!' bold.

console.log(chalk.bold('Hello world!'));

Combining styles

Combine multiple styles together. The text 'Hello world!' will be bold with blue text and a red background.

console.log(chalk.blue.bgRed.bold('Hello world!'));

Composing multiple styles

Create reusable composed style functions. This creates an 'error' style that is bold and red, which can be used to print error messages.

const error = chalk.bold.red; console.log(error('Error!'));

Template literals

Use tagged template literals for styling. This allows for more readable code when applying multiple styles.

console.log(chalk`{blue.bold Hello} {red world!}`);

Other packages similar to chalk

Readme

Source

chalk Build Status

Terminal string styling done right.

colors.js is currently the most popular string styling module, but it has serious deficiencies like extending String.prototype which causes all kinds of problems. Although there are other ones, they either do too much or not enough.

Chalk is a clean and focused alternative.

screenshot

Why

  • Doesn't extend String.prototype
  • Expressive API
  • Clean and focused
  • Auto-detects color support
  • Actively maintained

Install

Install with npm: npm install --save chalk

Example

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

var chalk = require('chalk');

// style a string
console.log(chalk.blue('Hello world!'));

// combine styled and normal strings
console.log(chalk.blue('Hello') + 'World' + chalk.red('!'));

// compose multiple styles using the chainable API
console.log(chalk.blue.bgRed.bold('Hello world!'));

// nest styles
chalk.red('Hello' + chalk.underline.bgBlue('world') + '!');

You can easily define your own themes.

var chalk = require('chalk');
var error = chalk.bold.red;
console.log(error('Error!'));

API

chalk.<style>[.<style>...](string)

Chain styles and call the last one as a method with a string argument.

chalk.enabled

Color support is automatically detected, but you can override it.

chalk.supportsColor

Detect whether the terminal supports color.

Can be overridden by the user with the flags --color and --no-color.

Used internally and handled for you, but exposed for convenience.

chalk.styles

Exposes the styles as ANSI escape codes.

var chalk = require('chalk');

console.log(chalk.styles.red);
//=> ['\x1b[31m', '\x1b[39m']

console.log(chalk.styles.red[0] + 'Hello' + chalk.styles.red[1]);
// first item is the style escape code and second is the reset escape code

chalk.stripColor(string)

Strip color from a string.

Styles

General

  • reset
  • bold
  • italic
  • underline
  • inverse
  • strikethrough

Text colors

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white
  • gray

Background colors

  • bgBlack
  • bgRed
  • bgGreen
  • bgYellow
  • bgBlue
  • bgMagenta
  • bgCyan
  • bgWhite

License

MIT License • © Sindre Sorhus

Keywords

FAQs

Last updated on 29 Aug 2013

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc