@oclif/errors

What is @oclif/errors?

The @oclif/errors npm package is designed to handle errors within the oclif (Open CLI Framework) ecosystem. It provides a structured way to create and manage errors in command-line applications built with oclif. The package allows developers to define custom error types, handle errors gracefully, and display user-friendly error messages.

What are @oclif/errors's main functionalities?

CLIError

CLIError is a custom error type provided by @oclif/errors for general command-line interface errors. It can be used to throw errors with a message that will be displayed to the user.

const { CLIError } = require('@oclif/errors');

throw new CLIError('Something went wrong!');

ExitError

ExitError is a custom error type that can be used to exit the process with a specific exit code. This is useful for signaling to the shell or parent process that the command failed with a particular error state.

const { ExitError } = require('@oclif/errors');

throw new ExitError(1);

handle

The handle function is used to catch and handle errors gracefully within an oclif application. It can be used to intercept uncaught exceptions and display a user-friendly message or perform cleanup before exiting.

const { handle } = require('@oclif/errors');

process.on('uncaughtException', error => {
  handle(error);
});

Other packages similar to @oclif/errors

yargs

Yargs is a powerful npm package that helps you build interactive command line tools, by parsing arguments and generating an elegant user interface. It comes with built-in error handling and can be used as an alternative to @oclif/errors for managing command-line arguments and errors.

commander

Commander is another npm package for building command-line applications. It provides error handling capabilities similar to @oclif/errors, but it is more focused on parsing command-line options and subcommands rather than providing a structured error handling system.

chalk

Chalk is a popular npm package for styling terminal text. While it does not provide structured error handling like @oclif/errors, it can be used in conjunction with other error handling packages to display colorful and styled error messages in the terminal.

README

@oclif/errors

This library has been replaced by @oclif/core and is now in maintenance mode. We will only consider PRs that address security concerns.

display friendly CLI errors and log to error log