@cjser/clean-stack 6.0.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,85 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/clean-stack/index.js
+var index_exports = {};
+__export(index_exports, {
+  default: () => cleanStack
+});
+module.exports = __toCommonJS(index_exports);
+var import_escape_string_regexp = __toESM(require("@cjser/escape-string-regexp"), 1);
+var import_url_extras = require("@cjser/url-extras");
+var extractPathRegex = /\s+at.*[(\s](.*)\)?/;
+var pathRegex = /^(?:(?:(?:node|node:[\w/]+|(?:(?:node:)?internal\/[\w/]*|.*node_modules\/(?:babel-polyfill|pirates)\/.*)?\w+)(?:\.js)?:\d+:\d+)|native)/;
+var simplePathRegex = /^\w+\.js:\d+:\d+$/;
+function cleanStack(stack, { pretty = false, basePath, pathFilter } = {}) {
+  var _a;
+  if (typeof stack !== "string") {
+    return void 0;
+  }
+  const basePathRegex = basePath && new RegExp(`(file://)?${(0, import_escape_string_regexp.default)(basePath.replaceAll("\\", "/"))}/?`, "g");
+  let homeDirectory = "";
+  if (pretty) {
+    const os = (_a = process.getBuiltinModule) == null ? void 0 : _a.call(process, "node:os");
+    homeDirectory = os ? os.homedir().replaceAll("\\", "/") : "";
+  }
+  return stack.replaceAll("\\", "/").split("\n").filter((line) => {
+    const pathMatches = line.match(extractPathRegex);
+    if (!(pathMatches == null ? void 0 : pathMatches[1])) {
+      return true;
+    }
+    const match = pathMatches[1];
+    if (match.includes(".app/Contents/Resources/electron.asar") || match.includes(".app/Contents/Resources/default_app.asar") || match.includes("node_modules/electron/dist/resources/electron.asar") || match.includes("node_modules/electron/dist/resources/default_app.asar")) {
+      return false;
+    }
+    if (simplePathRegex.test(match)) {
+      return true;
+    }
+    if (pathRegex.test(match)) {
+      return false;
+    }
+    return pathFilter ? pathFilter(match) : true;
+  }).filter((line) => line.trim() !== "").map((line) => {
+    if (basePathRegex) {
+      line = line.replace(basePathRegex, "");
+    }
+    if (pretty) {
+      line = line.replace(extractPathRegex, (m, p1) => {
+        let filePath = p1;
+        if (filePath.startsWith("file://")) {
+          filePath = (0, import_url_extras.fileURLToPath)(filePath);
+        }
+        if (homeDirectory) {
+          filePath = filePath.replace(homeDirectory, "~");
+        }
+        return m.replace(p1, filePath);
+      });
+    }
+    return line;
+  }).join("\n");
+}

package/index.d.ts

@@ -0,0 +1,76 @@
+export type Options = {
+	/**
+	Prettify the file paths in the stack:
+
+	- `/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `~/dev/clean-stack/unicorn.js:2:15`
+	- `file:///Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `~/dev/clean-stack/unicorn.js:2:15`
+
+	When enabled, file URLs are converted to regular paths for better readability and IDE integration.
+
+	@default false
+	*/
+	readonly pretty?: boolean;
+
+	/**
+	Remove the given base path from stack trace file paths, effectively turning absolute paths into relative ones.
+
+	Example with `'/Users/sindresorhus/dev/clean-stack/'` as `basePath`:
+
+	`/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `unicorn.js:2:15`
+	*/
+	readonly basePath?: string;
+
+	/**
+	Remove the stack lines where the given function returns `false`. The function receives the path part of the stack line.
+
+	@example
+	```
+	import cleanStack from '@cjser/clean-stack';
+
+	const error = new Error('Missing unicorn');
+
+	console.log(cleanStack(error.stack));
+	// Error: Missing unicorn
+	//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+	//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/omit-me.js:1:16)
+
+	const pathFilter = path => !/omit-me/.test(path);
+
+	console.log(cleanStack(error.stack, {pathFilter}));
+	// Error: Missing unicorn
+	//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+	```
+	*/
+	readonly pathFilter?: (path: string) => boolean;
+};
+
+/**
+Clean up error stack traces. Removes the mostly unhelpful internal Node.js entries.
+
+@param stack - The `stack` property of an `Error`.
+@returns The cleaned stack or `undefined` if the given `stack` is `undefined`.
+
+@example
+```
+import cleanStack from '@cjser/clean-stack';
+
+const error = new Error('Missing unicorn');
+
+console.log(error.stack);
+
+// Error: Missing unicorn
+//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+//     at Module._compile (module.js:409:26)
+//     at Object.Module._extensions..js (module.js:416:10)
+//     at Module.load (module.js:343:32)
+//     at Function.Module._load (module.js:300:12)
+//     at Function.Module.runMain (module.js:441:10)
+//     at startup (node.js:139:18)
+
+console.log(cleanStack(error.stack));
+
+// Error: Missing unicorn
+//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+```
+*/
+export default function cleanStack<T extends string | undefined>(stack: T, options?: Options): T;

package/index.js

@@ -0,0 +1,81 @@
+import escapeStringRegexp from '@cjser/escape-string-regexp';
+import {fileURLToPath} from '@cjser/url-extras';
+
+const extractPathRegex = /\s+at.*[(\s](.*)\)?/;
+const pathRegex = /^(?:(?:(?:node|node:[\w/]+|(?:(?:node:)?internal\/[\w/]*|.*node_modules\/(?:babel-polyfill|pirates)\/.*)?\w+)(?:\.js)?:\d+:\d+)|native)/;
+const simplePathRegex = /^\w+\.js:\d+:\d+$/;
+
+export default function cleanStack(stack, {pretty = false, basePath, pathFilter} = {}) {
+	if (typeof stack !== 'string') {
+		return undefined;
+	}
+
+	const basePathRegex = basePath && new RegExp(`(file://)?${escapeStringRegexp(basePath.replaceAll('\\', '/'))}/?`, 'g');
+
+	let homeDirectory = '';
+	if (pretty) {
+		const os = process.getBuiltinModule?.('node:os');
+		homeDirectory = os ? os.homedir().replaceAll('\\', '/') : '';
+	}
+
+	return stack.replaceAll('\\', '/')
+		.split('\n')
+		.filter(line => {
+			const pathMatches = line.match(extractPathRegex);
+			if (!pathMatches?.[1]) {
+				return true; // Keep lines without paths (like error messages)
+			}
+
+			const match = pathMatches[1];
+
+			// Filter out Electron internal paths
+			if (
+				match.includes('.app/Contents/Resources/electron.asar')
+				|| match.includes('.app/Contents/Resources/default_app.asar')
+				|| match.includes('node_modules/electron/dist/resources/electron.asar')
+				|| match.includes('node_modules/electron/dist/resources/default_app.asar')
+			) {
+				return false;
+			}
+
+			// Keep simple relative paths like 'foo.js:1:1'
+			if (simplePathRegex.test(match)) {
+				return true;
+			}
+
+			// Filter out internal Node.js paths
+			if (pathRegex.test(match)) {
+				return false;
+			}
+
+			// Apply user's path filter if provided
+			return pathFilter ? pathFilter(match) : true;
+		})
+		.filter(line => line.trim() !== '')
+		.map(line => {
+			if (basePathRegex) {
+				line = line.replace(basePathRegex, '');
+			}
+
+			if (pretty) {
+				line = line.replace(extractPathRegex, (m, p1) => {
+					let filePath = p1;
+
+					// Convert file:// URLs to regular paths first
+					if (filePath.startsWith('file://')) {
+						filePath = fileURLToPath(filePath);
+					}
+
+					// Then replace home directory with ~ (only if homeDirectory is not empty)
+					if (homeDirectory) {
+						filePath = filePath.replace(homeDirectory, '~');
+					}
+
+					return m.replace(p1, filePath);
+				});
+			}
+
+			return line;
+		})
+		.join('\n');
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@cjser/clean-stack",
+  "version": "6.0.0-cjser.2",
+  "description": "Clean up error stack traces",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "xo && ava"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "clean",
+    "stack",
+    "trace",
+    "traces",
+    "error",
+    "electron"
+  ],
+  "dependencies": {
+    "@cjser/escape-string-regexp": "5.0.0-cjser.2",
+    "@cjser/url-extras": "0.1.0-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^6.4.1",
+    "xo": "^0.56.0"
+  },
+  "xo": {
+    "rules": {
+      "n/prefer-global/process": "off"
+    }
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "6.0.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "clean-stack",
+      "version": "6.0.0",
+      "exports": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "repository": "sindresorhus/clean-stack",
+      "dependencies": {
+        "escape-string-regexp": "5.0.0",
+        "url-extras": "^0.1.0"
+      },
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,110 @@
+# clean-stack
+
+> Clean up error stack traces
+
+Removes the mostly unhelpful internal Node.js entries.
+
+Also works in the browser and Electron.
+
+## Install
+
+```sh
+npm install clean-stack
+```
+
+## Usage
+
+```js
+import cleanStack from 'clean-stack';
+
+const error = new Error('Missing unicorn');
+
+console.log(error.stack);
+/*
+Error: Missing unicorn
+    at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+    at Module._compile (module.js:409:26)
+    at Object.Module._extensions..js (module.js:416:10)
+    at Module.load (module.js:343:32)
+    at Function.Module._load (module.js:300:12)
+    at Function.Module.runMain (module.js:441:10)
+    at startup (node.js:139:18)
+*/
+
+console.log(cleanStack(error.stack));
+/*
+Error: Missing unicorn
+    at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+*/
+```
+
+## API
+
+### cleanStack(stack, options?)
+
+Returns the cleaned stack or `undefined` if the given `stack` is `undefined`.
+
+#### stack
+
+Type: `string | undefined`
+
+The `stack` property of an [`Error`](https://github.com/microsoft/TypeScript/blob/eac073894b172ec719ca7f28b0b94fc6e6e7d4cf/lib/lib.es5.d.ts#L972-L976).
+
+#### options
+
+Type: `object`
+
+##### pretty
+
+Type: `boolean`\
+Default: `false`
+
+Prettify the file paths in the stack:
+
+- `/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `~/dev/clean-stack/unicorn.js:2:15`
+- `file:///Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `~/dev/clean-stack/unicorn.js:2:15`
+
+When enabled, file URLs are converted to regular paths for better readability and IDE integration.
+
+##### basePath
+
+Type: `string?`
+
+Remove the given base path from stack trace file paths, effectively turning absolute paths into relative ones. It will also transform absolute file URLs into relative paths.
+
+Example with `'/Users/sindresorhus/dev/clean-stack'` as `basePath`:
+
+`/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15` → `unicorn.js:2:15`
+
+##### pathFilter
+
+Type: `(path: string) => boolean`
+
+Remove the stack lines where the given function returns `false`. The function receives the path part of the stack line.
+
+```js
+import cleanStack from 'clean-stack';
+
+const error = new Error('Missing unicorn');
+
+console.log(cleanStack(error.stack));
+// Error: Missing unicorn
+//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/omit-me.js:1:16)
+
+const pathFilter = path => !/omit-me/.test(path);
+
+console.log(cleanStack(error.stack, {pathFilter}));
+// Error: Missing unicorn
+//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
+```
+
+## Related
+
+- [extract-stack](https://github.com/sindresorhus/extract-stack) - Extract the actual stack of an error
+- [stack-utils](https://github.com/tapjs/stack-utils) - Captures and cleans stack traces
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/clean-stack