has-color

WebJar for has-color

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

has-color
Last Version

Last Version

0.1.7
Release Date

Release Date

Type

Type

jar
Description

Description

has-color
WebJar for has-color
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/chalk/supports-color

Download has-color

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/has-color/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>has-color</artifactId>
    <version>0.1.7</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/has-color/
implementation 'org.webjars.npm:has-color:0.1.7'
// https://jarcasting.com/artifacts/org.webjars.npm/has-color/
implementation ("org.webjars.npm:has-color:0.1.7")
'org.webjars.npm:has-color:jar:0.1.7'
<dependency org="org.webjars.npm" name="has-color" rev="0.1.7">
  <artifact name="has-color" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='has-color', version='0.1.7')
)
libraryDependencies += "org.webjars.npm" % "has-color" % "0.1.7"
[org.webjars.npm/has-color "0.1.7"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

supports-color

Detect whether a terminal supports color

Install

$ npm install supports-color

Usage

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)');
}

API

Returns an Object with a stdout and stderr property for testing either streams. Each property is an Object, or false if color is not supported.

The stdout/stderr objects specifies a level of support for color through a .level property and a corresponding flag:

  • .level = 1 and .hasBasic = true: Basic color support (16 colors)
  • .level = 2 and .has256 = true: 256 color support
  • .level = 3 and .has16m = true: Truecolor support (16 million colors)

require('supports-color').supportsColor(stream, options?)

Additionally, supports-color exposes the .supportsColor() function that takes an arbitrary write stream (e.g. process.stdout) and an optional options object to (re-)evaluate color support for an arbitrary stream.

For example, require('supports-color').stdout is the equivalent of require('supports-color').supportsColor(process.stdout).

The options object supports a single boolean property sniffFlags. By default it is true, which instructs supportsColor() to sniff process.argv for the multitude of --color flags (see Info below). If false, then process.argv is not considered when determining color support.

Info

It obeys the --color and --no-color CLI flags.

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.

Related

Maintainers


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

org.webjars.npm

chalk

Terminal string styling done right

Versions

Version
0.1.7
0.1.0