@jsenv/humanize 1.0.0 → 1.1.1

package/src/_tests/time/ellapsed.test.js

@@ -2,9 +2,9 @@ import { assert } from "@jsenv/assert";
 
 import { humanizeEllapsedTime } from "@jsenv/humanize";
 
-const test = (durationInMs, expected) => {
+const test = (durationInMs, expect) => {
   const actual = humanizeEllapsedTime(durationInMs);
-  assert({ actual, expected });
+  assert({ actual, expect });
 };
 
 test(2200, "2 seconds");

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,16 @@
+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 &&
+      // 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"),
+});

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/byte/byte.js

@@ -4,7 +4,7 @@ export const humanizeFileSize = (numberOfBytes, { decimals, short } = {}) => {
   return inspectBytes(numberOfBytes, { decimals, short });
 };
 
-export const humanizeMemoryUsage = (metricValue, { decimals, short } = {}) => {
+export const humanizeMemory = (metricValue, { decimals, short } = {}) => {
   return inspectBytes(metricValue, { decimals, fixedDecimals: true, short });
 };
 

package/src/js_value/humanize.js

@@ -65,7 +65,7 @@ export const humanize = (
 
 export const humanizeMethodSymbol = Symbol.for("inspect");
 
-export const humanizeValue = (value, options) => {
+const humanizeValue = (value, options) => {
   const customHumanize = value && value[humanizeMethodSymbol];
   if (customHumanize) {
     return customHumanize(options);

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/dynamic_log.js

@@ -88,20 +88,22 @@ export const createDynamicLog = ({
     clearAttemptResult = undefined;
   };
 
-  const clearDuringFunctionCall = (callback) => {
+  const clearDuringFunctionCall = (
+    callback,
+    ouputAfterCallback = lastOutput,
+  ) => {
     // 1. Erase the current log
-    // 2. Call callback (expected to write something on stdout)
+    // 2. Call callback (expect to write something on stdout)
     // 3. Restore the current log
     // During step 2. we expect a "write from outside" so we uninstall
     // the stream spy during function call
-    const currentOutput = lastOutput;
     update("");
 
     writing = true;
     callback();
     writing = false;
 
-    update(currentOutput);
+    update(ouputAfterCallback);
   };
 
   const writeFromOutsideEffect = (value) => {

package/src/log/spinner.js

@@ -1,4 +1,4 @@
-import { ANSI } from "./ansi.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.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,10 +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 { humanizeDuration, humanizeEllapsedTime } from "./time/time.js";
-export { humanizeFileSize, humanizeMemoryUsage } from "./byte/byte.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.js";
-export { UNICODE } from "./log/unicode.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, humanizeMemoryUsage } from "./byte/byte.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/_tests/byte/memory_usage.test.js

@@ -1,11 +0,0 @@
-import { assert } from "@jsenv/assert";
-
-import { humanizeMemoryUsage } from "@jsenv/humanize";
-
-const test = (memoryUsageInBytes, expected) => {
-  const actual = humanizeMemoryUsage(memoryUsageInBytes);
-  assert({ actual, expected });
-};
-
-test(1000, "1.0 kB");
-test(1100, "1.1 kB");

package/src/log/ansi.js

@@ -1,37 +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",
-  GREY: "\x1b[90m",
-  color: (text, ANSI_COLOR) => {
-    return ANSI.supported ? `${ANSI_COLOR}${text}${RESET}` : text;
-  },
-
-  BOLD: "\x1b[1m",
-  effect: (text, ANSI_EFFECT) => {
-    return ANSI.supported ? `${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.js

@@ -1,52 +0,0 @@
-// see also https://github.com/sindresorhus/figures
-
-import isUnicodeSupported from "is-unicode-supported";
-
-import { ANSI } from "./ansi.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);
-  },
-};