@jsenv/humanize 1.4.0 → 1.5.1

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

@@ -1,5 +1,7 @@
-import { createSupportsColor, isUnicodeSupported, stripAnsi, emojiRegex, eastAsianWidth, clearTerminal, eraseLines } from "./jsenv_humanize_node_modules.js";
+import { createSupportsColor, isUnicodeSupported, emojiRegex, eastAsianWidth } from "./jsenv_humanize_node_modules.js";
+import stripAnsi from "strip-ansi";
 import { stripVTControlCharacters } from "node:util";
+import ansiEscapes from "ansi-escapes";
 import "node:process";
 import "node:os";
 import "node:tty";
@@ -1407,6 +1409,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,
@@ -1709,7 +1749,7 @@ const createDynamicLog = ({
     if (visualLineCount > rows) {
       if (clearTerminalAllowed) {
         clearAttemptResult = true;
-        return clearTerminal;
+        return ansiEscapes.clearTerminal;
       }
       // the whole log cannot be cleared because it's vertically to long
       // (longer than terminal height)
@@ -1722,7 +1762,7 @@ const createDynamicLog = ({
     }
 
     clearAttemptResult = true;
-    return eraseLines(visualLineCount);
+    return ansiEscapes.eraseLines(visualLineCount);
   };
 
   const update = (string) => {
@@ -1964,4 +2004,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/dist/node/jsenv_humanize_node_modules.js

@@ -211,30 +211,6 @@ function isUnicodeSupported() {
 		|| env.TERMINAL_EMULATOR === 'JetBrains-JediTerm';
 }
 
-function ansiRegex({onlyFirst = false} = {}) {
-	// Valid string terminator sequences are BEL, ESC\, and 0x9c
-	const ST = '(?:\\u0007|\\u001B\\u005C|\\u009C)';
-	const pattern = [
-		`[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?${ST})`,
-		'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))',
-	].join('|');
-
-	return new RegExp(pattern, onlyFirst ? undefined : 'g');
-}
-
-const regex = ansiRegex();
-
-function stripAnsi(string) {
-	if (typeof string !== 'string') {
-		throw new TypeError(`Expected a \`string\`, got \`${typeof string}\``);
-	}
-
-	// Even though the regex is global, we don't need to reset the `.lastIndex`
-	// because unlike `.exec()` and `.test()`, `.replace()` does it automatically
-	// and doing it manually has a performance penalty.
-	return string.replace(regex, '');
-}
-
 const r = String.raw;
 const seq = r`(?:\p{Emoji}\uFE0F\u20E3?|\p{Emoji_Modifier_Base}\p{Emoji_Modifier}?|\p{Emoji_Presentation})`;
 const sTags = r`\u{E0061}-\u{E007A}`;
@@ -625,85 +601,4 @@ function eastAsianWidth(codePoint, {ambiguousAsWide = false} = {}) {
 	return 1;
 }
 
-/* globals WorkerGlobalScope, DedicatedWorkerGlobalScope, SharedWorkerGlobalScope, ServiceWorkerGlobalScope */
-
-const isBrowser = globalThis.window?.document !== undefined;
-
-globalThis.process?.versions?.node !== undefined;
-
-globalThis.process?.versions?.bun !== undefined;
-
-globalThis.Deno?.version?.deno !== undefined;
-
-globalThis.process?.versions?.electron !== undefined;
-
-globalThis.navigator?.userAgent?.includes('jsdom') === true;
-
-typeof WorkerGlobalScope !== 'undefined' && globalThis instanceof WorkerGlobalScope;
-
-typeof DedicatedWorkerGlobalScope !== 'undefined' && globalThis instanceof DedicatedWorkerGlobalScope;
-
-typeof SharedWorkerGlobalScope !== 'undefined' && globalThis instanceof SharedWorkerGlobalScope;
-
-typeof ServiceWorkerGlobalScope !== 'undefined' && globalThis instanceof ServiceWorkerGlobalScope;
-
-// Note: I'm intentionally not DRYing up the other variables to keep them "lazy".
-const platform = globalThis.navigator?.userAgentData?.platform;
-
-platform === 'macOS'
-	|| globalThis.navigator?.platform === 'MacIntel' // Even on Apple silicon Macs.
-	|| globalThis.navigator?.userAgent?.includes(' Mac ') === true
-	|| globalThis.process?.platform === 'darwin';
-
-platform === 'Windows'
-	|| globalThis.navigator?.platform === 'Win32'
-	|| globalThis.process?.platform === 'win32';
-
-platform === 'Linux'
-	|| globalThis.navigator?.platform?.startsWith('Linux') === true
-	|| globalThis.navigator?.userAgent?.includes(' Linux ') === true
-	|| globalThis.process?.platform === 'linux';
-
-platform === 'Android'
-	|| globalThis.navigator?.platform === 'Android'
-	|| globalThis.navigator?.userAgent?.includes(' Android ') === true
-	|| globalThis.process?.platform === 'android';
-
-const ESC = '\u001B[';
-
-!isBrowser && process.env.TERM_PROGRAM === 'Apple_Terminal';
-const isWindows = !isBrowser && process.platform === 'win32';
-
-isBrowser ? () => {
-	throw new Error('`process.cwd()` only works in Node.js, not the browser.');
-} : process.cwd;
-
-const cursorUp = (count = 1) => ESC + count + 'A';
-
-const cursorLeft = ESC + 'G';
-
-const eraseLines = count => {
-	let clear = '';
-
-	for (let i = 0; i < count; i++) {
-		clear += eraseLine + (i < count - 1 ? cursorUp() : '');
-	}
-
-	if (count) {
-		clear += cursorLeft;
-	}
-
-	return clear;
-};
-const eraseLine = ESC + '2K';
-const eraseScreen = ESC + '2J';
-
-const clearTerminal = isWindows
-	? `${eraseScreen}${ESC}0f`
-	// 1. Erases the screen (Only done in case `2` is not supported)
-	// 2. Erases the whole screen including scrollback buffer
-	// 3. Moves cursor to the top-left position
-	// More info: https://www.real-world-systems.com/docs/ANSIcode.html
-	:	`${eraseScreen}${ESC}3J${ESC}H`;
-
-export { clearTerminal, createSupportsColor, eastAsianWidth, emojiRegex, eraseLines, isUnicodeSupported, stripAnsi };
+export { createSupportsColor, eastAsianWidth, emojiRegex, isUnicodeSupported };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/humanize",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "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";