@fomantic/gulp-plumber
v1.2.2
Published
Prevent pipe breaking caused by errors from gulp plugins
Downloads
1,346
Keywords
Readme
:monkey: gulp-plumber
Forked Version using updated dependencies
Original repo at https://github.com/floatdrop/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 streamon('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'));