@jsenv/humanize 1.0.0

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@jsenv/humanize",
+  "version": "1.0.0",
+  "description": "Generate messages meant to read by humans",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jsenv/core",
+    "directory": "packages/independent/humanize"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16.8.0"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "browser": {
+        "development": "./src/main_browser.js",
+        "default": "./dist/browser/jsenv_humanize_browser.js"
+      },
+      "node": {
+        "development": "./src/main_node.js",
+        "default": "./dist/node/jsenv_humanize_node.js"
+      }
+    },
+    "./*": "./*"
+  },
+  "files": [
+    "/dist/",
+    "/src/"
+  ],
+  "scripts": {
+    "dev": "node ./scripts/dev.mjs",
+    "build": "node ./scripts/build.mjs",
+    "test": "node ./scripts/test.mjs",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "string-width": "7.0.0"
+  },
+  "devDependencies": {
+    "ansi-escapes": "6.2.0",
+    "is-unicode-supported": "2.0.0",
+    "supports-color": "9.4.0"
+  }
+}

package/src/.jsenv/jsenv_tests_output.txt

@@ -0,0 +1,35 @@
+----------- 23 executions to run ------------
+20 with node (node_worker_thread@20.11.0)
+1 with chromium (chromium@120.0.6099.28)
+1 with firefox (firefox@119.0)
+1 with webkit (webkit@17.4)
+---------------------------------------------
+
+✔ 01/23 _tests/byte/file_size.test.js [node/0.03s/1.2MB] (1 completed)
+✔ 02/23 _tests/byte/memory_usage.test.js [node/0.03s/1.2MB] (2 completed)
+✔ 03/23 _tests/content_frame/content_frame.test.js [node/0.1s/2.6MB] (3 completed)
+✔ 04/23 _tests/js_value/_inspect.test.html [chromium/0.2s/10.1MB] (4 completed)
+✔ 05/23 _tests/js_value/_inspect.test.html [firefox/0.2s] (5 completed)
+✔ 06/23 _tests/js_value/_inspect.test.html [webkit/0.3s] (6 completed)
+✔ 07/23 _tests/js_value/array.test.js [node/0.09s/1.2MB] (7 completed)
+✔ 08/23 _tests/js_value/biginit.test.js [node/0.06s/1.2MB] (8 completed)
+✔ 09/23 _tests/js_value/boolean.test.js [node/0.1s/1.2MB] (9 completed)
+✔ 10/23 _tests/js_value/date.test.js [node/0.04s/1.2MB] (10 completed)
+✔ 11/23 _tests/js_value/error.test.js [node/0.05s/1.2MB] (11 completed)
+✔ 12/23 _tests/js_value/function.test.js [node/0.05s/1.2MB] (12 completed)
+✔ 13/23 _tests/js_value/instance.test.js [node/0.05s/1.2MB] (13 completed)
+✔ 14/23 _tests/js_value/null.test.js [node/0.04s/1.2MB] (14 completed)
+✔ 15/23 _tests/js_value/number.test.js [node/0.06s/1.3MB] (15 completed)
+✔ 16/23 _tests/js_value/object.test.js [node/0.05s/1.3MB] (16 completed)
+✔ 17/23 _tests/js_value/regexp.test.js [node/0.05s/1.2MB] (17 completed)
+✔ 18/23 _tests/js_value/string.test.js [node/0.05s/1.2MB] (18 completed)
+✔ 19/23 _tests/js_value/symbol.test.js [node/0.05s/1.2MB] (19 completed)
+✔ 20/23 _tests/js_value/undefined.test.js [node/0.06s/1.2MB] (20 completed)
+✔ 21/23 _tests/time/decimals.test.js [node/0.03s/1.2MB] (21 completed)
+✔ 22/23 _tests/time/duration.test.js [node/0.03s/1.2MB] (22 completed)
+✔ 23/23 _tests/time/ellapsed.test.js [node/0.02s/1.2MB] (all completed)
+
+------------------ summary ------------------
+23 executions: all completed
+duration: 4.4s (setup: 0.4s, execution: 4.2s, teardown: 0.2s)
+---------------------------------------------

package/src/_tests/byte/file_size.test.js

@@ -0,0 +1,18 @@
+import { assert } from "@jsenv/assert";
+
+import { humanizeFileSize } from "@jsenv/humanize";
+
+const test = (fileSize, expected) => {
+  const actual = humanizeFileSize(fileSize);
+  assert({ actual, expected });
+};
+
+test(0, "0 B");
+test(1, "1 B");
+test(1000, "1 kB");
+test(1110, "1.1 kB");
+test(1010, "1 kB");
+test(10100, "10.1 kB");
+test(100100, "100 kB");
+test(1000100, "1 MB");
+test(1100000, "1.1 MB");

package/src/_tests/byte/memory_usage.test.js

@@ -0,0 +1,11 @@
+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/_tests/content_frame/content_frame.test.js

@@ -0,0 +1,156 @@
+import { writeFileSync } from "node:fs";
+import { takeFileSnapshot } from "@jsenv/snapshot";
+
+import { generateContentFrame } from "@jsenv/humanize";
+
+let number = 1;
+const test = (name, params) => {
+  const snapshotFileUrl = new URL(
+    `./snapshots/${number}_${name}`,
+    import.meta.url,
+  );
+  number++;
+  const fileSnapshot = takeFileSnapshot(snapshotFileUrl);
+  const inspectContentResult = generateContentFrame(params);
+  writeFileSync(snapshotFileUrl, inspectContentResult);
+  fileSnapshot.compare();
+  return inspectContentResult;
+};
+
+test("basic.txt", {
+  content: `const a = false;
+const b = true;
+const c = true;
+const d = true;
+const e = false;
+  `,
+  line: 3,
+  column: 1,
+  linesAbove: 1,
+  linesBelow: 1,
+});
+
+test("basic_2.txt", {
+  content: `const a = false;
+const b = true;
+const c = true;
+const d = true;
+const e = false;`,
+  line: 3,
+  column: 7,
+  linesAbove: 4,
+  linesBelow: 2,
+});
+
+test("empty_last_line.txt", {
+  content: `const a = false;
+const b = true;
+const c = true;
+const d = true;
+const e = false;
+  `,
+  line: 3,
+  column: 1,
+  linesAbove: 4,
+  linesBelow: 3,
+});
+
+test("no_column.txt", {
+  content: `const a = false;
+const b = true;
+const c = true;
+const d = true;
+const e = false;
+  `,
+  line: 3,
+  linesAbove: 1,
+  linesBelow: 1,
+});
+
+test("line_1_and_2_digits.txt", {
+  content: `const a = false;
+const b = false;
+const c = false;
+const d = false;
+const e = false;
+const f = false;
+const g = false;
+const h = false;
+const i = true;
+const j = true;
+const k = true;
+const l = true;`,
+  line: 10,
+  linesAbove: 1,
+  linesBelow: 1,
+});
+
+test("line_too_long_column_undefined.txt", {
+  content: `const a = false;
+const b = true;
+const thisVariableNameisQuiteLong = true;
+const d = true;
+const e = false;
+  `,
+  line: 3,
+  linesAbove: 1,
+  linesBelow: 1,
+  lineMaxWidth: 15,
+});
+
+test("line_too_long_column_near_start.txt", {
+  content: `const a = false;
+const b = true;
+const thisVariableNameisQuiteLong = true;
+const d = true;
+const e = false;
+  `,
+  line: 3,
+  column: 4,
+  linesAbove: 1,
+  linesBelow: 1,
+  lineMaxWidth: 15,
+});
+
+test("line_too_long_column_near_middle.txt", {
+  content: `const a = false;
+const b = true
+const thisVariableNameisQuiteLong = true;
+const d = tru
+const e = false;
+`,
+  line: 3,
+  column: 20,
+  linesAbove: 1,
+  linesBelow: 1,
+  lineMaxWidth: 14,
+});
+
+test("line_too_long_column_near_end.txt", {
+  content: `const a = false;
+
+const thisVariableNameisQuiteLong = true;
+const d = tru
+const e = false;
+  `,
+  line: 3,
+  column: 35,
+  linesAbove: 1,
+  linesBelow: 1,
+  lineMaxWidth: 15,
+});
+
+test("line_and_column_are_zero.txt", {
+  content: `const a = false;`,
+  line: 0,
+  column: 0,
+});
+
+test("line_is_last.txt", {
+  content: `const a = false;
+const b = false;
+const c = true;`,
+  line: 2,
+  linesBelow: 0,
+  column: 0,
+});

