@jsenv/humanize 1.1.0 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/humanize",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Generate messages meant to read by humans",
   "license": "MIT",
   "repository": {

package/src/.jsenv/jsenv_tests_output.txt

@@ -7,26 +7,26 @@
 ✔ 03/23 _tests/content_frame/content_frame.test.js [node/0.07s] (3 completed)
 ✔ 04/23 _tests/js_value/_inspect.test.html [chromium/0.2s] (4 completed)
 ✔ 05/23 _tests/js_value/_inspect.test.html [firefox/0.1s] (5 completed)
-✔ 06/23 _tests/js_value/_inspect.test.html [webkit/0.3s] (6 completed)
+✔ 06/23 _tests/js_value/_inspect.test.html [webkit/0.2s] (6 completed)
 ✔ 07/23 _tests/js_value/array.test.js [node/0.03s] (7 completed)
 ✔ 08/23 _tests/js_value/biginit.test.js [node/0.03s] (8 completed)
-✔ 09/23 _tests/js_value/boolean.test.js [node/0.1s] (9 completed)
-✔ 10/23 _tests/js_value/date.test.js [node/0.1s] (10 completed)
-✔ 11/23 _tests/js_value/error.test.js [node/0.1s] (11 completed)
-✔ 12/23 _tests/js_value/function.test.js [node/0.05s] (12 completed)
-✔ 13/23 _tests/js_value/instance.test.js [node/0.1s] (13 completed)
-✔ 14/23 _tests/js_value/null.test.js [node/0.04s] (14 completed)
+✔ 09/23 _tests/js_value/boolean.test.js [node/0.05s] (9 completed)
+✔ 10/23 _tests/js_value/date.test.js [node/0.03s] (10 completed)
+✔ 11/23 _tests/js_value/error.test.js [node/0.03s] (11 completed)
+✔ 12/23 _tests/js_value/function.test.js [node/0.04s] (12 completed)
+✔ 13/23 _tests/js_value/instance.test.js [node/0.03s] (13 completed)
+✔ 14/23 _tests/js_value/null.test.js [node/0.05s] (14 completed)
 ✔ 15/23 _tests/js_value/number.test.js [node/0.06s] (15 completed)
-✔ 16/23 _tests/js_value/object.test.js [node/0.06s] (16 completed)
-✔ 17/23 _tests/js_value/regexp.test.js [node/0.04s] (17 completed)
-✔ 18/23 _tests/js_value/string.test.js [node/0.05s] (18 completed)
-✔ 19/23 _tests/js_value/symbol.test.js [node/0.02s] (19 completed)
-✔ 20/23 _tests/js_value/undefined.test.js [node/0.03s] (20 completed)
-✔ 21/23 _tests/time/decimals.test.js [node/0.03s] (21 completed)
+✔ 16/23 _tests/js_value/object.test.js [node/0.07s] (16 completed)
+✔ 17/23 _tests/js_value/regexp.test.js [node/0.05s] (17 completed)
+✔ 18/23 _tests/js_value/string.test.js [node/0.04s] (18 completed)
+✔ 19/23 _tests/js_value/symbol.test.js [node/0.03s] (19 completed)
+✔ 20/23 _tests/js_value/undefined.test.js [node/0.02s] (20 completed)
+✔ 21/23 _tests/time/decimals.test.js [node/0.02s] (21 completed)
 ✔ 22/23 _tests/time/duration.test.js [node/0.03s] (22 completed)
-✔ 23/23 _tests/time/ellapsed.test.js [node/0.03s] (all completed)
+✔ 23/23 _tests/time/ellapsed.test.js [node/0.02s] (all completed)
 
 --------------- execution end ---------------
 23 executions: all completed
-duration: 2.6s (setup: 0.4s, execution: 2.4s, teardown: 0.2s)
+duration: 2.4s (setup: 0.4s, execution: 2.3s, teardown: 0.2s)
 ---------------------------------------------

package/src/ansi/ansi_browser.js

@@ -0,0 +1,3 @@
+import { createAnsi } from "./ansi_runtime_agnostic.js";
+
+export const ANSI = createAnsi({ supported: true });

package/src/ansi/ansi_node.js

@@ -0,0 +1,12 @@
+import { createSupportsColor } from "supports-color";
+import { createAnsi } from "./ansi_runtime_agnostic.js";
+
+const processSupportsBasicColor = createSupportsColor(process.stdout).hasBasic;
+
+export const ANSI = createAnsi({
+  supported:
+    processSupportsBasicColor ||
+    // GitHub workflow does support ANSI but "supports-color" returns false
+    // because stream.isTTY returns false, see https://github.com/actions/runner/issues/241
+    process.env.GITHUB_WORKFLOW,
+});

package/src/ansi/ansi_runtime_agnostic.js

@@ -0,0 +1,33 @@
+// https://github.com/Marak/colors.js/blob/master/lib/styles.js
+// https://stackoverflow.com/a/75985833/2634179
+const RESET = "\x1b[0m";
+
+export const createAnsi = ({ supported }) => {
+  const ANSI = {
+    supported,
+
+    RED: "\x1b[31m",
+    GREEN: "\x1b[32m",
+    YELLOW: "\x1b[33m",
+    BLUE: "\x1b[34m",
+    MAGENTA: "\x1b[35m",
+    CYAN: "\x1b[36m",
+    GREY: "\x1b[90m",
+    color: (text, ANSI_COLOR) => {
+      return ANSI.supported && ANSI_COLOR
+        ? `${ANSI_COLOR}${text}${RESET}`
+        : text;
+    },
+
+    BOLD: "\x1b[1m",
+    UNDERLINE: "\x1b[4m",
+    STRIKE: "\x1b[9m",
+    effect: (text, ANSI_EFFECT) => {
+      return ANSI.supported && ANSI_EFFECT
+        ? `${ANSI_EFFECT}${text}${RESET}`
+        : text;
+    },
+  };
+
+  return ANSI;
+};

package/src/js_value/string.js

@@ -67,7 +67,7 @@ export const determineQuote = (
   return quoteDefault;
 };
 
-export const inspectChar = (char, { quote, preserveLineBreaks }) => {
+const inspectChar = (char, { quote, preserveLineBreaks }) => {
   const point = char.charCodeAt(0);
   if (preserveLineBreaks && (char === "\n" || char === "\r")) {
     return char;

package/src/log/spinner.js

@@ -1,4 +1,4 @@
-import { ANSI } from "./ansi_node.js";
+import { ANSI } from "../ansi/ansi_node.js";
 
 export const startSpinner = ({
   dynamicLog,

package/src/log/task_log.js

@@ -1,5 +1,5 @@
 import { humanizeDuration } from "../time/time.js";
-import { UNICODE } from "./unicode_node.js";
+import { UNICODE } from "../unicode/unicode_node.js";
 import { createDynamicLog } from "./dynamic_log.js";
 import { startSpinner } from "./spinner.js";
 

package/src/main_browser.js

@@ -1,13 +1,8 @@
 export { createDetailedMessage } from "./log/detailed_message.js";
-
+export { ANSI } from "./ansi/ansi_browser.js";
+export { UNICODE } from "./unicode/unicode_browser.js";
 export { humanize, humanizeMethodSymbol } from "./js_value/humanize.js";
-export { determineQuote, inspectChar } from "./js_value/string.js";
-
-export { ANSI } from "./log/ansi_browser.js";
-export { UNICODE } from "./log/unicode_browser.js";
-
 export { humanizeDuration, humanizeEllapsedTime } from "./time/time.js";
 export { humanizeFileSize, humanizeMemory } from "./byte/byte.js";
 export { distributePercentages } from "./percentage/distribute_percentages.js";
-
 export { generateContentFrame } from "./content_frame/content_frame.js";

package/src/main_node.js

@@ -1,18 +1,14 @@
-// node only
-export { createLogger } from "./log/logger.js";
-export { createDynamicLog } from "./log/dynamic_log.js";
-export { startSpinner } from "./log/spinner.js";
-export { createTaskLog } from "./log/task_log.js";
 export { createDetailedMessage } from "./log/detailed_message.js";
-
-export { ANSI } from "./log/ansi_node.js";
-export { UNICODE } from "./log/unicode_node.js";
-
+export { ANSI } from "./ansi/ansi_node.js";
+export { UNICODE } from "./unicode/unicode_node.js";
 export { humanize, humanizeMethodSymbol } from "./js_value/humanize.js";
-export { determineQuote, inspectChar } from "./js_value/string.js";
-
 export { humanizeDuration, humanizeEllapsedTime } from "./time/time.js";
 export { humanizeFileSize, humanizeMemory } from "./byte/byte.js";
 export { distributePercentages } from "./percentage/distribute_percentages.js";
-
 export { generateContentFrame } from "./content_frame/content_frame.js";
+
+// node only
+export { createLogger } from "./log/logger.js";
+export { createDynamicLog } from "./log/dynamic_log.js";
+export { startSpinner } from "./log/spinner.js";
+export { createTaskLog } from "./log/task_log.js";

package/src/unicode/unicode_browser.js

@@ -0,0 +1,7 @@
+import { createUnicode } from "./unicode_runtime_agnostic.js";
+import { ANSI } from "../ansi/ansi_browser.js";
+
+export const UNICODE = createUnicode({
+  supported: true,
+  ANSI,
+});

package/src/unicode/unicode_node.js

@@ -0,0 +1,8 @@
+import isUnicodeSupported from "is-unicode-supported";
+import { createUnicode } from "./unicode_runtime_agnostic.js";
+import { ANSI } from "../ansi/ansi_node.js";
+
+export const UNICODE = createUnicode({
+  supported: isUnicodeSupported(),
+  ANSI,
+});

package/src/unicode/unicode_runtime_agnostic.js

@@ -0,0 +1,53 @@
+// see also https://github.com/sindresorhus/figures
+
+export const createUnicode = ({ supported, ANSI }) => {
+  const UNICODE = {
+    supported,
+    get COMMAND_RAW() {
+      return UNICODE.supported ? `❯` : `>`;
+    },
+    get OK_RAW() {
+      return UNICODE.supported ? `✔` : `√`;
+    },
+    get FAILURE_RAW() {
+      return UNICODE.supported ? `✖` : `×`;
+    },
+    get DEBUG_RAW() {
+      return UNICODE.supported ? `◆` : `♦`;
+    },
+    get INFO_RAW() {
+      return UNICODE.supported ? `ℹ` : `i`;
+    },
+    get WARNING_RAW() {
+      return UNICODE.supported ? `⚠` : `‼`;
+    },
+    get CIRCLE_CROSS_RAW() {
+      return UNICODE.supported ? `ⓧ` : `(×)`;
+    },
+    get COMMAND() {
+      return ANSI.color(UNICODE.COMMAND_RAW, ANSI.GREY); // ANSI_MAGENTA)
+    },
+    get OK() {
+      return ANSI.color(UNICODE.OK_RAW, ANSI.GREEN);
+    },
+    get FAILURE() {
+      return ANSI.color(UNICODE.FAILURE_RAW, ANSI.RED);
+    },
+    get DEBUG() {
+      return ANSI.color(UNICODE.DEBUG_RAW, ANSI.GREY);
+    },
+    get INFO() {
+      return ANSI.color(UNICODE.INFO_RAW, ANSI.BLUE);
+    },
+    get WARNING() {
+      return ANSI.color(UNICODE.WARNING_RAW, ANSI.YELLOW);
+    },
+    get CIRCLE_CROSS() {
+      return ANSI.color(UNICODE.CIRCLE_CROSS_RAW, ANSI.RED);
+    },
+    get ELLIPSIS() {
+      return UNICODE.supported ? `…` : `...`;
+    },
+  };
+  return UNICODE;
+};

package/src/log/ansi_browser.js

@@ -1,27 +0,0 @@
-// https://github.com/Marak/colors.js/blob/master/lib/styles.js
-// https://stackoverflow.com/a/75985833/2634179
-const RESET = "\x1b[0m";
-
-export const ANSI = {
-  supported: true,
-
-  RED: "\x1b[31m",
-  GREEN: "\x1b[32m",
-  YELLOW: "\x1b[33m",
-  BLUE: "\x1b[34m",
-  MAGENTA: "\x1b[35m",
-  CYAN: "\x1b[36m",
-  GREY: "\x1b[90m",
-  color: (text, ANSI_COLOR) => {
-    return ANSI.supported && ANSI_COLOR ? `${ANSI_COLOR}${text}${RESET}` : text;
-  },
-
-  BOLD: "\x1b[1m",
-  UNDERLINE: "\x1b[4m",
-  STRIKE: "\x1b[9m",
-  effect: (text, ANSI_EFFECT) => {
-    return ANSI.supported && ANSI_EFFECT
-      ? `${ANSI_EFFECT}${text}${RESET}`
-      : text;
-  },
-};

package/src/log/ansi_node.js

@@ -1,42 +0,0 @@
-import { createSupportsColor } from "supports-color";
-
-const processSupportsBasicColor = createSupportsColor(process.stdout).hasBasic;
-// https://github.com/Marak/colors.js/blob/master/lib/styles.js
-// https://stackoverflow.com/a/75985833/2634179
-const RESET = "\x1b[0m";
-
-export const ANSI = {
-  supported: processSupportsBasicColor,
-
-  RED: "\x1b[31m",
-  GREEN: "\x1b[32m",
-  YELLOW: "\x1b[33m",
-  BLUE: "\x1b[34m",
-  MAGENTA: "\x1b[35m",
-  CYAN: "\x1b[36m",
-  GREY: "\x1b[90m",
-  color: (text, ANSI_COLOR) => {
-    return ANSI.supported && ANSI_COLOR ? `${ANSI_COLOR}${text}${RESET}` : text;
-  },
-
-  BOLD: "\x1b[1m",
-  UNDERLINE: "\x1b[4m",
-  STRIKE: "\x1b[9m",
-  effect: (text, ANSI_EFFECT) => {
-    return ANSI.supported && ANSI_EFFECT
-      ? `${ANSI_EFFECT}${text}${RESET}`
-      : text;
-  },
-};
-
-// GitHub workflow does support ANSI but "supports-color" returns false
-// because stream.isTTY returns false, see https://github.com/actions/runner/issues/241
-if (
-  process.env.GITHUB_WORKFLOW &&
-  // Check on FORCE_COLOR is to ensure it is prio over GitHub workflow check
-  // in unit test we use process.env.FORCE_COLOR = 'false' to fake
-  // that colors are not supported. Let it have priority
-  process.env.FORCE_COLOR !== "false"
-) {
-  ANSI.supported = true;
-}

package/src/log/unicode_browser.js

@@ -1,53 +0,0 @@
-// see also https://github.com/sindresorhus/figures
-
-import { ANSI } from "./ansi_browser.js";
-
-export const UNICODE = {
-  supported: true,
-
-  get COMMAND_RAW() {
-    return UNICODE.supported ? `❯` : `>`;
-  },
-  get OK_RAW() {
-    return UNICODE.supported ? `✔` : `√`;
-  },
-  get FAILURE_RAW() {
-    return UNICODE.supported ? `✖` : `×`;
-  },
-  get DEBUG_RAW() {
-    return UNICODE.supported ? `◆` : `♦`;
-  },
-  get INFO_RAW() {
-    return UNICODE.supported ? `ℹ` : `i`;
-  },
-  get WARNING_RAW() {
-    return UNICODE.supported ? `⚠` : `‼`;
-  },
-  get CIRCLE_CROSS_RAW() {
-    return UNICODE.supported ? `ⓧ` : `(×)`;
-  },
-  get COMMAND() {
-    return ANSI.color(UNICODE.COMMAND_RAW, ANSI.GREY); // ANSI_MAGENTA)
-  },
-  get OK() {
-    return ANSI.color(UNICODE.OK_RAW, ANSI.GREEN);
-  },
-  get FAILURE() {
-    return ANSI.color(UNICODE.FAILURE_RAW, ANSI.RED);
-  },
-  get DEBUG() {
-    return ANSI.color(UNICODE.DEBUG_RAW, ANSI.GREY);
-  },
-  get INFO() {
-    return ANSI.color(UNICODE.INFO_RAW, ANSI.BLUE);
-  },
-  get WARNING() {
-    return ANSI.color(UNICODE.WARNING_RAW, ANSI.YELLOW);
-  },
-  get CIRCLE_CROSS() {
-    return ANSI.color(UNICODE.CIRCLE_CROSS_RAW, ANSI.RED);
-  },
-  get ELLIPSIS() {
-    return UNICODE.supported ? `…` : `...`;
-  },
-};

package/src/log/unicode_node.js

@@ -1,55 +0,0 @@
-// see also https://github.com/sindresorhus/figures
-
-import isUnicodeSupported from "is-unicode-supported";
-
-import { ANSI } from "./ansi_node.js";
-
-export const UNICODE = {
-  supported: isUnicodeSupported(),
-
-  get COMMAND_RAW() {
-    return UNICODE.supported ? `❯` : `>`;
-  },
-  get OK_RAW() {
-    return UNICODE.supported ? `✔` : `√`;
-  },
-  get FAILURE_RAW() {
-    return UNICODE.supported ? `✖` : `×`;
-  },
-  get DEBUG_RAW() {
-    return UNICODE.supported ? `◆` : `♦`;
-  },
-  get INFO_RAW() {
-    return UNICODE.supported ? `ℹ` : `i`;
-  },
-  get WARNING_RAW() {
-    return UNICODE.supported ? `⚠` : `‼`;
-  },
-  get CIRCLE_CROSS_RAW() {
-    return UNICODE.supported ? `ⓧ` : `(×)`;
-  },
-  get COMMAND() {
-    return ANSI.color(UNICODE.COMMAND_RAW, ANSI.GREY); // ANSI_MAGENTA)
-  },
-  get OK() {
-    return ANSI.color(UNICODE.OK_RAW, ANSI.GREEN);
-  },
-  get FAILURE() {
-    return ANSI.color(UNICODE.FAILURE_RAW, ANSI.RED);
-  },
-  get DEBUG() {
-    return ANSI.color(UNICODE.DEBUG_RAW, ANSI.GREY);
-  },
-  get INFO() {
-    return ANSI.color(UNICODE.INFO_RAW, ANSI.BLUE);
-  },
-  get WARNING() {
-    return ANSI.color(UNICODE.WARNING_RAW, ANSI.YELLOW);
-  },
-  get CIRCLE_CROSS() {
-    return ANSI.color(UNICODE.CIRCLE_CROSS_RAW, ANSI.RED);
-  },
-  get ELLIPSIS() {
-    return UNICODE.supported ? `…` : `...`;
-  },
-};