@cjser/chalk 5.6.2-cjser.2 → 6.0.0-cjser.2

package/dist-cjser/index.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/chalk/source/index.js
+// packages/@cjser/chalk.tmp-26-1785083112196/source/index.js
 var index_exports = {};
 __export(index_exports, {
   Chalk: () => Chalk,
@@ -41,15 +41,48 @@ __export(index_exports, {
   modifierNames: () => modifierNames,
   modifiers: () => modifierNames,
   supportsColor: () => stdoutColor,
-  supportsColorStderr: () => stderrColor
+  supportsColorStderr: () => stderrColor,
+  underlineColorNames: () => underlineColorNames
 });
 module.exports = __toCommonJS(index_exports);
 
-// packages/@cjser/chalk/source/vendor/ansi-styles/index.js
+// packages/@cjser/chalk.tmp-26-1785083112196/source/utilities.js
+function stringReplaceAll(string, substring, postfix) {
+  let index = string.indexOf(substring);
+  if (index === -1) {
+    return string;
+  }
+  const substringLength = substring.length;
+  let endIndex = 0;
+  let returnValue = "";
+  do {
+    returnValue += string.slice(endIndex, index) + substring + postfix;
+    endIndex = index + substringLength;
+    index = string.indexOf(substring, endIndex);
+  } while (index !== -1);
+  returnValue += string.slice(endIndex);
+  return returnValue;
+}
+function stringEncaseCRLFWithFirstIndex(string, prefix, postfix, index) {
+  let endIndex = 0;
+  let returnValue = "";
+  do {
+    const isGotCR = string[index - 1] === "\r";
+    returnValue += string.slice(endIndex, isGotCR ? index - 1 : index) + prefix + (isGotCR ? "\r\n" : "\n") + postfix;
+    endIndex = index + 1;
+    index = string.indexOf("\n", endIndex);
+  } while (index !== -1);
+  returnValue += string.slice(endIndex);
+  return returnValue;
+}
+
+// packages/@cjser/chalk.tmp-26-1785083112196/source/vendor/ansi-styles/index.js
 var ANSI_BACKGROUND_OFFSET = 10;
+var ANSI_UNDERLINE_OFFSET = 20;
 var wrapAnsi16 = (offset = 0) => (code) => `\x1B[${code + offset}m`;
 var wrapAnsi256 = (offset = 0) => (code) => `\x1B[${38 + offset};5;${code}m`;
 var wrapAnsi16m = (offset = 0) => (red, green, blue) => `\x1B[${38 + offset};2;${red};${green};${blue}m`;
+var wrapUnderlineAnsi = (code) => `\x1B[58;5;${code < 90 ? code - 30 : code - 90 + 8}m`;
 var styles = {
   modifier: {
     reset: [0, 0],
@@ -58,6 +91,11 @@ var styles = {
     dim: [2, 22],
     italic: [3, 23],
     underline: [4, 24],
+    // Extended underline styles (`SGR 4:x` sub-parameters). Not in upstream `ansi-styles`.
+    underlineDouble: ["4:2", 24],
+    underlineCurly: ["4:3", 24],
+    underlineDotted: ["4:4", 24],
+    underlineDashed: ["4:5", 24],
     overline: [53, 55],
     inverse: [7, 27],
     hidden: [8, 28],
@@ -108,11 +146,36 @@ var styles = {
     bgMagentaBright: [105, 49],
     bgCyanBright: [106, 49],
     bgWhiteBright: [107, 49]
+  },
+  // Underline color (`SGR 58`/`59`). Not in upstream `ansi-styles`.
+  underlineColor: {
+    underlineBlack: ["58;5;0", 59],
+    underlineRed: ["58;5;1", 59],
+    underlineGreen: ["58;5;2", 59],
+    underlineYellow: ["58;5;3", 59],
+    underlineBlue: ["58;5;4", 59],
+    underlineMagenta: ["58;5;5", 59],
+    underlineCyan: ["58;5;6", 59],
+    underlineWhite: ["58;5;7", 59],
+    // Bright color
+    underlineBlackBright: ["58;5;8", 59],
+    underlineGray: ["58;5;8", 59],
+    // Alias of `underlineBlackBright`
+    underlineGrey: ["58;5;8", 59],
+    // Alias of `underlineBlackBright`
+    underlineRedBright: ["58;5;9", 59],
+    underlineGreenBright: ["58;5;10", 59],
+    underlineYellowBright: ["58;5;11", 59],
+    underlineBlueBright: ["58;5;12", 59],
+    underlineMagentaBright: ["58;5;13", 59],
+    underlineCyanBright: ["58;5;14", 59],
+    underlineWhiteBright: ["58;5;15", 59]
   }
 };
 var modifierNames = Object.keys(styles.modifier);
 var foregroundColorNames = Object.keys(styles.color);
 var backgroundColorNames = Object.keys(styles.bgColor);
+var underlineColorNames = Object.keys(styles.underlineColor);
 var colorNames = [...foregroundColorNames, ...backgroundColorNames];
 function assembleStyles() {
   const codes = /* @__PURE__ */ new Map();
@@ -123,7 +186,7 @@ function assembleStyles() {
         close: `\x1B[${style[1]}m`
       };
       group[styleName] = styles[styleName];
-      codes.set(style[0], style[1]);
+      codes.set(Number.parseInt(style[0], 10), style[1]);
     }
     Object.defineProperty(styles, groupName, {
       value: group,
@@ -136,12 +199,16 @@ function assembleStyles() {
   });
   styles.color.close = "\x1B[39m";
   styles.bgColor.close = "\x1B[49m";
+  styles.underlineColor.close = "\x1B[59m";
   styles.color.ansi = wrapAnsi16();
   styles.color.ansi256 = wrapAnsi256();
   styles.color.ansi16m = wrapAnsi16m();
   styles.bgColor.ansi = wrapAnsi16(ANSI_BACKGROUND_OFFSET);
   styles.bgColor.ansi256 = wrapAnsi256(ANSI_BACKGROUND_OFFSET);
   styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);
+  styles.underlineColor.ansi = wrapUnderlineAnsi;
+  styles.underlineColor.ansi256 = wrapAnsi256(ANSI_UNDERLINE_OFFSET);
+  styles.underlineColor.ansi16m = wrapAnsi16m(ANSI_UNDERLINE_OFFSET);
   Object.defineProperties(styles, {
     rgbToAnsi256: {
       value(red, green, blue) {
@@ -160,7 +227,7 @@ function assembleStyles() {
     },
     hexToRgb: {
       value(hex) {
-        const matches = /[a-f\d]{6}|[a-f\d]{3}/i.exec(hex.toString(16));
+        const matches = /[\da-f]{6}|[\da-f]{3}/i.exec(hex.toString(16));
         if (!matches) {
           return [0, 0, 0];
         }
@@ -170,7 +237,7 @@ function assembleStyles() {
         }
         const integer = Number.parseInt(colorString, 16);
         return [
-          /* eslint-disable no-bitwise */
+          /* eslint-disable no-bitwise -- We need the speed */
           integer >> 16 & 255,
           integer >> 8 & 255,
           integer & 255
@@ -231,7 +298,7 @@ function assembleStyles() {
 var ansiStyles = assembleStyles();
 var ansi_styles_default = ansiStyles;
 
-// packages/@cjser/chalk/source/vendor/supports-color/index.js
+// packages/@cjser/chalk.tmp-26-1785083112196/source/vendor/supports-color/index.js
 var import_node_process = __toESM(require("node:process"), 1);
 var import_node_os = __toESM(require("node:os"), 1);
 var import_node_tty = __toESM(require("node:tty"), 1);
@@ -248,16 +315,23 @@ if (hasFlag("no-color") || hasFlag("no-colors") || hasFlag("color=false") || has
 } else if (hasFlag("color") || hasFlag("colors") || hasFlag("color=true") || hasFlag("color=always")) {
   flagForceColor = 1;
 }
+function hasNumericForceColor() {
+  return /^\d+$/.test(env.FORCE_COLOR);
+}
 function envForceColor() {
-  if ("FORCE_COLOR" in env) {
-    if (env.FORCE_COLOR === "true") {
-      return 1;
-    }
-    if (env.FORCE_COLOR === "false") {
-      return 0;
-    }
-    return env.FORCE_COLOR.length === 0 ? 1 : Math.min(Number.parseInt(env.FORCE_COLOR, 10), 3);
+  if (!("FORCE_COLOR" in env)) {
+    return;
+  }
+  if (env.FORCE_COLOR === "false") {
+    return 0;
+  }
+  if (env.FORCE_COLOR === "true" || env.FORCE_COLOR.length === 0) {
+    return 1;
+  }
+  if (!hasNumericForceColor()) {
+    return;
   }
+  return Math.min(Number.parseInt(env.FORCE_COLOR, 10), 3);
 }
 function translateLevel(level) {
   if (level === 0) {
@@ -287,6 +361,9 @@ function _supportsColor(haveStream, { streamIsTTY, sniffFlags = true } = {}) {
       return 2;
     }
   }
+  if (forceColor !== void 0 && hasNumericForceColor()) {
+    return forceColor;
+  }
   if ("TF_BUILD" in env && "AGENT_NAME" in env) {
     return 1;
   }
@@ -314,7 +391,7 @@ function _supportsColor(haveStream, { streamIsTTY, sniffFlags = true } = {}) {
     return min;
   }
   if ("TEAMCITY_VERSION" in env) {
-    return /^(9\.(0*[1-9]\d*)\.|\d{2,}\.)/.test(env.TEAMCITY_VERSION) ? 1 : 0;
+    return /^(?:9\.0*[1-9]\d*\.|\d{2,}\.)/.test(env.TEAMCITY_VERSION) ? 1 : 0;
   }
   if (env.COLORTERM === "truecolor") {
     return 3;
@@ -329,7 +406,7 @@ function _supportsColor(haveStream, { streamIsTTY, sniffFlags = true } = {}) {
     return 3;
   }
   if ("TERM_PROGRAM" in env) {
-    const version = Number.parseInt((env.TERM_PROGRAM_VERSION || "").split(".")[0], 10);
+    const version = Number.parseInt((env.TERM_PROGRAM_VERSION || "").split(".", 1)[0], 10);
     switch (env.TERM_PROGRAM) {
       case "iTerm.app": {
         return version >= 3 ? 3 : 2;
@@ -339,7 +416,7 @@ function _supportsColor(haveStream, { streamIsTTY, sniffFlags = true } = {}) {
       }
     }
   }
-  if (/-256(color)?$/i.test(env.TERM)) {
+  if (/-256(?:color)?$/i.test(env.TERM)) {
     return 2;
   }
   if (/^screen|^xterm|^vt100|^vt220|^rxvt|color|ansi|cygwin|linux/i.test(env.TERM)) {
@@ -363,54 +440,34 @@ var supportsColor = {
 };
 var supports_color_default = supportsColor;
 
-// packages/@cjser/chalk/source/utilities.js
-function stringReplaceAll(string, substring, replacer) {
-  let index = string.indexOf(substring);
-  if (index === -1) {
-    return string;
-  }
-  const substringLength = substring.length;
-  let endIndex = 0;
-  let returnValue = "";
-  do {
-    returnValue += string.slice(endIndex, index) + substring + replacer;
-    endIndex = index + substringLength;
-    index = string.indexOf(substring, endIndex);
-  } while (index !== -1);
-  returnValue += string.slice(endIndex);
-  return returnValue;
-}
-function stringEncaseCRLFWithFirstIndex(string, prefix, postfix, index) {
-  let endIndex = 0;
-  let returnValue = "";
-  do {
-    const gotCR = string[index - 1] === "\r";
-    returnValue += string.slice(endIndex, gotCR ? index - 1 : index) + prefix + (gotCR ? "\r\n" : "\n") + postfix;
-    endIndex = index + 1;
-    index = string.indexOf("\n", endIndex);
-  } while (index !== -1);
-  returnValue += string.slice(endIndex);
-  return returnValue;
-}
-
-// packages/@cjser/chalk/source/index.js
+// packages/@cjser/chalk.tmp-26-1785083112196/source/index.js
 var { stdout: stdoutColor, stderr: stderrColor } = supports_color_default;
 var GENERATOR = /* @__PURE__ */ Symbol("GENERATOR");
 var STYLER = /* @__PURE__ */ Symbol("STYLER");
 var IS_EMPTY = /* @__PURE__ */ Symbol("IS_EMPTY");
-var levelMapping = [
-  "ansi",
-  "ansi",
-  "ansi256",
-  "ansi16m"
-];
+var LEVEL = /* @__PURE__ */ Symbol("LEVEL");
 var styles2 = /* @__PURE__ */ Object.create(null);
+var assertValidLevel = (level) => {
+  if (!Number.isSafeInteger(level) || level < 0 || level > 3) {
+    throw new Error("The `level` should be an integer from 0 to 3");
+  }
+};
+var levelDescriptor = {
+  enumerable: true,
+  get() {
+    return this[LEVEL];
+  },
+  set(level) {
+    assertValidLevel(level);
+    this[LEVEL] = level;
+  }
+};
 var applyOptions = (object, options = {}) => {
-  if (options.level && !(Number.isInteger(options.level) && options.level >= 0 && options.level <= 3)) {
-    throw new Error("The `level` option should be an integer from 0 to 3");
+  if (options.level !== void 0) {
+    assertValidLevel(options.level);
   }
   const colorLevel = stdoutColor ? stdoutColor.level : 0;
-  object.level = options.level === void 0 ? colorLevel : options.level;
+  object[LEVEL] = options.level === void 0 ? colorLevel : options.level;
 };
 var Chalk = class {
   constructor(options) {
@@ -443,56 +500,59 @@ styles2.visible = {
     return builder;
   }
 };
-var getModelAnsi = (model, level, type, ...arguments_) => {
+var createModelConverters = (model, type) => {
+  const style = ansi_styles_default[type];
   if (model === "rgb") {
-    if (level === "ansi16m") {
-      return ansi_styles_default[type].ansi16m(...arguments_);
-    }
-    if (level === "ansi256") {
-      return ansi_styles_default[type].ansi256(ansi_styles_default.rgbToAnsi256(...arguments_));
-    }
-    return ansi_styles_default[type].ansi(ansi_styles_default.rgbToAnsi(...arguments_));
+    const ansi2 = (red, green, blue) => style.ansi(ansi_styles_default.rgbToAnsi(red, green, blue));
+    const ansi256 = (red, green, blue) => style.ansi256(ansi_styles_default.rgbToAnsi256(red, green, blue));
+    return [ansi2, ansi2, ansi256, style.ansi16m];
   }
   if (model === "hex") {
-    return getModelAnsi("rgb", level, type, ...ansi_styles_default.hexToRgb(...arguments_));
+    const ansi2 = (hex) => style.ansi(ansi_styles_default.hexToAnsi(hex));
+    const ansi256 = (hex) => style.ansi256(ansi_styles_default.hexToAnsi256(hex));
+    return [ansi2, ansi2, ansi256, (hex) => style.ansi16m(...ansi_styles_default.hexToRgb(hex))];
   }
-  return ansi_styles_default[type][model](...arguments_);
+  const ansi = (code) => style.ansi(ansi_styles_default.ansi256ToAnsi(code));
+  return [ansi, ansi, style.ansi256, style.ansi256];
 };
 var usedModels = ["rgb", "hex", "ansi256"];
 for (const model of usedModels) {
-  styles2[model] = {
-    get() {
-      const { level } = this;
-      return function(...arguments_) {
-        const styler = createStyler(getModelAnsi(model, levelMapping[level], "color", ...arguments_), ansi_styles_default.color.close, this[STYLER]);
-        return createBuilder(this, styler, this[IS_EMPTY]);
-      };
-    }
-  };
-  const bgModel = "bg" + model[0].toUpperCase() + model.slice(1);
-  styles2[bgModel] = {
-    get() {
-      const { level } = this;
-      return function(...arguments_) {
-        const styler = createStyler(getModelAnsi(model, levelMapping[level], "bgColor", ...arguments_), ansi_styles_default.bgColor.close, this[STYLER]);
-        return createBuilder(this, styler, this[IS_EMPTY]);
-      };
-    }
-  };
+  const capitalizedModel = model[0].toUpperCase() + model.slice(1);
+  for (const [styleName, type] of [
+    [model, "color"],
+    ["bg" + capitalizedModel, "bgColor"],
+    ["underline" + capitalizedModel, "underlineColor"]
+  ]) {
+    const { close } = ansi_styles_default[type];
+    const converters = createModelConverters(model, type);
+    styles2[styleName] = {
+      get() {
+        const styleFunction = function(first, second, third) {
+          const open = converters[this.level](first, second, third);
+          return createBuilder(this, createStyler(open, close, this[STYLER]), this[IS_EMPTY]);
+        };
+        Object.defineProperty(this, styleName, { value: styleFunction });
+        return styleFunction;
+      }
+    };
+  }
 }
-var proto = Object.defineProperties(() => {
-}, {
-  ...styles2,
-  level: {
-    enumerable: true,
-    get() {
-      return this[GENERATOR].level;
-    },
-    set(level) {
-      this[GENERATOR].level = level;
+var proto = Object.defineProperties(
+  () => {
+  },
+  {
+    ...styles2,
+    level: {
+      enumerable: true,
+      get() {
+        return this[GENERATOR].level;
+      },
+      set(level) {
+        this[GENERATOR].level = level;
+      }
     }
   }
-});
+);
 var createStyler = (open, close, parent) => {
   let openAll;
   let closeAll;
@@ -512,15 +572,23 @@ var createStyler = (open, close, parent) => {
   };
 };
 var createBuilder = (self, _styler, _isEmpty) => {
-  const builder = (...arguments_) => applyStyle(builder, arguments_.length === 1 ? "" + arguments_[0] : arguments_.join(" "));
+  const builder = (...arguments_) => {
+    if (arguments_.length === 1) {
+      return applyStyle(builder, "" + arguments_[0]);
+    }
+    if (arguments_.length === 2) {
+      return applyStyle(builder, arguments_[0] + " " + arguments_[1]);
+    }
+    return applyStyle(builder, arguments_.join(" "));
+  };
   Object.setPrototypeOf(builder, proto);
-  builder[GENERATOR] = self;
+  builder[GENERATOR] = self[GENERATOR] ?? self;
   builder[STYLER] = _styler;
   builder[IS_EMPTY] = _isEmpty;
   return builder;
 };
 var applyStyle = (self, string) => {
-  if (self.level <= 0 || !string) {
+  if (self[GENERATOR][LEVEL] <= 0 || !string) {
     return self[IS_EMPTY] ? "" : string;
   }
   let styler = self[STYLER];
@@ -540,7 +608,7 @@ var applyStyle = (self, string) => {
   }
   return openAll + string + closeAll;
 };
-Object.defineProperties(createChalk.prototype, styles2);
+Object.defineProperties(createChalk.prototype, { ...styles2, level: levelDescriptor });
 var chalk = createChalk();
 var chalkStderr = createChalk({ level: stderrColor ? stderrColor.level : 0 });
 var index_default = chalk;
@@ -557,5 +625,6 @@ var index_default = chalk;
   modifierNames,
   modifiers,
   supportsColor,
-  supportsColorStderr
+  supportsColorStderr,
+  underlineColorNames
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cjser/chalk",
-  "version": "5.6.2-cjser.2",
+  "version": "6.0.0-cjser.2",
   "description": "Terminal string styling done right",
   "license": "MIT",
   "repository": {
@@ -9,8 +9,8 @@
   },
   "funding": "https://github.com/chalk/chalk?sponsor=1",
   "type": "module",
-  "main": "./dist-cjser/index.cjs",
   "exports": {
+    "types": "./source/index.d.ts",
     "require": "./dist-cjser/index.cjs",
     "default": "./source/index.js"
   },
@@ -21,18 +21,16 @@
       "default": "./source/vendor/supports-color/browser.js"
     }
   },
-  "types": "./source/index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": "^12.17.0 || ^14.13 || >=16.0.0"
+    "node": ">=22"
   },
   "scripts": {
-    "test": "xo && c8 ava && tsd",
+    "test": "xo && c8 ava && tsc --noEmit --types node source/index.d.ts",
     "bench": "matcha benchmark.js"
   },
   "files": [
     "source",
-    "!source/index.test-d.ts",
     "dist-cjser"
   ],
   "keywords": [
@@ -58,26 +56,35 @@
     "text"
   ],
   "devDependencies": {
-    "@types/node": "^16.11.10",
-    "ava": "^3.15.0",
-    "c8": "^7.10.0",
-    "color-convert": "^2.0.1",
-    "execa": "^6.0.0",
-    "log-update": "^5.0.0",
+    "@types/node": "^26.1.1",
+    "ansi-styles": "^6.2.3",
+    "ava": "^8.0.1",
+    "c8": "^12.0.0",
+    "color-convert": "^3.1.3",
+    "execa": "^10.0.0",
+    "log-update": "^8.0.0",
     "matcha": "^0.7.0",
-    "tsd": "^0.19.0",
-    "xo": "^0.57.0",
+    "typescript": "^6.0.3",
+    "xo": "^4.0.0",
     "yoctodelay": "^2.0.0"
   },
-  "xo": {
-    "rules": {
-      "unicorn/prefer-string-slice": "off",
-      "@typescript-eslint/consistent-type-imports": "off",
-      "@typescript-eslint/consistent-type-exports": "off",
-      "@typescript-eslint/consistent-type-definitions": "off",
-      "unicorn/expiring-todo-comments": "off"
+  "xo": [
+    {
+      "ignores": [
+        "source/vendor"
+      ]
+    },
+    {
+      "rules": {
+        "unicorn/prefer-string-slice": "off",
+        "@typescript-eslint/consistent-type-imports": "off",
+        "@typescript-eslint/consistent-type-exports": "off",
+        "@typescript-eslint/consistent-type-definitions": "off",
+        "unicorn/expiring-todo-comments": "off",
+        "no-warning-comments": "off"
+      }
     }
-  },
+  ],
   "c8": {
     "reporter": [
       "text",
@@ -87,21 +94,24 @@
       "source/vendor"
     ]
   },
+  "types": "./source/index.d.ts",
+  "main": "./dist-cjser/index.cjs",
   "cjser": {
-    "sourceVersion": "5.6.2",
+    "sourceVersion": "6.0.0",
     "cjserVersion": 2,
     "original": {
       "name": "chalk",
-      "version": "5.6.2",
-      "main": "./source/index.js",
-      "exports": "./source/index.js",
+      "version": "6.0.0",
+      "exports": {
+        "types": "./source/index.d.ts",
+        "default": "./source/index.js"
+      },
       "repository": "chalk/chalk",
       "files": [
-        "source",
-        "!source/index.test-d.ts"
+        "source"
       ],
       "scripts": {
-        "test": "xo && c8 ava && tsd",
+        "test": "xo && c8 ava && tsc --noEmit --types node source/index.d.ts",
         "bench": "matcha benchmark.js"
       }
     }

package/readme.md

@@ -140,21 +140,23 @@ const customChalk = new Chalk({level: 0});
 | `2` | 256 color support |
 | `3` | Truecolor support (16 million colors) |
 
+Both the `level` option and the `level` property throw for anything that is not an integer from 0 to 3. Omit the option, or pass `undefined`, to have the level detected instead.
+
 ### supportsColor
 
 Detect whether the terminal [supports color](https://github.com/chalk/supports-color). Used internally and handled for you, but exposed for convenience.
 
-Can be overridden by the user with the flags `--color` and `--no-color`. 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.
+Can be overridden by the user with the flags `--color` and `--no-color`. 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. A numeric `FORCE_COLOR` overrides the detected color support and sets the level directly, meaning the terminal cannot raise it to a higher level. Use `FORCE_COLOR=true` to instead only enable color and let the level be detected.
 
-Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively.
+Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively. These take precedence over a non-zero numeric `FORCE_COLOR`.
 
 ### chalkStderr and supportsColorStderr
 
 `chalkStderr` contains a separate instance configured with color support detected for `stderr` stream instead of `stdout`. Override rules from `supportsColor` apply to this too. `supportsColorStderr` is exposed for convenience.
 
-### modifierNames, foregroundColorNames, backgroundColorNames, and colorNames
+### modifierNames, foregroundColorNames, backgroundColorNames, underlineColorNames, and colorNames
 
-All supported style strings are exposed as an array of strings for convenience. `colorNames` is the combination of `foregroundColorNames` and `backgroundColorNames`.
+All supported style strings are exposed as an array of strings for convenience. `colorNames` is the combination of `foregroundColorNames` and `backgroundColorNames`. Underline color names are kept separate in `underlineColorNames`.
 
 This can be useful if you wrap Chalk and need to validate input:
 
@@ -177,11 +179,15 @@ console.log(foregroundColorNames.includes('pink'));
 - `dim` - Make the text have lower opacity.
 - `italic` - Make the text italic. *(Not widely supported)*
 - `underline` - Put a horizontal line below the text. *(Not widely supported)*
+- `underlineDouble` - Put a double horizontal line below the text. *(Not widely supported)*
+- `underlineCurly` - Put a curly horizontal line below the text. *(Not widely supported)*
+- `underlineDotted` - Put a dotted horizontal line below the text. *(Not widely supported)*
+- `underlineDashed` - Put a dashed 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
 
@@ -221,22 +227,50 @@ console.log(foregroundColorNames.includes('pink'));
 - `bgCyanBright`
 - `bgWhiteBright`
 
+### Underline colors
+
+The underline color is set independently of the text color, so the color is only visible when an underline style is also applied. For example, `chalk.underlineRed.underlineCurly('typo')` renders a red squiggle below otherwise unstyled text. *(Not widely supported)*
+
+Unlike text and background colors, there is no basic 16-color form for underline colors, so they always use the 256-color escape. At level 1 they are downsampled to the first 16 palette entries rather than to a basic color code.
+
+- `underlineBlack`
+- `underlineRed`
+- `underlineGreen`
+- `underlineYellow`
+- `underlineBlue`
+- `underlineMagenta`
+- `underlineCyan`
+- `underlineWhite`
+- `underlineBlackBright` (alias: `underlineGray`, `underlineGrey`)
+- `underlineRedBright`
+- `underlineGreenBright`
+- `underlineYellowBright`
+- `underlineBlueBright`
+- `underlineMagentaBright`
+- `underlineCyanBright`
+- `underlineWhiteBright`
+
 ## 256 and Truecolor color support
 
 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).
+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 91 (ANSI escape for bright red). The same applies to `ansi256` values, so `chalk.ansi256(196)` also becomes 91 at level 1.
 
 Examples:
 
 - `chalk.hex('#DEADED').underline('Hello, world!')`
 - `chalk.rgb(15, 100, 204).inverse('Hello!')`
 
-Background versions of these models are prefixed with `bg` and the first level of the module capitalized (e.g. `hex` for foreground colors and `bgHex` for background colors).
+Background versions of these models are prefixed with `bg` and the first letter of the model capitalized (e.g. `hex` for foreground colors and `bgHex` for background colors).
 
 - `chalk.bgHex('#DEADED').underline('Hello, world!')`
 - `chalk.bgRgb(15, 100, 204).inverse('Hello!')`
 
+Underline versions are prefixed with `underline` in the same way (e.g. `hex` for foreground colors and `underlineHex` for underline colors). They only take effect when an underline style is also applied.
+
+- `chalk.underlineHex('#DEADED').underlineCurly('Hello, world!')`
+- `chalk.underlineRgb(15, 100, 204).underline('Hello!')`
+
 The following color models can be used:
 
 - [`rgb`](https://en.wikipedia.org/wiki/RGB_color_model) - Example: `chalk.rgb(255, 136, 0).bold('Orange!')`