https://github.com/ehmicky/modern-errors-beautiful
`modern-errors` plugin to prettify errors.
https://github.com/ehmicky/modern-errors-beautiful
bash browser cli console errors handler javascript library message modern-errors modern-errors-plugin monitoring nodejs plugins shell stack stacktrace terminal timeout typescript
Last synced: 7 months ago
JSON representation
`modern-errors` plugin to prettify errors.
- Host: GitHub
- URL: https://github.com/ehmicky/modern-errors-beautiful
- Owner: ehmicky
- License: mit
- Created: 2025-05-21T20:54:46.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-06-03T17:15:22.000Z (7 months ago)
- Last Synced: 2025-06-07T22:06:37.770Z (7 months ago)
- Topics: bash, browser, cli, console, errors, handler, javascript, library, message, modern-errors, modern-errors-plugin, monitoring, nodejs, plugins, shell, stack, stacktrace, terminal, timeout, typescript
- Language: TypeScript
- Homepage:
- Size: 510 KB
- Stars: 1
- Watchers: 1
- 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-beautiful)
[](/src/main.ts)
[](https://codecov.io/gh/ehmicky/modern-errors-beautiful)
[](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 prettify errors.
This adds [`BaseError.beautiful(error)`](#baseerrorbeautifulerror) which
prettifies error messages and stacks.
# Features
- 🖍️ Pretty [colors](#%EF%B8%8F-colors), [icons](#-icon) and [header](#-header)
- ⛑️ [Normalize](https://github.com/ehmicky/normalize-exception) invalid errors
- 🔕 Log verbosity: [stack](#-stack), [properties](#-props)
- 💥 Exception-safe
# Screenshot
# 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 modernErrorsBeautiful from 'modern-errors-beautiful'
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsBeautiful],
})
// ...
```
Prettifying the error.
```js
try {
// ...
} catch (error) {
const message = BaseError.beautiful(error)
console.error(message)
}
```
# Install
```bash
npm install modern-errors-beautiful
```
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
## modernErrorsBeautiful
_Type_: `Plugin`
Plugin object to pass to the
[`plugins` option](https://github.com/ehmicky/modern-errors#adding-plugins) of
`ErrorClass.subclass()`.
## BaseError.beautiful(error)
`error`: `any`\
_Return value_: `string`
Returns `error` as a prettified string.
This never throws. Invalid errors are silently
[normalized](https://github.com/ehmicky/normalize-exception).
## Options
_Type_: `object`
### 📕 stack
_Type_: `boolean`\
_Default_: `true`
Whether to show the error's stack trace.
### 📢 props
_Type_: `boolean`\
_Default_: `true`
Whether to show the error's additional properties.
### 🖍️ colors
_Type_: `boolean`\
_Default_: `true` in terminals, `false` otherwise
Whether to colorize the error's message, stack trace and additional properties.
Quoted strings in the error's message are printed in bold (for `"..."` and
`'...'`) and in italic (for `` `...` ``).
### ❌ icon
_Type_: `string`\
_Default_: `'cross'`
Icon prepended to the error's name. The available values are listed
[here](https://github.com/sindresorhus/figures/blob/main/readme.md#figures-1).
Can be disabled by passing an empty string.
### 💄 header
_Type_: `string`\
_Default_: `'red bold'`
Color/style of the error's [icon](#-icon) and name. The available values are
listed [here](https://github.com/ehmicky/chalk-string#available-styles). Several
styles can be specified by using spaces. Can be disabled by passing an empty
string.
## Configuration
[Options](#options) can apply to (in priority order):
- Any error: second argument to
[`ModernError.subclass()`](https://github.com/ehmicky/modern-errors#options-1)
```js
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsBeautiful],
beautiful: options,
})
```
- Any error of a specific class (and its subclasses): second argument to
[`ErrorClass.subclass()`](https://github.com/ehmicky/modern-errors#options-1)
```js
export const InputError = BaseError.subclass('InputError', {
beautiful: options,
})
```
- A specific error: second argument to
[`new ErrorClass()`](https://github.com/ehmicky/modern-errors#options-3)
```js
throw new InputError('...', { beautiful: options })
```
- A specific [`BaseError.beautiful(error)`](#baseerrorbeautifulerror) call
```js
BaseError.beautiful(error, options)
```
# Related projects
- [`handle-cli-error`](https://github.com/ehmicky/handle-cli-error): 💣 Error
handler for CLI applications 💥
- [`beautiful-error`](https://github.com/ehmicky/beautiful-error): Prettify
error messages and stacks
- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`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-clean`](https://github.com/ehmicky/modern-errors-clean): Clean
stack traces
- [`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!