supports-color 8.1.1 → 9.1.0

package/browser.js

@@ -1,24 +1,17 @@
 /* eslint-env browser */
-'use strict';
 
-function getChromeVersion() {
-	const matches = /(Chrome|Chromium)\/(?<chromeVersion>\d+)\./.exec(navigator.userAgent);
+const isBlinkBasedBrowser = /\b(Chrome|Chromium)\//.test(navigator.userAgent);
 
-	if (!matches) {
-		return;
-	}
-
-	return Number.parseInt(matches.groups.chromeVersion, 10);
-}
-
-const colorSupport = getChromeVersion() >= 69 ? {
+const colorSupport = isBlinkBasedBrowser ? {
 	level: 1,
 	hasBasic: true,
 	has256: false,
-	has16m: false
+	has16m: false,
 } : false;
 
-module.exports = {
+const supportsColor = {
 	stdout: colorSupport,
-	stderr: colorSupport
+	stderr: colorSupport,
 };
+
+export default supportsColor;

package/index.d.ts

@@ -0,0 +1,55 @@
+import {WriteStream} from 'node:tty';
+
+export interface Options {
+	/**
+	Whether `process.argv` should be sniffed for `--color` and `--no-color` flags.
+
+	@default true
+	*/
+	readonly sniffFlags?: boolean;
+}
+
+/**
+Levels:
+- `0` - All colors disabled.
+- `1` - Basic 16 colors support.
+- `2` - ANSI 256 colors support.
+- `3` - Truecolor 16 million colors support.
+*/
+export type ColorSupportLevel = 0 | 1 | 2 | 3;
+
+/**
+Detect whether the terminal supports color.
+*/
+export interface ColorSupport {
+	/**
+	The color level.
+	*/
+	level: ColorSupportLevel;
+
+	/**
+	Whether basic 16 colors are supported.
+	*/
+	hasBasic: boolean;
+
+	/**
+	Whether ANSI 256 colors are supported.
+	*/
+	has256: boolean;
+
+	/**
+	Whether Truecolor 16 million colors are supported.
+	*/
+	has16m: boolean;
+}
+
+export type ColorInfo = ColorSupport | false;
+
+export function createSupportsColor(stream: WriteStream, options?: Options): ColorInfo;
+
+declare const supportsColor: {
+	stdout: ColorInfo;
+	stderr: ColorInfo;
+};
+
+export default supportsColor;

package/index.js

@@ -1,20 +1,31 @@
-'use strict';
-const os = require('os');
-const tty = require('tty');
-const hasFlag = require('has-flag');
+import process from 'node:process';
+import os from 'node:os';
+import tty from 'node:tty';
+
+// From: https://github.com/sindresorhus/has-flag/blob/main/index.js
+function hasFlag(flag, argv = process.argv) {
+	const prefix = flag.startsWith('-') ? '' : (flag.length === 1 ? '-' : '--');
+	const position = argv.indexOf(prefix + flag);
+	const terminatorPosition = argv.indexOf('--');
+	return position !== -1 && (terminatorPosition === -1 || position < terminatorPosition);
+}
 
 const {env} = process;
 
 let flagForceColor;
-if (hasFlag('no-color') ||
-	hasFlag('no-colors') ||
-	hasFlag('color=false') ||
-	hasFlag('color=never')) {
+if (
+	hasFlag('no-color')
+	|| hasFlag('no-colors')
+	|| hasFlag('color=false')
+	|| hasFlag('color=never')
+) {
 	flagForceColor = 0;
-} else if (hasFlag('color') ||
-	hasFlag('colors') ||
-	hasFlag('color=true') ||
-	hasFlag('color=always')) {
+} else if (
+	hasFlag('color')
+	|| hasFlag('colors')
+	|| hasFlag('color=true')
+	|| hasFlag('color=always')
+) {
 	flagForceColor = 1;
 }
 
@@ -41,11 +52,11 @@ function translateLevel(level) {
 		level,
 		hasBasic: true,
 		has256: level >= 2,
-		has16m: level >= 3
+		has16m: level >= 3,
 	};
 }
 
-function supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
+function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
 	const noFlagForceColor = envForceColor();
 	if (noFlagForceColor !== undefined) {
 		flagForceColor = noFlagForceColor;
@@ -58,9 +69,9 @@ function supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
 	}
 
 	if (sniffFlags) {
-		if (hasFlag('color=16m') ||
-			hasFlag('color=full') ||
-			hasFlag('color=truecolor')) {
+		if (hasFlag('color=16m')
+			|| hasFlag('color=full')
+			|| hasFlag('color=truecolor')) {
 			return 3;
 		}
 
@@ -84,10 +95,10 @@ function supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
 		// Windows 10 build 14931 is the first release that supports 16m/TrueColor.
 		const osRelease = os.release().split('.');
 		if (
-			Number(osRelease[0]) >= 10 &&
-			Number(osRelease[2]) >= 10586
+			Number(osRelease[0]) >= 10
+			&& Number(osRelease[2]) >= 10_586
 		) {
-			return Number(osRelease[2]) >= 14931 ? 3 : 2;
+			return Number(osRelease[2]) >= 14_931 ? 3 : 2;
 		}
 
 		return 1;
@@ -136,17 +147,18 @@ function supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
 	return min;
 }
 
-function getSupportLevel(stream, options = {}) {
-	const level = supportsColor(stream, {
+export function createSupportsColor(stream, options = {}) {
+	const level = _supportsColor(stream, {
 		streamIsTTY: stream && stream.isTTY,
-		...options
+		...options,
 	});
 
 	return translateLevel(level);
 }
 
-module.exports = {
-	supportsColor: getSupportLevel,
-	stdout: getSupportLevel({isTTY: tty.isatty(1)}),
-	stderr: getSupportLevel({isTTY: tty.isatty(2)})
+const supportsColor = {
+	stdout: createSupportsColor({isTTY: tty.isatty(1)}),
+	stderr: createSupportsColor({isTTY: tty.isatty(2)}),
 };
+
+export default supportsColor;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "supports-color",
-	"version": "8.1.1",
+	"version": "9.1.0",
 	"description": "Detect whether a terminal supports color",
 	"license": "MIT",
 	"repository": "chalk/supports-color",
@@ -10,20 +10,23 @@
 		"email": "sindresorhus@gmail.com",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": {
+		"node": "./index.js",
+		"default": "./browser.js"
+	},
 	"engines": {
-		"node": ">=10"
+		"node": ">=12"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"//test": "xo && ava && tsd",
+		"test": "xo && tsd"
 	},
 	"files": [
 		"index.js",
+		"index.d.ts",
 		"browser.js"
 	],
-	"exports": {
-		"node": "./index.js",
-		"default": "./browser.js"
-	},
 	"keywords": [
 		"color",
 		"colour",
@@ -46,13 +49,12 @@
 		"truecolor",
 		"16m"
 	],
-	"dependencies": {
-		"has-flag": "^4.0.0"
-	},
 	"devDependencies": {
-		"ava": "^2.4.0",
-		"import-fresh": "^3.2.2",
-		"xo": "^0.35.0"
-	},
-	"browser": "browser.js"
+		"@types/node": "^16.11.7",
+		"ava": "^3.15.0",
+		"import-fresh": "^3.3.0",
+		"tsd": "^0.18.0",
+		"typescript": "^4.4.3",
+		"xo": "^0.44.0"
+	}
 }

package/readme.md

@@ -11,7 +11,7 @@ $ npm install supports-color
 ## Usage
 
 ```js
-const supportsColor = require('supports-color');
+import supportsColor from 'supports-color';
 
 if (supportsColor.stdout) {
 	console.log('Terminal stdout supports color');
@@ -28,7 +28,7 @@ if (supportsColor.stderr.has16m) {
 
 ## 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.
+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:
 
@@ -36,13 +36,23 @@ The `stdout`/`stderr` objects specifies a level of support for color through a `
 - `.level = 2` and `.has256 = true`: 256 color support
 - `.level = 3` and `.has16m = true`: Truecolor support (16 million colors)
 
-### `require('supports-color').supportsColor(stream, options?)`
+### Custom instance
 
-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.
+The package also exposes the named export `createSupportColor` function that takes an arbitrary write stream (for example, `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)`.
+```js
+import {createSupportsColor} from 'supports-color';
+
+const stdoutSupportsColor = createSupportsColor(process.stdout);
+
+if (stdoutSupportsColor) {
+	console.log('Terminal stdout supports color');
+}
+
+// `stdoutSupportsColor` is the same as `supportsColor.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.
+The options object supports a single boolean property `sniffFlags`. By default it is `true`, which instructs the detection 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
 
@@ -56,6 +66,8 @@ Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=
 
 - [supports-color-cli](https://github.com/chalk/supports-color-cli) - CLI for this module
 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
+- [is-unicode-supported](https://github.com/sindresorhus/is-unicode-supported) - Detect whether the terminal supports Unicode
+- [is-interactive](https://github.com/sindresorhus/is-interactive) - Check if stdout or stderr is interactive
 
 ## Maintainers