supports-color
Advanced tools
Package description
The supports-color npm package is used to detect whether a terminal supports color and, if so, which kinds of color. It can be used to tailor output to the terminal's capabilities, avoiding the use of color when it's not supported and enabling it when possible. This can help improve the readability and aesthetics of command-line tool output.
Detecting Color Support
This feature allows you to check if the terminal supports color, and if so, what level of color support it has (basic colors, 256 colors, or 16 million colors).
const supportsColor = require('supports-color');
if (supportsColor.stdout) {
console.log('Terminal stdout supports color');
}
if (supportsColor.stdout.has256) {
console.log('Terminal stdout supports 256 colors');
}
if (supportsColor.stderr.has16m) {
console.log('Terminal stderr supports 16 million colors (truecolor)');
}Forcing Color Support
This feature allows you to force color support in the terminal. This can be useful for testing or when running in environments where color support is not detected correctly.
const supportsColor = require('supports-color');
process.env.FORCE_COLOR = '1';
supportsColor.stdout.level = 1;
console.log('Forced color support level to basic colors');Chalk is a popular npm package that allows you to style and colorize text in the terminal. It is more feature-rich than supports-color, providing an easy-to-use API for applying styles, but it also uses supports-color internally to determine color support.
ansi-colors is another npm package for coloring terminal text. It focuses on being lightweight and has no dependencies. It offers a similar API to chalk but does not have the same level of abstraction or convenience methods.
cli-color is an npm package that provides a function-based API for styling terminal text. It offers color support detection as well as a wide range of text formatting options. It is more comprehensive than supports-color but also more complex to use.
Readme
Detect whether a terminal supports color
$ npm install --save supports-color
var supportsColor = require('supports-color');
if (supportsColor) {
console.log('Terminal supports color');
}
It obeys the --color and --no-color CLI flags.
$ npm install --global supports-color
$ supports-color --help
Usage
supports-color
Exits with code 0 if color is supported and 1 if not
MIT © Sindre Sorhus
FAQs
Detect whether a terminal supports color
The npm package supports-color receives a total of 209,354,845 weekly downloads. As such, supports-color popularity was classified as popular.
We found that supports-color demonstrated a healthy version release cadence and project activity because the last version was released less than 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.