gulp-plumber

:monkey: gulp-plumber

Prevent pipe breaking caused by errors from gulp plugins

This :monkey:-patch plugin is fixing issue with Node Streams piping. For explanations, read this small article.

Briefly it replaces pipe method and removes standard onerror handler on error event, which unpipes streams on error by default.

Usage :monkey:

First, install gulp-plumber as a development dependency:

npm install --save-dev gulp-plumber

Then, add it to your gulpfile.js:

var plumber = require('gulp-plumber');
var coffee = require('gulp-coffee');

gulp.src('./src/*.ext')
	.pipe(plumber())
	.pipe(coffee())
	.pipe(gulp.dest('./dist'));

API :monkey:

:monkey: plumber([options])

Returns Stream, that fixes pipe methods on Streams that are next in pipeline.

options

Type: Object / Function Default: {}

Sets options described below from its properties. If type is Function it will be set as errorHandler.

options.inherit

Type: Boolean Default: true

Monkeypatch pipe functions in underlying streams in pipeline.

options.errorHandler

Type: Boolean / Function
Default: true

Handle errors in underlying streams and output them to console.

• function - it will be attached to stream on('error').
• false - error handler will not be attached.
• true - default error handler will be attached.

plumber.stop()

This method will return default behaviour for pipeline after it was piped.

var plumber = require('gulp-plumber');

gulp.src('./src/*.scss')
    .pipe(plumber())
    .pipe(sass())
    .pipe(uglify())
    .pipe(plumber.stop())
    .pipe(gulp.dest('./dist'));

License :monkey:

MIT License

Similar packages

Other packages similar to gulp-plumber

gulp-notify

gulp-notify is a Gulp plugin that sends messages to the notification center on your operating system. It can be used to display notifications for various events, including errors. Unlike gulp-plumber, gulp-notify focuses on providing notifications rather than preventing pipe breaking.

gulp-util

gulp-util is a collection of utility functions for Gulp plugins, including error handling. It provides a way to log errors and other messages. However, gulp-util has been deprecated, and its functionalities have been split into smaller, more focused packages. It does not prevent pipe breaking like gulp-plumber.

gulp-if

gulp-if is a Gulp plugin that conditionally pipes files through a function. It can be used to handle errors conditionally, but it does not provide the same level of error handling and prevention as gulp-plumber. It is more focused on conditional task execution.