floatdrop/gulp-plumber


Fixing Node pipes

License: MIT

Language: JavaScript


🐒 gulp-plumber

NPM version Build Status Dependency Status

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 standard 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 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 🐒

🐒 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 🐒

MIT License

Project Statistics

Sourcerank 19
Repository Size 66.4 KB
Stars 803
Forks 28
Watchers 11
Open issues 16
Dependencies 13
Contributors 12
Tags 29
Created
Last updated
Last pushed

Top Contributors See all

Vsevolod Strukchinsky Shinnosuke Watanabe Luke Horvat Patrick Walters Sahat Yalkabov Gilad Peleg Dusty Greif Caley Davis kmoe Hyeon Kim Charles Samborski Callum Locke

Packages Referencing this Repo

gulp-plumber
Prevent pipe breaking caused by errors from gulp plugins
Latest release 1.2.1 - Updated - 803 stars
gulp-plumber-tmp
Prevent pipe breaking caused by errors from gulp plugins
Latest release 1.2.0 - Published - 803 stars
org.webjars.npm:gulp-plumber
WebJar for gulp-plumber
Latest release 1.2.0 - Updated - 803 stars

Recent Tags See all

v1.2.1 November 27, 2018
v1.2.0 January 06, 2018
v1.1.0 February 09, 2016
v1.0.2 February 09, 2016
v1.0.1 February 09, 2016
v1.0.0 March 09, 2015
v0.6.6 October 02, 2014
v0.6.5 August 25, 2014
v0.6.4 July 20, 2014
v0.6.3 June 12, 2014
v0.6.2 May 22, 2014
v0.6.1 April 12, 2014
v0.6.0 April 10, 2014
v0.5.6 January 11, 2014
v0.5.5 January 11, 2014

Something wrong with this page? Make a suggestion

Last synced: 2018-11-27 17:12:09 UTC

Login to resync this repository