plugin-error

plugin-error

Error handling for Vinyl plugins.

Usage

var PluginError = require('plugin-error');

var err = new PluginError('test', {
  message: 'something broke'
});

var err = new PluginError({
  plugin: 'test',
  message: 'something broke'
});

var err = new PluginError('test', 'something broke');

var err = new PluginError('test', 'something broke', { showStack: true });

var existingError = new Error('OMG');
var err = new PluginError('test', existingError, { showStack: true });

API

new PluginError(pluginName, message[, options])

Error constructor that takes:

• pluginName - a String that should be the module name of your plugin
• message - a String message or an existing Error object
• options - an Object of your options

Behavior:

• By default the stack will not be shown. Set options.showStack to true if you think the stack is important for your error.
• If you pass an error object as the message the stack will be pulled from that, otherwise one will be created.
• If you pass in a custom stack string you need to include the message along with that.
• Error properties will be included in err.toString(), but may be omitted by including { showProperties: false } in the options.

License

MIT

Similar packages

Other packages similar to plugin-error

fancy-log

The fancy-log package is used for logging messages in a more readable format. While it doesn't specifically handle errors, it can be used alongside plugin-error to log error messages in a more user-friendly way.

gulplog

The gulplog package is a logging utility specifically designed for Gulp. It provides a way to log messages at different levels (info, warn, error). While it doesn't create error objects like plugin-error, it can be used to log errors created by plugin-error.

chalk

The chalk package is used for styling terminal string output. It can be used in conjunction with plugin-error to colorize error messages, making them easier to read and debug.