chalker 1.1.2 → 1.3.0

package/README.md

@@ -3,7 +3,7 @@
 
 # chalker
 
-Set ansi colors in strings using XML like markers and [chalk].
+Set ansi colors in strings using `<>` markers and [chalk] or [ansi-colors].
 
 # Usage
 
@@ -31,9 +31,17 @@ logger.log(chalker.remove(msg));
 # Install
 
 ```
-npm i --save chalker
+npm i --save chalker chalk
 ```
 
+or:
+
+```
+npm i --save chalker ansi-colors
+```
+
+`chalker` expects either [chalk] `>= 4` or [ansi-colors] `>= 4` as a peer dependency.
+
 # Demo
 
 ![demo][demo]
@@ -62,12 +70,15 @@ npm i --save chalker
 
 #### Advanced Chalk Colors
 
+Some advanced color markers use `chalker` compatibility wrappers when Chalk does not provide
+the corresponding API directly.
+
 [Chalk advanced colors] can be applied with:
 
 | [chalk] API     | chalker marker                                | [chalk] API       | chalker marker                                       |
 | --------------- | --------------------------------------------- | ----------------- | ---------------------------------------------------- |
 | `chalk.rgb`     | `<(255, 10, 20)>`, `<rgb(255,10,20)>`         | `chalk.bgRgb`     | `<bg(255, 10, 20)>`, `<bgRgb(255,10,20)>`            |
-| `chalk.hex`     | `<#FF0000>`, `<hex(#FF0000)>`                 | `chalk.bgHex`     | `<bg#0000FF>`,  `<bgHex(#0000FF)>`                   |
+| `chalk.hex`     | `<#FF0000>`, `<hex(#FF0000)>`                 | `chalk.bgHex`     | `<bg#0000FF>`, `<bgHex(#0000FF)>`                    |
 | `chalk.keyword` | `<orange>`, `<(orange)>`, `<keyword(orange)>` | `chalk.bgKeyword` | `<bg-orange>`, `<bg(orange)>`, `<bgKeyword(orange)>` |
 | `chalk.hsl`     | `<hsl(32,100,50)>`                            | `chalk.bgHsl`     | `<bgHsl(32,100,50)>`                                 |
 | `chalk.hsv`     | `<hsv(32,100,100)>`                           | `chalk.bgHsv`     | `<bgHsv(32,100,100)>`                                |
@@ -76,6 +87,7 @@ npm i --save chalker
 ##### More details
 
 - a marker is tried with `chalk.keyword` if:
+
   - it's not detected as hex value
   - it doesn't contain params enclosed in `()`
   - it's not found as a basic color that `chalk` supports
@@ -86,7 +98,7 @@ npm i --save chalker
 
 - All markers can be comined with `.` in any order as long as they work with [chalk]
 
-    - ie: `<#FF0000.bg#0000FF.bg-orange.keyword(red)>`
+  - ie: `<#FF0000.bg#0000FF.bg-orange.keyword(red)>`
 
 # APIs
 
@@ -102,7 +114,16 @@ chalker(str, [chalkInstance]);
 
 **Returns:** A string with terminal/ansi color codes
 
-> If `chalk.supportsColor` is `false`, then it will simply remove the XML markers and decode HTML entities only.
+> If `chalk.supportsColor` is `false`, then it will simply remove the `<>` markers and decode HTML entities only.
+
+### `chalker.CHALK`
+
+```js
+chalker.CHALK = require("ansi-colors");
+```
+
+Set the default colors library. By default, `chalker` loads `chalk` first and falls back to
+[ansi-colors].
 
 ### `chalker.remove`
 
@@ -117,11 +138,10 @@ Simply remove all chalker markers and return the plain text string, with HTML es
 
 **Returns**: A plain text string without chalker color markers
 
-
 ### `chalker.decodeHtml`
 
 ```js
-chalker.decodeHtml(str)
+chalker.decodeHtml(str);
 ```
 
 - `str` - String to decode HTML entities
@@ -137,6 +157,7 @@ Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses
 ---
 
 [demo]: ./images/demo.png
+[ansi-colors]: https://www.npmjs.com/package/ansi-colors
 [chalk]: https://www.npmjs.com/package/chalk
 [chalk advanced colors]: https://github.com/chalk/chalk#256-and-truecolor-color-support
 [travis-image]: https://travis-ci.org/jchip/chalker.svg?branch=master

package/lib/index.js

