Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More β†’
Socket
Sign inDemoInstall
Socket

handle-cli-error

Package Overview
Dependencies
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

handle-cli-error

πŸ’£ Error handler for CLI applications πŸ’₯

  • 5.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
7.6K
increased by92.18%
Maintainers
1
Weekly downloads
Β 
Created
Source
handle-cli-error logo

Node TypeScript Codecov Mastodon Medium

Error handler for CLI applications.

Hire me

Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.

Features

Screenshot

handle-cli-error screenshot

Example

General

#!/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

handleCliError(error, {
  classes: {
    InputError: { exitCode: 1, stack: false },
    DatabaseError: { exitCode: 2, stack: false },
    default: { exitCode: 3 },
  },
})

Install

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

API

handleCliError(error, options?)

error any
options Options?
Return value: undefined

Logs error on the console (stderr) then exits the process.

This never throws. Invalid errors are silently normalized.

Options

🚨 exitCode

Type: integer
Default: 1

Process exit code.

Note: when passing invalid options, the exit code is always 125.

πŸ“• 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. 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.

πŸš’ 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
πŸ’£ classes

Type: object
Default: {}

Specify different options per error class. The object:

  • Keys are either the error.name, or "default" (used if no error.name matches)
  • Values are options objects

Credits

The logo background was created by dgim-studio.

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!

Keywords

FAQs

Package last updated on 28 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚑️ by Socket Inc