modern-errors plugin to prettify errors.

This adds BaseError.beautiful(error) which prettifies error messages and stacks.

Features

• 🖍️ Pretty colors, icons and header
• ⛑️ Normalize invalid errors
• 🔕 Log verbosity: stack, properties
• 💥 Exception-safe

Screenshot

Example

Adding the plugin to modern-errors.

import ModernError from 'modern-errors'

import modernErrorsBeautiful from 'modern-errors-beautiful'

export const BaseError = ModernError.subclass('BaseError', {
  plugins: [modernErrorsBeautiful],
})
// ...

Prettifying the error.

try {
  // ...
} catch (error) {
  const message = BaseError.beautiful(error)
  console.error(message)
}

Install

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, not require(). If TypeScript is used, it must be configured to output ES modules, not CommonJS.

API

modernErrorsBeautiful

Type: Plugin

Plugin object to pass to the plugins option 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.

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. Can be disabled by passing an empty string.

💄 header

Type: string
Default: 'red bold'

Color/style of the error's icon and name. The available values are listed here. Several styles can be specified by using spaces. Can be disabled by passing an empty string.

Configuration

Options can apply to (in priority order):

• Any error: second argument to ModernError.subclass()

export const BaseError = ModernError.subclass('BaseError', {
  plugins: [modernErrorsBeautiful],
  beautiful: options,
})

• Any error of a specific class (and its subclasses): second argument to ErrorClass.subclass()

export const InputError = BaseError.subclass('InputError', {
  beautiful: options,
})

• A specific error: second argument to new ErrorClass()

throw new InputError('...', { beautiful: options })

• A specific BaseError.beautiful(error) call

BaseError.beautiful(error, options)

Related projects

• handle-cli-error: 💣 Error handler for CLI applications 💥
• beautiful-error: Prettify error messages and stacks
• modern-errors: Handle errors in a simple, stable, consistent way
• modern-errors-process: Handle process errors
• modern-errors-bugs: Print where to report bugs
• modern-errors-serialize: Serialize/parse errors
• modern-errors-clean: Clean stack traces
• modern-errors-http: Create HTTP error responses
• modern-errors-winston: Log errors with Winston
• modern-errors-switch: Execute class-specific logic

Support

For any question, don't hesitate to submit an issue on GitHub.

Everyone is welcome regardless of personal background. We enforce a Code of conduct 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. Pull requests are welcome!