Error Plugin

The Error Plugin provides intelligent error handling for CLI applications built with Wizard. It automatically detects command not found errors and suggests similar commands using fuzzy matching, making your CLI more user-friendly.

Installation


npm install @hyperse/wizard-plugin-error


pnpm add @hyperse/wizard-plugin-error


yarn add @hyperse/wizard-plugin-error


bun add @hyperse/wizard-plugin-error

Quick Start


// @filename: @hyperse/wizard-plugin-error/dist/index.d.ts
import {  } from '@hyperse/wizard';
import {  } from '@hyperse/wizard-plugin-error';
 
const  = ({
  : 'my-cli',
  : 'My CLI application',
  : '1.0.0',
});
 
.(()).();

API Reference

Parameters:

Name	Type	Default
`options`	`ErrorPluginOptions` The options for the plugin.

Returns:

Plugin<object, object, FlagsWithBuiltin, FlagsWithBuiltin>

ErrorPluginOptions

Name	Type	Default
`exitProcess`	`boolean` Whether to exit the process when an error occurs.	`true`