handle-cli-error

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ehmicky/design/main/handle-cli-error/handle-cli-error_dark.svg"/> <img alt="handle-cli-error logo" src="https://raw.githubusercontent.com/ehmicky/design/main/handle-cli-error/handle-cli-error.svg" width="500"/> </picture> [![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js&colorA=404040&logoColor=66cc33)](https://www.npmjs.com/package/handle-cli-error) [![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript&colorA=404040&logoColor=0096ff)](/src/main.d.ts) [![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov&colorA=404040)](https://codecov.io/gh/ehmicky/handle-cli-error) [![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon&colorA=404040&logoColor=9590F9)](https://fosstodon.org/@ehmicky) [![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium&colorA=404040)](https://medium.com/@ehmicky) Error handler for CLI applications. # Features - 🖍️ Pretty [colors](#%EF%B8%8F-colors), [icons](#-icon) and [header](#-header) - 💣 [Error class-specific](#-classes) handling - 🚒 [Graceful exit](#-timeout) - ⛑️ [Normalize](https://github.com/ehmicky/normalize-exception) invalid errors - 🔕 Log verbosity: [message](#-silent), [stack](#-stack), [properties](#-props) - 🚨 Custom [exit code](#-exitcode) and [log function](#-log) - 💥 Exception-safe # Screenshot <img alt="handle-cli-error screenshot" src="docs/screenshot.png" width="500"/> # Example ## General ```js #!/usr/bin/env node import handleCliError from 'handle-cli-error' const cliMain = () => { try { // ... } catch (error) { handleCliError(error) // Logs `error` then exit the process } } cliMain() ``` ## Error class-specific ```js handleCliError(error, { classes: { InputError: { exitCode: 1, stack: false }, DatabaseError: { exitCode: 2, stack: false }, default: { exitCode: 3 }, }, }) ``` # Install ```bash npm install handle-cli-error ``` This package works in 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 ## handleCliError(error, options?) `error` `any`\ `options` [`Options?`](#options)\ _Return value_: `undefined` Logs `error` on the console (`stderr`) then exits the process. This never throws. Invalid errors are silently [normalized](https://github.com/ehmicky/normalize-exception). ### Options #### 🚨 exitCode _Type_: `integer`\ _Default_: `1` Process [exit code](https://en.wikipedia.org/wiki/Exit_status). We recommend values between 1 and 124 because the following exit codes have some special meaning: - 0: success - 125: invalid [`options`](#options) - 126 to 255: used by shells like Bash #### 📕 stack _Type_: `boolean`\ _Default_: `true` Whether to log the error's stack trace. #### 📢 props _Type_: `boolean`\ _Default_: `true` Whether to log the error's additional properties. #### 🔕 silent _Type_: `boolean`\ _Default_: `false` Exits the process without logging anything on the console. #### 🖍️ 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. #### 🚒 timeout _Type_: `integer` (in milliseconds)\ _Default_: `5000` (5 seconds) The process exits gracefully: it waits for any ongoing tasks (callbacks, promises, etc.) to complete, up to a specific `timeout`. Special values: - `0`: Exits right away, without waiting for ongoing tasks - `Number.POSITIVE_INFINITY`: Waits for ongoing tasks forever, without timing out #### 📜 log _Type_: `(string) => void`\ _Default_: `console.error` Function used to print the error message. #### 💣 classes _Type_: `object`\ _Default_: `{}` Specify [different options per error class](#error-class-specific). The object: - Keys are either the [`error.name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name), or `"default"` (used if no `error.name` matches) - Values are [options](#options) objects # Related projects - [`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-beautiful`](https://github.com/ehmicky/modern-errors-beautiful): Prettify errors messages and stacks - [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create one error class - [`error-class-utils`](https://github.com/ehmicky/error-class-utils): Utilities to properly create error classes - [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert errors to/from plain objects - [`normalize-exception`](https://github.com/ehmicky/normalize-exception): Normalize exceptions/errors - [`is-error-instance`](https://github.com/ehmicky/is-error-instance): Check if a value is an `Error` instance - [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an error with its `cause` - [`set-error-class`](https://github.com/ehmicky/set-error-class): Properly update an error's class - [`set-error-message`](https://github.com/ehmicky/set-error-message): Properly update an error's message - [`wrap-error-message`](https://github.com/ehmicky/wrap-error-message): Properly wrap an error's message - [`set-error-props`](https://github.com/ehmicky/set-error-props): Properly update an error's properties - [`set-error-stack`](https://github.com/ehmicky/set-error-stack): Properly update an error's stack - [`error-cause-polyfill`](https://github.com/ehmicky/error-cause-polyfill): Polyfill `error.cause` - [`beautiful-error`](https://github.com/ehmicky/beautiful-error): Prettify error messages and stacks - [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show some ❤ to Node.js process errors - [`error-http-response`](https://github.com/ehmicky/error-http-response): Create HTTP error responses - [`winston-error-format`](https://github.com/ehmicky/winston-error-format): Log errors with Winston # Credits The logo background was created by [dgim-studio](https://www.freepik.com/free-vector/comic-dynamic-elements-set_7997347.htm). # 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!