gulp-plumber
Advanced tools
Package description
gulp-plumber is a plugin for Gulp that prevents pipe breaking caused by errors from gulp plugins. It allows you to handle errors gracefully and continue with the build process without stopping the entire task.
Error Handling
This feature allows you to handle errors in your Gulp tasks without breaking the stream. The code sample demonstrates how to use gulp-plumber to catch errors in a Gulp task that minifies JavaScript files using gulp-uglify.
const gulp = require('gulp');
const plumber = require('gulp-plumber');
const uglify = require('gulp-uglify');
gulp.task('scripts', function() {
return gulp.src('src/js/*.js')
.pipe(plumber())
.pipe(uglify())
.pipe(gulp.dest('dist/js'));
});Custom Error Handler
This feature allows you to define a custom error handler. The code sample shows how to use gulp-plumber with gulp-notify to display a notification when an error occurs in a Gulp task that processes CSS files.
const gulp = require('gulp');
const plumber = require('gulp-plumber');
const notify = require('gulp-notify');
gulp.task('styles', function() {
return gulp.src('src/css/*.css')
.pipe(plumber({
errorHandler: notify.onError('Error: <%= error.message %>')
}))
.pipe(gulp.dest('dist/css'));
});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 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 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.
Readme
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.
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'));
Returns Stream, that fixes pipe methods on Streams that are next in pipeline.
Type: Object / Function
Default: {}
Sets options described below from its properties. If type is Function it will be set as errorHandler.
Type: Boolean
Default: true
Monkeypatch pipe functions in underlying streams in pipeline.
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.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'));
FAQs
Prevent pipe breaking caused by errors from gulp plugins
The npm package gulp-plumber receives a total of 139,188 weekly downloads. As such, gulp-plumber popularity was classified as popular.
We found that gulp-plumber demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.