ansi-styles
Advanced tools
Package description
The ansi-styles package provides a collection of ANSI escape codes for styling strings in the terminal. These codes can be used to add color, background color, and various text styles such as bold, italic, underline, etc., to console output.
Color
This feature allows you to apply text color to your strings. The code sample demonstrates how to color the text 'Hello world!' in green.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.green.open}Hello world!${ansiStyles.green.close}`);Background Color
This feature allows you to apply background color to your strings. The code sample demonstrates how to set the background color of the text 'Hello world!' to blue.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bgBlue.open}Hello world!${ansiStyles.bgBlue.close}`);Text Styles
This feature allows you to apply text styles like bold, italic, underline, etc. The code sample demonstrates how to make the text 'Hello world!' bold.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bold.open}Hello world!${ansiStyles.bold.close}`);Chalk is a popular npm package that allows you to style terminal strings. It is more user-friendly than ansi-styles as it provides a chainable API and template literal support, making it easier to combine styles.
Colors is another npm package for adding colors to terminal output. It extends String.prototype to add color properties, allowing for a syntax like 'Hello world!'.green. It is less explicit than ansi-styles and can lead to conflicts with other String prototype extensions.
CLI-color is a package for creating colored CLI output. It offers a similar feature set to ansi-styles but also includes additional functionality for cursor movement and window size detection.
Readme
ANSI escape codes for styling strings in the terminal
You probably want the higher-level chalk module for styling your strings.
$ npm install --save ansi-styles
var ansi = require('ansi-styles');
console.log(ansi.green.open + 'Hello world!' + ansi.green.close);
Each style has an open and close property.
resetbolddimitalic (not widely supported)underlineinversehiddenstrikethrough (not widely supported)blackredgreenyellowbluemagentacyanwhitegraybgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhiteBy default you get a map of styles, but the styles are also available as groups. They are non-enumerable so they don't show up unless you access them explicitly. This makes it easier to expose only a subset in a higher-level module.
ansi.modifiersansi.colorsansi.bgColorsconsole.log(ansi.colors.green.open);
MIT © Sindre Sorhus
FAQs
ANSI escape codes for styling strings in the terminal
The npm package ansi-styles receives a total of 295,449,809 weekly downloads. As such, ansi-styles popularity was classified as popular.
We found that ansi-styles demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.