# clean-stack

> Clean up error stack traces

Latest version **6.0.0** (published 2025-11-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install clean-stack
pnpm add clean-stack
yarn add clean-stack
bun add clean-stack
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2025-11-04 |
| First published | 2016-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=20 |
| Dependencies | 2 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 346 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | clean, stack, trace, traces, error, electron |

## Links

- npm: https://www.npmjs.com/package/clean-stack
- Repository: https://github.com/sindresorhus/clean-stack
- Homepage: https://github.com/sindresorhus/clean-stack#readme
- Issues: https://github.com/sindresorhus/clean-stack/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/clean-stack

## Dependencies (2)

- [url-extras](https://npm.io/package/url-extras.md) ^0.1.0
- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) 5.0.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 6.0.0 (latest) — 2025-11-04
- 5.3.0 — 2025-09-15
- 5.2.0 — 2023-03-21
- 5.1.0 — 2022-12-20
- 5.0.1 — 2022-10-27
- 5.0.0 — 2022-09-27
- 4.2.0 — 2022-04-30
- 4.1.0 — 2021-05-25
- 4.0.1 — 2021-05-18
- 4.0.0 — 2021-04-17
- 3.0.1 — 2020-11-18
- 3.0.0 — 2020-06-13
- 2.2.0 — 2019-07-31
- 2.1.0 — 2019-04-07
- 2.0.0 — 2018-10-16
- … 7 more at https://npm.io/package/clean-stack/versions

## README

# 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

---
_Source: https://npm.io/package/clean-stack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._