https://github.com/ehmicky/modern-errors-clean
`modern-errors` plugin to clean stack traces.
https://github.com/ehmicky/modern-errors-clean
browser clean code-quality cwd error error-handler error-handling error-monitoring error-reporting errors javascript library modern-errors modern-errors-plugin nodejs plugins stack stacktrace stacktrace-library typescript
Last synced: about 1 month ago
JSON representation
`modern-errors` plugin to clean stack traces.
- Host: GitHub
- URL: https://github.com/ehmicky/modern-errors-clean
- Owner: ehmicky
- License: mit
- Created: 2022-11-04T20:14:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T02:46:08.000Z (about 1 month ago)
- Last Synced: 2025-03-17T03:30:54.386Z (about 1 month ago)
- Topics: browser, clean, code-quality, cwd, error, error-handler, error-handling, error-monitoring, error-reporting, errors, javascript, library, modern-errors, modern-errors-plugin, nodejs, plugins, stack, stacktrace, stacktrace-library, typescript
- Language: JavaScript
- Homepage:
- Size: 7.03 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/modern-errors-clean)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/modern-errors-clean)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
[`modern-errors`](https://github.com/ehmicky/modern-errors)
[plugin](https://github.com/ehmicky/modern-errors#-plugins) to
[clean stack traces](https://github.com/sindresorhus/clean-stack).
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Features
- Shorten file paths, making them relative to the current directory
- Replace the home directory with `~`
- Remove unhelpful internal Node.js entries
# Example
[Adding the plugin](https://github.com/ehmicky/modern-errors#adding-plugins) to
[`modern-errors`](https://github.com/ehmicky/modern-errors).
```js
import ModernError from 'modern-errors'
import modernErrorsClean from 'modern-errors-clean'
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsClean],
})
// ...
```
`error.stack` (before):
```
Error: message
at exampleFunction (/home/ehmicky/repo/dev/example.js:7:2)
at main (/home/ehmicky/repo/dev/main.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)
```
`error.stack` (after):
```
Error: message
at exampleFunction (dev/example.js:7:2)
at main (dev/main.js:2:15)
```
# Install
```bash
npm install modern-errors-clean
```
This package requires Node.js >=18.18.0.
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## modernErrorsClean
_Type_: `Plugin`
Plugin object to pass to the
[`plugins` option](https://github.com/ehmicky/modern-errors#adding-plugins) of
`ErrorClass.subclass()`.
# Related projects
- [`clean-stack`](https://github.com/sindresorhus/clean-stack): Clean up error
stack traces
- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`modern-errors-cli`](https://github.com/ehmicky/modern-errors-cli): Handle
errors in CLI modules
- [`modern-errors-process`](https://github.com/ehmicky/modern-errors-process):
Handle process errors
- [`modern-errors-bugs`](https://github.com/ehmicky/modern-errors-bugs): Print
where to report bugs
- [`modern-errors-serialize`](https://github.com/ehmicky/modern-errors-serialize):
Serialize/parse errors
- [`modern-errors-http`](https://github.com/ehmicky/modern-errors-http): Create
HTTP error responses
- [`modern-errors-winston`](https://github.com/ehmicky/modern-errors-winston):
Log errors with Winston
- [`modern-errors-switch`](https://github.com/ehmicky/modern-errors-switch):
Execute class-specific logic
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!