clean-stack

Clean up error stack traces

Removes the mostly unhelpful internal Node.js entries.

Also works in Electron.

Install

1npm install clean-stack

Usage

1import cleanStack from 'clean-stack';
2
3const error = new Error('Missing unicorn');
4
5console.log(error.stack);
6/*
7Error: Missing unicorn
8    at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
9    at Module._compile (module.js:409:26)
10    at Object.Module._extensions..js (module.js:416:10)
11    at Module.load (module.js:343:32)
12    at Function.Module._load (module.js:300:12)
13    at Function.Module.runMain (module.js:441:10)
14    at startup (node.js:139:18)
15*/
16
17console.log(cleanStack(error.stack));
18/*
19Error: Missing unicorn
20    at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
21*/

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.

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

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.

1import cleanStack from 'clean-stack';
2
3const error = new Error('Missing unicorn');
4
5console.log(cleanStack(error.stack));
6// Error: Missing unicorn
7//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
8//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/omit-me.js:1:16)
9
10const pathFilter = path => !/omit-me/.test(path);
11
12console.log(cleanStack(error.stack, {pathFilter}));
13// Error: Missing unicorn
14//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)

Related

• extract-stack - Extract the actual stack of an error
• stack-utils - Captures and cleans stack traces