@jsenv/humanize 1.0.0 → 1.1.1

package/README.md

@@ -1,6 +1,14 @@
 # humanize [![npm package](https://img.shields.io/npm/v/@jsenv/humanize.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/humanize)
 
-`@jsenv/humanize` turns a JavaScript value into a string meant to be read by a human. It is written in ES6 and compatible with browsers and Node.js.
+`@jsenv/humanize` helps to generate messages meant to be read by humans
+
+It is written in ES6 and compatible with browsers and Node.js.
+
+# API
+
+## humanize(jsValue)
+
+Turns a JavaScript value into a string meant to be read by a human.
 
 ```js
 import { humanize } from "@jsenv/humanize";
@@ -15,7 +23,6 @@ console.log(
 ```
 
 ```console
-❯ node ./docs/demo.mjs
 {
   "boolean": true,
   "number": 10,
@@ -23,13 +30,21 @@ console.log(
 }
 ```
 
-# Comparison with JSON.stringify
+### Comparison with JSON.stringify
+
+Table comparing `JSON.stringify` and `humanize()` to demonstrates how inspect focuses on readability and accuracy.
 
-Table comparing `JSON.stringify` and `@jsenv/humanize` to demonstrates how inspect focuses on readability and accuracy.
+| value     | JSON.stringify | humanize    |
+| --------- | -------------- | ----------- |
+| 123456789 | "123456789"    | 123_456_789 |
+| Infinity  | "null"         | Infinity    |
+| -0        | "0"            | -0          |
+| '"'       | '"\\""'        | '"'         |
 
-| value     | JSON.stringify | jsenv inspect |
-| --------- | -------------- | ------------- |
-| 123456789 | "123456789"    | 123_456_789   |
-| Infinity  | "null"         | Infinity      |
-| -0        | "0"            | -0            |
-| '"'       | '"\\""'        | '"'           |
+## humanizeDuration(ms, options)
+
+```js
+import { humanizeDuration } from "@jsenv/humanize";
+
+humanizeDuration(61_421); // "1 minute and 1 second"
+```

package/dist/browser/jsenv_humanize_browser.js

@@ -7,6 +7,100 @@ const createDetailedMessage = (message, details = {}) => {
   return string;
 };
 
+// https://github.com/Marak/colors.js/blob/master/lib/styles.js
+// https://stackoverflow.com/a/75985833/2634179
+const RESET = "\x1b[0m";
+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 ? "".concat(ANSI_COLOR).concat(text).concat(RESET) : text;
+    },
+    BOLD: "\x1b[1m",
+    UNDERLINE: "\x1b[4m",
+    STRIKE: "\x1b[9m",
+    effect: (text, ANSI_EFFECT) => {
+      return ANSI.supported && ANSI_EFFECT ? "".concat(ANSI_EFFECT).concat(text).concat(RESET) : text;
+    }
+  };
+  return ANSI;
+};
+
+const ANSI = createAnsi({
+  supported: true
+});
+
+// see also https://github.com/sindresorhus/figures
+
+const createUnicode = ({
+  supported,
+  ANSI
+}) => {
+  const UNICODE = {
+    supported,
+    get COMMAND_RAW() {
+      return UNICODE.supported ? "\u276F" : ">";
+    },
+    get OK_RAW() {
+      return UNICODE.supported ? "\u2714" : "\u221A";
+    },
+    get FAILURE_RAW() {
+      return UNICODE.supported ? "\u2716" : "\xD7";
+    },
+    get DEBUG_RAW() {
+      return UNICODE.supported ? "\u25C6" : "\u2666";
+    },
+    get INFO_RAW() {
+      return UNICODE.supported ? "\u2139" : "i";
+    },
+    get WARNING_RAW() {
+      return UNICODE.supported ? "\u26A0" : "\u203C";
+    },
+    get CIRCLE_CROSS_RAW() {
+      return UNICODE.supported ? "\u24E7" : "(\xD7)";
+    },
+    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 ? "\u2026" : "...";
+    }
+  };
+  return UNICODE;
+};
+
+const UNICODE = createUnicode({
+  supported: true,
+  ANSI
+});
+
 const inspectBoolean = value => value.toString();
 
 const inspectNull = () => "null";
@@ -914,7 +1008,7 @@ const humanizeFileSize = (numberOfBytes, {
     short
   });
 };
-const humanizeMemoryUsage = (metricValue, {
+const humanizeMemory = (metricValue, {
   decimals,
   short
 } = {}) => {
@@ -1154,4 +1248,4 @@ const fillLeft = (value, biggestValue, char = " ") => {
   return padded;
 };
 
-export { createDetailedMessage, determineQuote, distributePercentages, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemoryUsage, humanizeMethodSymbol, inspectChar };
+export { ANSI, UNICODE, createDetailedMessage, distributePercentages, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol };