-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Getting Started - Error Management #359
Comments
And additional "requirement" - errors, either from the stream or from the task should not have gulp-internals in the stack trace.This causes lots of confusion from users of the build. |
@ScottWeinstein this is fixed in the new task system via nextTick-ing stuff |
Thoughts on a command line flag for partial builds? |
@phated Why a CLI flag? |
partial builds are the edge case, as far as I can tell. This would switch series/parallel from using bach.series/parallel to settleSeries/settleParallel internally. |
👍 really. I cannot use gulp in my CI because I am afraid I am not catching all the errors, I would like to know a bullet proof approach for catching all the errors inside task or a composition of tasks with |
@phated Are there any docs anywhere for error management in bach/gulp 4? |
@contra https://github.com/phated/async-done#completion-and-error-resolution but it hasn't been thoroughly tested with gulp pipelines and all the errors that can happen there. Also, |
Hey @contra Another case i would like to see (it its makes sense) My use case: Thanks for all of the effort! |
@Bnaya You mean like the behavior using gulp-plumber? |
I'm working with gulp4 and i understand that plumber is not needed (?) This is what i want to achieve, without the need to explicitly check for file.eslint.errorCount gulp.src(changedFileRef.path)
.pipe(gulpEslint())
.pipe(gulpMap(function (file) {
if (file.eslint.errorCount === 0) {
return builder.build(toRelative(file.path));
} else {
return Promise.resolve();
}
}) And also if there a more elegant way to send the data to the builder.build without gulp-map. i couldn't find something else Thanks! |
gulp-plumber/stream-combiner not needed in gulp4? sounds strange.. indeed? |
I just came on to beg that Gulp 4 report errors by default, am I correct in interpreting this ticket as handling that? |
Updated the title here because it will belong under the "Getting Started" documentation and it'll be titled "Error Management" |
I've had some trouble finding examples of migrating error handling from Gulp 3 to 4. Not sure if I'm alone, but to me the developer experience of error handling is my greatest frustration with Gulp over the years. I've spent dozens of hours trying to make three things work across tasks:
Example frustration: I got stuck when the Gulp docs and a package creator suggested different things were the best practice: sindresorhus/gulp-imagemin#285 I'd really like to help people avoid the "oh, my whole routine works except in that one package" scenario. My attemptsI'm not a JS architect, but I'd like to share some code failures and successes to get the ball rolling. My testing workflow was:
Failed
function css (cb) {
var task = config.task.css;
gulp
.src(task.src, { sourcemaps: true })
.pipe(sass(task.sassOptions))
.pipe(autoprefixer(task.autoprefixerOptions))
.pipe(gulp.dest(task.dest, { sourcemaps: task.mapDest }))
.pipe(gulpif(!isSilent, notify(task.notifyOptions)));
cb();
}; Failed
function css () {
var task = config.task.css;
return pump([
gulp.src(task.src, { sourcemaps: true }),
sass(task.sassOptions),
autoprefixer(task.autoprefixerOptions),
gulp.dest(task.dest, { sourcemaps: task.mapDest }),
gulpif(!isSilent, notify(task.notifyOptions))
], errorHandler);
}; Works
function css (cb) {
var task = config.task.css;
pump([
gulp.src(task.src, { sourcemaps: true }),
sass(task.sassOptions),
autoprefixer(task.autoprefixerOptions),
gulp.dest(task.dest, { sourcemaps: task.mapDest }),
gulpif(!isSilent, notify(task.notifyOptions))
], errorHandler);
cb();
}; FailedThe same approach that worked for my CSS task failed my JS task. I'm not sure why.
function jsAppPost (cb) {
var task = config.task.jsAppPost;
pump([
gulp.src(task.src, { sourcemaps: true }),
uglify(task.uglifyOptions),
concat(task.file),
gulp.dest(task.dest, { sourcemaps: true }),
gulpif(!isSilent, notify(task.notifyOptions))
], errorHandler);
cb();
} My error handlerFor reference, here's my error handler: var beeper = require('beeper');
var color = require('ansi-colors');
var notify = require('gulp-notify');
module.exports = function (error) {
if (typeof error !== 'undefined') {
// [log] Uncomment to show the full error object
//console.log(error);
// ----------------------------------------------
// Normalize error responses
var report = ['\n'];
var notifyMessage = '';
if (error.plugin == 'gulp-eslint') {
report.push(color.red('Plugin: ') + error.plugin + '\n');
report.push(color.red('File: ') + error.fileName + '\n');
report.push(color.red('Line: ') + error.lineNumber + '\n');
report.push(color.red('Note: ') + error.message + '\n');
notifyMessage = 'JS linter found errors.';
}
if (error.plugin === 'gulp-sass') {
report.push(color.red('Plugin: ') + error.plugin + '\n');
report.push(color.red('File: ') + error.relativePath + '\n');
report.push(color.red('Line: ') + error.line + '\n');
report.push(color.red('Column: ') + error.column + '\n');
report.push(color.red('Note: ') + error.messageOriginal + '\n');
notifyMessage = error.relativePath + '\n' + error.line + ' : ' + error.column;
}
if (error.plugin == 'gulp-stylelint') {
notifyMessage = 'CSS linter found errors.';
}
if (error.plugin === 'gulp-uglify') {
report.push(color.red('Plugin: ') + error.plugin + '\n');
report.push(color.red('Path: ') + error.fileName + '\n');
report.push(color.red('File: ') + error.cause.filename + '\n');
report.push(color.red('Line: ') + error.cause.line + '\n');
report.push(color.red('Column: ') + error.cause.col + '\n');
report.push(color.red('Note: ') + error.cause.message + '\n');
notifyMessage = error.cause.filename + '\n' + error.cause.line + ' : ' + error.cause.col;
}
// ----------------------------------------------
// Show error in console
console.error(report.join(''));
// ----------------------------------------------
// Fire Mac/Windows notification for error
notify({
title: 'Failed Gulp — See Console',
message: notifyMessage,
sound: 'Sosumi' // Sound for Mac. See: https://github.com/mikaelbr/node-notifier#all-notification-options-with-their-defaults
}).write(error);
beeper(); // Fallback to system sound (for Windows).
}
}; Next stepsI'd like to help create the docs for error handling, and hope these examples get some feedback. I'm sure there's a working recipe and I just haven't found the right blog yet. |
Now that Node.js v8 has reached its EOL, every |
Is there any new known workaround for gulp 5 to prevent errors thrown during gulp watch from stopping the stream? |
Is the |
No difference, the problem doesnt actually affect gulp 4. I would guess its the same issue as in #2812. Its a little concerning that error handling has been a problem for a decade. |
We need a huge section for this since it is by far our hugest problem for new users.
Here are cases we need to make sure we cover:
The text was updated successfully, but these errors were encountered: