gulp-plumber's Introduction

🐒 gulp-plumber

Prevent pipe breaking caused by errors from gulp plugins

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

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

Usage 🐒

First, install gulp-plumber as a development dependency:

npm install --save-dev gulp-plumber

Then, add it to you 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 🐒

🐒 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 set 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 passed - it will be attached to stream on('error').
false passed - error handler will not be attached.
undefined - 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'));