search

gulpjs / plugin-error

Error handling for vinyl plugins. Just an abstraction of what's in gulp-util with minor reformatting.
MIT License
19 stars 13 forks source link

Improve documentation/Readme #9

Open phated opened 6 years ago

phated commented 6 years ago

As per https://github.com/gulpjs/plugin-error/issues/8#issuecomment-358121678

I think that a better solution could be to update the readme to explain why you should use plugin-error: "Error handling for Vinyl plugins." is a bit vague. For example:

  • Use this plugin so your plugin is formatted the same way as the others (consistency of the formatted message)
  • Use this plugin so consumers of your plugin can easily catch errors and filter them by plugin name (handle the errors programmatically)
  • Both

I think other things can be improved but nothing comes to mind immediately. This thread can be a grabbag for improvement suggestions.