diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 5cd8789..d588995 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -13,10 +13,9 @@ jobs:
- 18
- 16
- 14
- - 12
steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-node@v3
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm install
diff --git a/.replit b/.replit
deleted file mode 100644
index cf3930d..0000000
--- a/.replit
+++ /dev/null
@@ -1,2 +0,0 @@
-language = "nodejs"
-run = "cd examples && node rainbow"
diff --git a/examples/rainbow.js b/examples/rainbow.js
index 3501dab..5b2b1d2 100644
--- a/examples/rainbow.js
+++ b/examples/rainbow.js
@@ -1,6 +1,6 @@
+import {setTimeout as delay} from 'node:timers/promises';
import convertColor from 'color-convert';
import updateLog from 'log-update';
-import delay from 'yoctodelay';
import chalk from '../source/index.js';
const ignoreChars = /[^!-~]/g;
@@ -10,7 +10,7 @@ function rainbow(string, offset) {
return string;
}
- const hueStep = 360 / string.replace(ignoreChars, '').length;
+ const hueStep = 360 / string.replaceAll(ignoreChars, '').length;
let hue = offset % 360;
const characters = [];
@@ -33,8 +33,6 @@ async function animateString(string) {
}
}
-(async () => {
- console.log();
- await animateString('We hope you enjoy Chalk! <3');
- console.log();
-})();
+console.log();
+await animateString('We hope you enjoy Chalk! <3');
+console.log();
diff --git a/package.json b/package.json
index cc07db0..c9e0dc5 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "chalk",
- "version": "5.1.2",
+ "version": "5.6.2",
"description": "Terminal string styling done right",
"license": "MIT",
"repository": "chalk/chalk",
@@ -16,6 +16,7 @@
}
},
"types": "./source/index.d.ts",
+ "sideEffects": false,
"engines": {
"node": "^12.17.0 || ^14.13 || >=16.0.0"
},
@@ -58,7 +59,7 @@
"log-update": "^5.0.0",
"matcha": "^0.7.0",
"tsd": "^0.19.0",
- "xo": "^0.52.4",
+ "xo": "^0.57.0",
"yoctodelay": "^2.0.0"
},
"xo": {
@@ -66,7 +67,8 @@
"unicorn/prefer-string-slice": "off",
"@typescript-eslint/consistent-type-imports": "off",
"@typescript-eslint/consistent-type-exports": "off",
- "@typescript-eslint/consistent-type-definitions": "off"
+ "@typescript-eslint/consistent-type-definitions": "off",
+ "unicorn/expiring-todo-comments": "off"
}
},
"c8": {
diff --git a/readme.md b/readme.md
index f18b2aa..ce1f3f3 100644
--- a/readme.md
+++ b/readme.md
@@ -12,71 +12,13 @@
[](https://codecov.io/gh/chalk/chalk)
[](https://www.npmjs.com/package/chalk?activeTab=dependents)
[](https://www.npmjs.com/package/chalk)
-[](https://repl.it/github/chalk/chalk)
-
+## Info
----
-
-
-
----
-
-
+- [Why not switch to a smaller coloring package?](https://github.com/chalk/chalk?tab=readme-ov-file#why-not-switch-to-a-smaller-coloring-package)
+- See [yoctocolors](https://github.com/sindresorhus/yoctocolors) for a smaller alternative
## Highlights
@@ -89,7 +31,7 @@
- Doesn't extend `String.prototype`
- Clean and focused
- Actively maintained
-- [Used by ~86,000 packages](https://www.npmjs.com/browse/depended/chalk) as of October 4, 2022
+- [Used by ~115,000 packages](https://www.npmjs.com/browse/depended/chalk) as of July 4, 2024
## Install
@@ -236,10 +178,10 @@ console.log(foregroundColorNames.includes('pink'));
- `italic` - Make the text italic. *(Not widely supported)*
- `underline` - Put a horizontal line below the text. *(Not widely supported)*
- `overline` - Put a horizontal line above the text. *(Not widely supported)*
-- `inverse`- Invert background and foreground colors.
+- `inverse` - Invert background and foreground colors.
- `hidden` - Print the text but make it invisible.
- `strikethrough` - Puts a horizontal line through the center of the text. *(Not widely supported)*
-- `visible`- Print the text only when Chalk has a color level above zero. Can be useful for things that are purely cosmetic.
+- `visible` - Print the text only when Chalk has a color level above zero. Can be useful for things that are purely cosmetic.
### Colors
@@ -281,7 +223,7 @@ console.log(foregroundColorNames.includes('pink'));
## 256 and Truecolor color support
-Chalk supports 256 colors and [Truecolor](https://gist.github.com/XVilka/8346728) (16 million colors) on supported terminal apps.
+Chalk supports 256 colors and [Truecolor](https://github.com/termstandard/colors) (16 million colors) on supported terminal apps.
Colors are downsampled from 16 million RGB values to an ANSI color format that is supported by the terminal emulator (or by specifying `{level: n}` as a Chalk option). For example, Chalk configured to run at level 1 (basic color support) will downsample an RGB value of #FF0000 (red) to 31 (ANSI escape for red).
@@ -309,9 +251,25 @@ Since Chrome 69, ANSI escape codes are natively supported in the developer conso
If you're on Windows, do yourself a favor and use [Windows Terminal](https://github.com/microsoft/terminal) instead of `cmd.exe`.
-## Origin story
+## FAQ
-[colors.js](https://github.com/Marak/colors.js) used to be the most popular string styling module, but it has serious deficiencies like extending `String.prototype` which causes all kinds of [problems](https://github.com/yeoman/yo/issues/68) and the package is unmaintained. Although there are other packages, they either do too much or not enough. Chalk is a clean and focused alternative.
+### Why not switch to a smaller coloring package?
+
+Chalk may be larger, but there is a reason for that. It offers a more user-friendly API, well-documented types, supports millions of colors, and covers edge cases that smaller alternatives miss. Chalk is mature, reliable, and built to last.
+
+But beyond the technical aspects, there's something more critical: trust and long-term maintenance. I have been active in open source for over a decade, and I'm committed to keeping Chalk maintained. Smaller packages might seem appealing now, but there's no guarantee they will be around for the long term, or that they won't become malicious over time.
+
+Chalk is also likely already in your dependency tree (since 100K+ packages depend on it), so switching won’t save space—in fact, it might increase it. npm deduplicates dependencies, so multiple Chalk instances turn into one, but adding another package alongside it will increase your overall size.
+
+If the goal is to clean up the ecosystem, switching away from Chalk won’t even make a dent. The real problem lies with packages that have very deep dependency trees (for example, those including a lot of polyfills). Chalk has no dependencies. It's better to focus on impactful changes rather than minor optimizations.
+
+If absolute package size is important to you, I also maintain [yoctocolors](https://github.com/sindresorhus/yoctocolors), one of the smallest color packages out there.
+
+*\- [Sindre](https://github.com/sindresorhus)*
+
+### But the smaller coloring package has benchmarks showing it is faster
+
+[Micro-benchmarks are flawed](https://sindresorhus.com/blog/micro-benchmark-fallacy) because they measure performance in unrealistic, isolated scenarios, often giving a distorted view of real-world performance. Don't believe marketing fluff. All the coloring packages are more than fast enough.
## Related
@@ -331,6 +289,8 @@ If you're on Windows, do yourself a favor and use [Windows Terminal](https://git
- [chalk-pipe](https://github.com/LitoMore/chalk-pipe) - Create chalk style schemes with simpler style strings
- [terminal-link](https://github.com/sindresorhus/terminal-link) - Create clickable links in the terminal
+*(Not accepting additional entries)*
+
## Maintainers
- [Sindre Sorhus](https://github.com/sindresorhus)
diff --git a/source/index.d.ts b/source/index.d.ts
index b0cd2ae..8295d92 100644
--- a/source/index.d.ts
+++ b/source/index.d.ts
@@ -1,7 +1,12 @@
// TODO: Make it this when TS suports that.
// import {ModifierName, ForegroundColor, BackgroundColor, ColorName} from '#ansi-styles';
// import {ColorInfo, ColorSupportLevel} from '#supports-color';
-import {ModifierName, ForegroundColorName, BackgroundColorName, ColorName} from './vendor/ansi-styles/index.js';
+import {
+ ModifierName,
+ ForegroundColorName,
+ BackgroundColorName,
+ ColorName,
+} from './vendor/ansi-styles/index.js';
import {ColorInfo, ColorSupportLevel} from './vendor/supports-color/index.js';
export interface Options {
diff --git a/source/index.test-d.ts b/source/index.test-d.ts
index e729675..92da39d 100644
--- a/source/index.test-d.ts
+++ b/source/index.test-d.ts
@@ -1,7 +1,22 @@
-import {expectType, expectAssignable, expectError, expectDeprecated} from 'tsd';
+import {
+ expectType,
+ expectAssignable,
+ expectError,
+ expectDeprecated,
+} from 'tsd';
import chalk, {
- Chalk, ChalkInstance, ColorInfo, ColorSupport, ColorSupportLevel, chalkStderr, supportsColor, supportsColorStderr,
- ModifierName, ForegroundColorName, BackgroundColorName, ColorName,
+ Chalk,
+ ChalkInstance,
+ ColorInfo,
+ ColorSupport,
+ ColorSupportLevel,
+ chalkStderr,
+ supportsColor,
+ supportsColorStderr,
+ ModifierName,
+ ForegroundColorName,
+ BackgroundColorName,
+ ColorName,
Modifiers,
} from './index.js';
diff --git a/source/vendor/supports-color/browser.js b/source/vendor/supports-color/browser.js
index 4e75e86..fbb6ce0 100644
--- a/source/vendor/supports-color/browser.js
+++ b/source/vendor/supports-color/browser.js
@@ -1,15 +1,30 @@
/* eslint-env browser */
-const isBlinkBasedBrowser = navigator.userAgentData
- ? navigator.userAgentData.brands.some(({brand}) => brand === 'Chromium')
- : /\b(Chrome|Chromium)\//.test(navigator.userAgent);
+const level = (() => {
+ if (!('navigator' in globalThis)) {
+ return 0;
+ }
-const colorSupport = isBlinkBasedBrowser ? {
- level: 1,
+ if (globalThis.navigator.userAgentData) {
+ const brand = navigator.userAgentData.brands.find(({brand}) => brand === 'Chromium');
+ if (brand && brand.version > 93) {
+ return 3;
+ }
+ }
+
+ if (/\b(Chrome|Chromium)\//.test(globalThis.navigator.userAgent)) {
+ return 1;
+ }
+
+ return 0;
+})();
+
+const colorSupport = level !== 0 && {
+ level,
hasBasic: true,
- has256: false,
- has16m: false,
-} : false;
+ has256: level >= 2,
+ has16m: level >= 3,
+};
const supportsColor = {
stdout: colorSupport,
diff --git a/source/vendor/supports-color/index.d.ts b/source/vendor/supports-color/index.d.ts
index 98e3618..db44a78 100644
--- a/source/vendor/supports-color/index.d.ts
+++ b/source/vendor/supports-color/index.d.ts
@@ -1,13 +1,13 @@
-import {WriteStream} from 'node:tty';
+import type {WriteStream} from 'node:tty';
-export interface Options {
+export type Options = {
/**
Whether `process.argv` should be sniffed for `--color` and `--no-color` flags.
@default true
*/
readonly sniffFlags?: boolean;
-}
+};
/**
Levels:
@@ -21,7 +21,7 @@ export type ColorSupportLevel = 0 | 1 | 2 | 3;
/**
Detect whether the terminal supports color.
*/
-export interface ColorSupport {
+export type ColorSupport = {
/**
The color level.
*/
@@ -41,11 +41,11 @@ export interface ColorSupport {
Whether Truecolor 16 million colors are supported.
*/
has16m: boolean;
-}
+};
export type ColorInfo = ColorSupport | false;
-export function createSupportsColor(stream: WriteStream, options?: Options): ColorInfo;
+export function createSupportsColor(stream?: WriteStream, options?: Options): ColorInfo;
declare const supportsColor: {
stdout: ColorInfo;
diff --git a/source/vendor/supports-color/index.js b/source/vendor/supports-color/index.js
index 55f813c..265d7f8 100644
--- a/source/vendor/supports-color/index.js
+++ b/source/vendor/supports-color/index.js
@@ -3,7 +3,8 @@ 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) {
+/// function hasFlag(flag, argv = globalThis.Deno?.args ?? process.argv) {
+function hasFlag(flag, argv = globalThis.Deno ? globalThis.Deno.args : process.argv) {
const prefix = flag.startsWith('-') ? '' : (flag.length === 1 ? '-' : '--');
const position = argv.indexOf(prefix + flag);
const terminatorPosition = argv.indexOf('--');
@@ -80,6 +81,12 @@ function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
}
}
+ // Check for Azure DevOps pipelines.
+ // Has to be above the `!streamIsTTY` check.
+ if ('TF_BUILD' in env && 'AGENT_NAME' in env) {
+ return 1;
+ }
+
if (haveStream && !streamIsTTY && forceColor === undefined) {
return 0;
}
@@ -105,7 +112,11 @@ function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
}
if ('CI' in env) {
- if (['TRAVIS', 'CIRCLECI', 'APPVEYOR', 'GITLAB_CI', 'GITHUB_ACTIONS', 'BUILDKITE', 'DRONE'].some(sign => sign in env) || env.CI_NAME === 'codeship') {
+ if (['GITHUB_ACTIONS', 'GITEA_ACTIONS', 'CIRCLECI'].some(key => key in env)) {
+ return 3;
+ }
+
+ if (['TRAVIS', 'APPVEYOR', 'GITLAB_CI', 'BUILDKITE', 'DRONE'].some(sign => sign in env) || env.CI_NAME === 'codeship') {
return 1;
}
@@ -116,12 +127,19 @@ function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
return /^(9\.(0*[1-9]\d*)\.|\d{2,}\.)/.test(env.TEAMCITY_VERSION) ? 1 : 0;
}
- // Check for Azure DevOps pipelines
- if ('TF_BUILD' in env && 'AGENT_NAME' in env) {
- return 1;
+ if (env.COLORTERM === 'truecolor') {
+ return 3;
}
- if (env.COLORTERM === 'truecolor') {
+ if (env.TERM === 'xterm-kitty') {
+ return 3;
+ }
+
+ if (env.TERM === 'xterm-ghostty') {
+ return 3;
+ }
+
+ if (env.TERM === 'wezterm') {
return 3;
}
@@ -129,10 +147,13 @@ function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
const version = Number.parseInt((env.TERM_PROGRAM_VERSION || '').split('.')[0], 10);
switch (env.TERM_PROGRAM) {
- case 'iTerm.app':
+ case 'iTerm.app': {
return version >= 3 ? 3 : 2;
- case 'Apple_Terminal':
+ }
+
+ case 'Apple_Terminal': {
return 2;
+ }
// No default
}
}
-
- 
-
- 
- 
- 
-