@jsenv/humanize 1.5.2 → 1.6.0

package/dist/node/jsenv_humanize_node.js

@@ -1447,6 +1447,58 @@ const escapeHtml = (string) => {
     .replace(/'/g, "'");
 };
 
+const formatError = (error) => {
+  let text = "";
+  text += error.stack;
+  const { cause } = error;
+  if (cause) {
+    const formatCause = (cause, depth) => {
+      let causeText = prefixFirstAndIndentRemainingLines({
+        prefix: "  [cause]:",
+        indentation: "  ".repeat(depth + 1),
+        text: cause.stack,
+      });
+      const nestedCause = cause.cause;
+      if (nestedCause) {
+        const nestedCauseText = formatCause(nestedCause, depth + 1);
+        causeText += `\n${nestedCauseText}`;
+      }
+      return causeText;
+    };
+    const causeText = formatCause(cause, 0);
+    text += `\n${causeText}`;
+  }
+  return text;
+};
+
+const prefixFirstAndIndentRemainingLines = ({
+  prefix,
+  indentation,
+  text,
+  trimLines,
+  trimLastLine,
+}) => {
+  const lines = text.split(/\r?\n/);
+  const firstLine = lines.shift();
+  if (indentation === undefined) {
+    {
+      indentation = "  "; // prefix + space
+    }
+  }
+  let result = `${prefix} ${firstLine}` ;
+  let i = 0;
+  while (i < lines.length) {
+    const line = trimLines ? lines[i].trim() : lines[i];
+    i++;
+    result += line.length
+      ? `\n${indentation}${line}`
+      : trimLastLine && i === lines.length
+        ? ""
+        : `\n`;
+  }
+  return result;
+};
+
 const renderBigSection = (params) => {
   return renderSection({
     width: 45,
@@ -2004,4 +2056,4 @@ const createTaskLog = (
   };
 };
 
-export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, createDynamicLog, createLogger, createTaskLog, distributePercentages, errorToHTML, errorToMarkdown, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol, renderBigSection, renderDetails, renderNamedSections, renderSection, startSpinner };
+export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, createDynamicLog, createLogger, createTaskLog, distributePercentages, errorToHTML, errorToMarkdown, formatError, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol, renderBigSection, renderDetails, renderNamedSections, renderSection, startSpinner };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@jsenv/humanize",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Generate messages meant to read by humans",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/jsenv/core",
-    "directory": "packages/independent/tooling/humanize"
+    "directory": "packages/tooling/humanize"
   },
   "publishConfig": {
     "access": "public"
@@ -45,6 +45,10 @@
   },
   "devDependencies": {
     "is-unicode-supported": "2.1.0",
-    "supports-color": "10.0.0"
+    "supports-color": "10.0.0",
+    "@jsenv/core": "../..",
+    "@jsenv/snapshot": "../snapshot",
+    "@jsenv/assert": "../assert",
+    "@jsenv/terminal-text-size": "../terminal-text-size"
   }
 }

package/src/_tests/content_frame/content_frame.test.js

@@ -1,8 +1,7 @@
+import { generateContentFrame } from "@jsenv/humanize";
 import { takeFileSnapshot } from "@jsenv/snapshot";
 import { writeFileSync } from "node:fs";
 
-import { generateContentFrame } from "@jsenv/humanize";
-
 let number = 1;
 const test = (name, params) => {
   const snapshotFileUrl = new URL(

package/src/error/format_error.js

@@ -0,0 +1,53 @@
+export const formatError = (error) => {
+  let text = "";
+  text += error.stack;
+  const { cause } = error;
+  if (cause) {
+    const formatCause = (cause, depth) => {
+      let causeText = prefixFirstAndIndentRemainingLines({
+        prefix: "  [cause]:",
+        indentation: "  ".repeat(depth + 1),
+        text: cause.stack,
+      });
+      const nestedCause = cause.cause;
+      if (nestedCause) {
+        const nestedCauseText = formatCause(nestedCause, depth + 1);
+        causeText += `\n${nestedCauseText}`;
+      }
+      return causeText;
+    };
+    const causeText = formatCause(cause, 0);
+    text += `\n${causeText}`;
+  }
+  return text;
+};
+
+const prefixFirstAndIndentRemainingLines = ({
+  prefix,
+  indentation,
+  text,
+  trimLines,
+  trimLastLine,
+}) => {
+  const lines = text.split(/\r?\n/);
+  const firstLine = lines.shift();
+  if (indentation === undefined) {
+    if (prefix) {
+      indentation = "  "; // prefix + space
+    } else {
+      indentation = "";
+    }
+  }
+  let result = prefix ? `${prefix} ${firstLine}` : firstLine;
+  let i = 0;
+  while (i < lines.length) {
+    const line = trimLines ? lines[i].trim() : lines[i];
+    i++;
+    result += line.length
+      ? `\n${indentation}${line}`
+      : trimLastLine && i === lines.length
+        ? ""
+        : `\n`;
+  }
+  return result;
+};

package/src/main_node.js

@@ -14,6 +14,7 @@ export { generateContentFrame } from "./content_frame/content_frame.js";
 export { createCallOrderer } from "./log/call_orderer.js";
 export { errorToMarkdown } from "./error/error_to_markdown.js";
 export { errorToHTML } from "./error/error_to_html.js";
+export { formatError } from "./error/format_error.js";
 
 // node only
 export { renderSection, renderBigSection } from "./log/section.js";