@@ -3,7 +3,9 @@
 /* eslint-disable complexity, max-statements, no-magic-numbers, prefer-template, prefer-spread */
 
 const assert = require("assert");
-const chalk = require("chalk");
+const optionalRequire = require("optional-require")(require);
+const colorConvert = require("color-convert");
+const chalk = loadColors();
 
 //
 // convert color markers in a string to terminal/ansi color codes with chalk
@@ -62,8 +64,100 @@ const htmlEntities = {
   [`®`]: "\xae"
 };
 
+function loadColors() {
+  const colors = optionalRequire("chalk") || optionalRequire("ansi-colors");
+
+  if (!colors) {
+    throw new Error("chalker requires either chalk or ansi-colors to be installed");
+  }
+
+  return normalizeColors(colors);
+}
+
+function normalizeColors(colorsModule) {
+  const colors =
+    colorsModule &&
+    colorsModule.default &&
+    (typeof colorsModule.default === "function" || typeof colorsModule.default === "object")
+      ? colorsModule.default
+      : colorsModule;
+
+  return addAnsiColorsCompat(colors);
+}
+
+function addAnsiColorsCompat(colors) {
+  if (!colors || typeof colors.alias !== "function" || typeof colors.rgb === "function") {
+    return colors;
+  }
+
+  colors.rgb = function (r, g, b) {
+    return this[defineAnsiColor(colors, "rgb", [r, g, b])];
+  };
+  colors.bgRgb = function (r, g, b) {
+    return this[defineAnsiColor(colors, "bgRgb", [r, g, b], true)];
+  };
+  colors.hex = function (value) {
+    return this.rgb.apply(this, colorConvert.hex.rgb(value));
+  };
+  colors.bgHex = function (value) {
+    return this.bgRgb.apply(this, colorConvert.hex.rgb(value));
+  };
+
+  return colors;
+}
+
+function defineAnsiColor(colors, name, values, bg) {
+  const styleName = `chalker_${name}_${values.join("_")}`;
+
+  if (!colors.styles[styleName]) {
+    const prefix = bg ? 48 : 38;
+    const close = bg ? 49 : 39;
+    colors.alias(
+      styleName,
+      (text) => `\u001b[${prefix};2;${values.join(";")}m${text}\u001b[${close}m`
+    );
+  }
+
+  return styleName;
+}
+
+function convertColorModel(name, values) {
+  const bg = name.startsWith("bg");
+  const model = bg ? name[2].toLowerCase() + name.substring(3) : name;
+  const rgb =
+    model === "keyword"
+      ? colorConvert.keyword.rgb(String(values[0]).toLowerCase())
+      : colorConvert[model] && colorConvert[model].rgb.apply(colorConvert[model], values);
+
+  assert(rgb, `unknown color ${values[0]}`);
+
+  return { name: bg ? "bgRgb" : "rgb", values: rgb };
+}
+
+function applyChalkMethod(chalkInstance, name, values) {
+  if (typeof chalkInstance[name] === "function") {
+    return chalkInstance[name].apply(chalkInstance, values);
+  }
+
+  if (
+    name === "keyword" ||
+    name === "bgKeyword" ||
+    name === "hsl" ||
+    name === "bgHsl" ||
+    name === "hsv" ||
+    name === "bgHsv" ||
+    name === "hwb" ||
+    name === "bgHwb"
+  ) {
+    const converted = convertColorModel(name, values);
+    return chalkInstance[converted.name].apply(chalkInstance, converted.values);
+  }
+
+  throw new TypeError(`${name} is not a chalk function`);
+}
+
 function decodeHtml(str) {
-  return str.replace(/&[\w#]+;/g, m => {
+  return str.replace(/&[\w#]+;/g, (m) => {
     if (htmlEntities.hasOwnProperty(m)) return htmlEntities[m];
     if (m.startsWith("&#x")) {
       const s = m.substring(3, m.length - 1);
@@ -112,7 +206,7 @@ function applyChalkMarkers(markers, text, userChalk) {
         let values = marker.substring(openIx + 1, closeIx).trim();
         if (values.indexOf(",") >= 0) {
           // extract rgb/hsl/hsv/hwb values like (255, 10, 20)
-          values = values.split(",").map(x => parseInt(x.trim(), 10));
+          values = values.split(",").map((x) => parseInt(x.trim(), 10));
 
           // default no name to rgb, and bg to bgRgb
           if (!name) name = "rgb";
@@ -127,23 +221,20 @@ function applyChalkMarkers(markers, text, userChalk) {
         }
 
         try {
-          a = a[name].apply(a, values);
+          a = applyChalkMethod(a, name, values);
         } catch (err) {
-          const msg =
-            typeof a[name] !== "function"
-              ? `${name} is not a chalk function`
-              : `calling chalk.${name} failed with: ${err.message}`;
-
-          throw new Error(`marker ${marker} is invalid: ${msg}`);
+          throw new Error(
+            `marker ${marker} is invalid: calling chalk.${name} failed with: ${err.message}`
+          );
         }
       } else {
         // if not found as a basic color, then try with chalk.keyword or chalk.bgKeyword
         try {
           const kw = deQuote(marker, marker);
           if (kw.startsWith("bg-") || kw.startsWith("bg ")) {
-            a = a.bgKeyword(kw.substring(3));
+            a = applyChalkMethod(a, "bgKeyword", [kw.substring(3)]);
           } else {
-            a = a.keyword(kw);
+            a = applyChalkMethod(a, "keyword", [kw]);
           }
         } catch (err) {
           throw new Error(`marker ${marker} is not found and invalid as a keyword`);
@@ -170,7 +261,7 @@ function remove(s, keepHtml) {
 }
 
 function format(s, userChalk) {
-  userChalk = userChalk || chalk;
+  userChalk = normalizeColors(userChalk || chalker.CHALK);
 
   // skip applying ansi colors if chalk says color support is off
   if (userChalk.supportsColor === false) {
@@ -251,4 +342,6 @@ chalker.remove = remove;
 
 chalker.decodeHtml = decodeHtml;
 
+chalker.CHALK = chalk;
+
 module.exports = chalker;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chalker",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Set ansi colors in strings using XML and chalk",
   "main": "lib/index.js",
   "repository": {
@@ -8,8 +8,17 @@
     "url": "https://github.com/jchip/chalker.git"
   },
   "scripts": {
-    "test": "clap test",
-    "coverage": "clap check"
+    "test": "xrun --serial test:unit test:demo",
+    "test:unit": "vitest run",
+    "test:demo": "xrun --serial test:demo:legacy-cjs test:demo:ansi-colors-cjs test:demo:cjs-dynamic-import test:demo:esm-default test:demo:esm-namespace test:demo:esm-create-require test:demo:esm-named-export-probe",
+    "test:demo:legacy-cjs": "cd demo/legacy-cjs && fyn install && fyn test",
+    "test:demo:ansi-colors-cjs": "cd demo/ansi-colors-cjs && fyn install && fyn test",
+    "test:demo:cjs-dynamic-import": "cd demo/cjs-dynamic-import && fyn install && fyn test",
+    "test:demo:esm-default": "cd demo/esm-default && fyn install && fyn test",
+    "test:demo:esm-namespace": "cd demo/esm-namespace && fyn install && fyn test",
+    "test:demo:esm-create-require": "cd demo/esm-create-require && fyn install && fyn test",
+    "test:demo:esm-named-export-probe": "cd demo/esm-named-export-probe && fyn install && fyn test",
+    "coverage": "vitest run --coverage"
   },
   "files": [
     "lib"
@@ -27,30 +36,31 @@
   "author": "Joel Chen",
   "license": "Apache-2.0",
   "dependencies": {
-    "chalk": "^2.4.2"
+    "color-convert": "^2.0.1",
+    "optional-require": "^1.1.8"
+  },
+  "peerDependencies": {
+    "ansi-colors": ">=4",
+    "chalk": ">=4"
+  },
+  "peerDependenciesMeta": {
+    "ansi-colors": {
+      "optional": true
+    },
+    "chalk": {
+      "optional": true
+    }
   },
   "devDependencies": {
-    "electrode-archetype-njs-module-dev": "^3.0.0"
+    "@vitest/coverage-v8": "4.1.5",
+    "@xarc/run": "^2.3.0",
+    "ansi-colors": "^4.1.3",
+    "chalk": "^4.1.2",
+    "prettier": "^2.0.2",
+    "vitest": "4.1.5"
   },
-  "nyc": {
-    "all": true,
-    "reporter": [
-      "lcov",
-      "text",
-      "text-summary"
-    ],
-    "exclude": [
-      "coverage",
-      "*clap.js",
-      "gulpfile.js",
-      "dist",
-      "test"
-    ],
-    "check-coverage": true,
-    "statements": 100,
-    "branches": 100,
-    "functions": 100,
-    "lines": 100,
-    "cache": true
+  "prettier": {
+    "printWidth": 100,
+    "trailingComma": "none"
   }
 }