package/src/_tests/content_frame/snapshots/10_line_and_column_are_zero.txt

@@ -0,0 +1,2 @@
+1 | const a = false;
+    ^

package/src/_tests/content_frame/snapshots/11_line_is_last.txt

@@ -0,0 +1,3 @@
+1 | const a = false;
+2 | const b = false;
+    ^

package/src/_tests/content_frame/snapshots/1_basic.txt

@@ -0,0 +1,4 @@
+2 | const b = true;
+3 | const c = true;
+    ^
+4 | const d = true;

package/src/_tests/content_frame/snapshots/2_basic_2.txt

@@ -0,0 +1,6 @@
+1 | const a = false;
+2 | const b = true;
+3 | const c = true;
+          ^
+4 | const d = true;
+5 | const e = false;

package/src/_tests/content_frame/snapshots/3_empty_last_line.txt

@@ -0,0 +1,7 @@
+1 | const a = false;
+2 | const b = true;
+3 | const c = true;
+    ^
+4 | const d = true;
+5 | const e = false;
+6 |   

package/src/_tests/content_frame/snapshots/4_no_column.txt

@@ -0,0 +1,3 @@
+  2 | const b = true;
+> 3 | const c = true;
+  4 | const d = true;

package/src/_tests/content_frame/snapshots/5_line_1_and_2_digits.txt

@@ -0,0 +1,3 @@
+   9 | const i = true;
+> 10 | const j = true;
+  11 | const k = true;

package/src/_tests/content_frame/snapshots/6_line_too_long_column_undefined.txt

@@ -0,0 +1,3 @@
+  2 | const b = true;
+> 3 | const thisVari…
+  4 | const d = true;

package/src/_tests/content_frame/snapshots/7_line_too_long_column_near_start.txt

@@ -0,0 +1,4 @@
+2 | const b = true;
+3 | const thisVari…
+       ^
+4 | const d = true;

package/src/_tests/content_frame/snapshots/8_line_too_long_column_near_middle.txt

@@ -0,0 +1,4 @@
+2 | 
+3 | …ableNameisQu…
+          ^
+4 | 

package/src/_tests/content_frame/snapshots/9_line_too_long_column_near_end.txt

@@ -0,0 +1,4 @@
+2 | 
+3 | …eLong = true;
+           ^
+4 | 

package/src/_tests/js_value/_inspect.test.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Inspect tests</title>
+    <meta charset="utf-8" />
+    <link rel="icon" href="data:," />
+  </head>
+
+  <body>
+    <script type="module" src="./array.test.js"></script>
+    <script type="module" src="./boolean.test.js"></script>
+    <script type="module" src="./date.test.js"></script>
+    <script type="module" src="./error.test.js"></script>
+    <script type="module" src="./function.test.js"></script>
+    <script type="module" src="./instance.test.js"></script>
+    <script type="module" src="./null.test.js"></script>
+    <script type="module" src="./number.test.js"></script>
+    <script type="module" src="./regexp.test.js"></script>
+    <script type="module" src="./symbol.test.js"></script>
+    <script type="module" src="./undefined.test.js"></script>
+  </body>
+</html>

package/src/_tests/js_value/array.test.js

@@ -0,0 +1,72 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+{
+  const actual = humanize([]);
+  const expected = `[]`;
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize([[]]);
+  const expected = `[
+  []
+]`;
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(Array(3));
+  // prettier-ignore
+  const expected = `[
+  ,
+  ,
+${"  "}
+]`
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize([Symbol()]);
+  const expected = `[
+  Symbol()
+]`;
+  assert({ actual, expected });
+}
+
+{
+  // eslint-disable-next-line no-array-constructor
+  const newArray = new Array("foo", 1);
+
+  {
+    const actual = humanize(newArray);
+    const expected = `[
+  "foo",
+  1
+]`;
+    assert({
+      actual,
+      expected,
+    });
+  }
+
+  {
+    const actual = humanize(newArray);
+    const expected = `[
+  "foo",
+  1
+]`;
+    assert({ actual, expected });
+  }
+}
+
+{
+  const circularArray = [0];
+  circularArray.push(circularArray);
+  const actual = humanize(circularArray);
+  const expected = `[
+  0,
+  Symbol.for('circular')
+]`;
+  assert({ actual, expected });
+}

package/src/_tests/js_value/biginit.test.js

