@jsenv/humanize 1.4.0 → 1.5.0

package/dist/browser/jsenv_humanize_browser.js

@@ -1379,4 +1379,26 @@ const createCallOrderer = () => {
   return callWhenPreviousExecutionAreDone;
 };
 
-export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, distributePercentages, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol };
+const errorToMarkdown = error => {
+  const errorIsAPrimitive = error === null || typeof error !== "object" && typeof error !== "function";
+  if (errorIsAPrimitive) {
+    return "```js\n".concat(error, "\n```");
+  }
+  return "```\n".concat(error.stack, "\n```");
+};
+
+const errorToHTML = error => {
+  const errorIsAPrimitive = error === null || typeof error !== "object" && typeof error !== "function";
+  if (errorIsAPrimitive) {
+    if (typeof error === "string") {
+      return "<pre>".concat(escapeHtml(error), "</pre>");
+    }
+    return "<pre>".concat(JSON.stringify(error, null, "  "), "</pre>");
+  }
+  return "<pre>".concat(escapeHtml(error.stack), "</pre>");
+};
+const escapeHtml = string => {
+  return string.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+};
+
+export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, distributePercentages, errorToHTML, errorToMarkdown, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol };

package/dist/node/jsenv_humanize_node.js

@@ -1407,6 +1407,44 @@ const createCallOrderer = () => {
   return callWhenPreviousExecutionAreDone;
 };
 
+const errorToMarkdown = (error) => {
+  const errorIsAPrimitive =
+    error === null ||
+    (typeof error !== "object" && typeof error !== "function");
+
+  if (errorIsAPrimitive) {
+    return `\`\`\`js
+${error}
+\`\`\``;
+  }
+  return `\`\`\`
+${error.stack}
+\`\`\``;
+};
+
+const errorToHTML = (error) => {
+  const errorIsAPrimitive =
+    error === null ||
+    (typeof error !== "object" && typeof error !== "function");
+
+  if (errorIsAPrimitive) {
+    if (typeof error === "string") {
+      return `<pre>${escapeHtml(error)}</pre>`;
+    }
+    return `<pre>${JSON.stringify(error, null, "  ")}</pre>`;
+  }
+  return `<pre>${escapeHtml(error.stack)}</pre>`;
+};
+
+const escapeHtml = (string) => {
+  return string
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&#039;");
+};
+
 const renderBigSection = (params) => {
   return renderSection({
     width: 45,
@@ -1964,4 +2002,4 @@ const createTaskLog = (
   };
 };
 
-export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, createDynamicLog, createLogger, createTaskLog, distributePercentages, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol, renderBigSection, renderDetails, renderNamedSections, renderSection, startSpinner };
+export { ANSI, UNICODE, createCallOrderer, createDetailedMessage, createDynamicLog, createLogger, createTaskLog, distributePercentages, errorToHTML, errorToMarkdown, generateContentFrame, humanize, humanizeDuration, humanizeEllapsedTime, humanizeFileSize, humanizeMemory, humanizeMethodSymbol, renderBigSection, renderDetails, renderNamedSections, renderSection, startSpinner };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/humanize",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Generate messages meant to read by humans",
   "license": "MIT",
   "repository": {
@@ -32,7 +32,9 @@
     "/dist/",
     "/src/"
   ],
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/node/jsenv_humanize_node_modules.js"
+  ],
   "scripts": {
     "build": "node ./scripts/build.mjs",
     "prepublishOnly": "npm run build"

package/src/error/error_to_html.js

@@ -0,0 +1,22 @@
+export const errorToHTML = (error) => {
+  const errorIsAPrimitive =
+    error === null ||
+    (typeof error !== "object" && typeof error !== "function");
+
+  if (errorIsAPrimitive) {
+    if (typeof error === "string") {
+      return `<pre>${escapeHtml(error)}</pre>`;
+    }
+    return `<pre>${JSON.stringify(error, null, "  ")}</pre>`;
+  }
+  return `<pre>${escapeHtml(error.stack)}</pre>`;
+};
+
+const escapeHtml = (string) => {
+  return string
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&#039;");
+};

package/src/error/error_to_markdown.js

@@ -0,0 +1,14 @@
+export const errorToMarkdown = (error) => {
+  const errorIsAPrimitive =
+    error === null ||
+    (typeof error !== "object" && typeof error !== "function");
+
+  if (errorIsAPrimitive) {
+    return `\`\`\`js
+${error}
+\`\`\``;
+  }
+  return `\`\`\`
+${error.stack}
+\`\`\``;
+};

package/src/main_browser.js

@@ -9,3 +9,5 @@ export { humanizeFileSize, humanizeMemory } from "./byte/byte.js";
 export { distributePercentages } from "./percentage/distribute_percentages.js";
 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";

package/src/main_node.js

@@ -12,6 +12,8 @@ export { humanizeFileSize, humanizeMemory } from "./byte/byte.js";
 export { distributePercentages } from "./percentage/distribute_percentages.js";
 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";
 
 // node only
 export { renderSection, renderBigSection } from "./log/section.js";