@@ -0,0 +1,36 @@
+/* eslint-disable no-eval */
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+{
+  const value = BigInt(1);
+  const actual = humanize(value);
+  const expected = "1n";
+  assert({ actual, expected });
+}
+
+{
+  const value = 2n;
+  const actual = humanize(value);
+  const expected = "2n";
+  assert({ actual, expected });
+}
+
+{
+  const value = Object(BigInt(1));
+  const actual = humanize(value);
+  const expected = "BigInt(1n)";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(1234567n);
+  const expected = "1234567n";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(19223n);
+  const expected = "19223n";
+  assert({ actual, expected });
+}

package/src/_tests/js_value/boolean.test.js

@@ -0,0 +1,45 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+{
+  const actual = humanize(true);
+  const expected = "true";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(false);
+  const expected = "false";
+  assert({ actual, expected });
+}
+
+/* eslint-disable no-new-wrappers */
+{
+  const actual = humanize(new Boolean(true));
+  const expected = "Boolean(true)";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(new Boolean(true), { parenthesis: true });
+  const expected = "(Boolean(true))";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(new Boolean(true), { useNew: true });
+  const expected = "new Boolean(true)";
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(new Boolean(true), {
+    parenthesis: true,
+    useNew: true,
+  });
+  const expected = "new (Boolean(true))";
+  assert({
+    actual,
+    expected,
+  });
+}

package/src/_tests/js_value/date.test.js

@@ -0,0 +1,15 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+{
+  const actual = humanize(new Date(10));
+  const expected = `Date(10)`;
+  assert({ actual, expected });
+}
+
+{
+  const nowMs = Date.now();
+  const actual = humanize(new Date(nowMs));
+  const expected = `Date(${nowMs})`;
+  assert({ actual, expected });
+}

package/src/_tests/js_value/error.test.js

@@ -0,0 +1,33 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+{
+  const actual = humanize(new Error("here"));
+  const expected = `Error("here")`;
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(new RangeError("here"));
+  const expected = `RangeError("here")`;
+  assert({ actual, expected });
+}
+
+{
+  const actualError = new Error("hello");
+  Object.defineProperty(actualError, "bar", {
+    enumerable: false,
+    value: "bar",
+  });
+  const actual = humanize(actualError);
+  const expected = `Error("hello")`;
+  assert({ actual, expected });
+}
+
+{
+  const error = new Error();
+  error.name = "AssertionError";
+  const actual = humanize(error);
+  const expected = `Error("")`;
+  assert({ actual, expected });
+}

package/src/_tests/js_value/function.test.js

@@ -0,0 +1,51 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+// const arrowFunctionSupported = (() => {}).prototype === null
+
+{
+  const actual = humanize(function () {});
+  const expected = `function () {/* hidden */}`;
+  assert({ actual, expected });
+}
+
+{
+  const actual = humanize(function () {}, { showFunctionBody: true });
+  const expected = "function () {}";
+  assert({ actual, expected });
+}
+
+{
+  const value = function () {
+    return true;
+  };
+  const actual = humanize(value, { showFunctionBody: true });
+  const expected = value.toString();
+  assert({ actual, expected });
+}
+
+function named(a) {
+  return a;
+}
+{
+  const actual = humanize(named);
+  const expected = `function named() {/* hidden */}`;
+  assert({ actual, expected });
+}
+{
+  const actual = humanize(named, { showFunctionBody: true });
+  const expected = named.toString();
+  assert({ actual, expected });
+}
+
+{
+  const nested = {
+    // eslint-disable-next-line object-shorthand
+    function: function () {},
+  };
+  const actual = humanize(nested);
+  const expected = `{
+  "function": function () {/* hidden */}
+}`;
+  assert({ actual, expected });
+}

package/src/_tests/js_value/instance.test.js

@@ -0,0 +1,12 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+const CustomConstructor = function () {
+  this.foo = true;
+};
+const customInstance = new CustomConstructor();
+const actual = humanize(customInstance);
+const expected = `CustomConstructor({
+  "foo": true
+})`;
+assert({ actual, expected });

package/src/_tests/js_value/null.test.js

@@ -0,0 +1,6 @@
+import { assert } from "@jsenv/assert";
+import { humanize } from "@jsenv/humanize";
+
+const actual = humanize(null);
+const expected = "null";
+assert({ actual, expected });