'end' never triggered if more than 16 objects about gulp-jscs

[sindresorhus]

It was recently fixed in gulp. Please reinstall gulp globally and locally.

[syamanaka]

I'm running gulp 3.8.5

[rikschennink]

Now at 3.8.5, still not working, also updated node.

Commenting out / removing the this.push(file) statements fixes the issue, but as I'm not familiar with it's function I'm probably breaking something else.

[jgrund]

I ran into this issue as well. The problem occurs when gulp-jscs is the last item in a stream, i.e. there is nothing to pipe to after that.

It hits the high water mark of 16 and just waits there.

Putting something, e.x. gulp-debug after gulp-jscs fixes the issue, although it obviously not an ideal fix.

[dstroot]

Gahhh! I have been banging my head against the wall for days trying to figure this out - I think that somehow gulp-jscs ver 0.5.0 does not exhibit the behavior but 0.6.0 does. Need to test this out at home tonight.

[dstroot]

OK - Using the latest gulp v3.8.6 and v0.6.0 of gulp-jscs I can verify that > 16 files still stops and never returns. This is definitely not fixed.

❯ gulp -v
[16:49:56] CLI version 3.8.6
[16:49:56] Local version 3.8.6

❯ node -v
v0.10.29

[dstroot]

Test repo: https://github.com/dstroot/gulp-jscsTest

Environment:

gulp-jscsTest git/master  
❯ gulp -v
[17:42:22] CLI version 3.8.6
[17:42:22] Local version 3.8.6

gulp-jscsTest git/master  
❯ node -v
v0.10.29

Baseline:

If I have 16 or fewer files my gulpfile works great and gulp-jscs works and reports errors. In addition gulp.watch works and shows errors as I create them and removes the errors as I clean up the code. You can see this by opening any file and adding a comment with no space between the slashes and the comment:

//test, instead of
// test

If you fix it jscs is re-run and the error goes away. It looks like this:

gulp-jscsTest git/master  
❯ gulp
[17:29:27] Using gulpfile ~/Code/gulp-jscsTest/gulpfile.js
[17:29:27] Starting 'jscs'...
[17:29:27] Starting 'watch'...
[17:29:27] Finished 'watch' after 12 ms
[17:29:27] Finished 'jscs' after 325 ms
[17:29:27] Starting 'default'...
[17:29:27] Finished 'default' after 6.87 μs
[17:29:44] Starting 'jscs'...
[17:29:44] 'jscs' errored after 101 ms
[17:29:44] Error in plugin 'gulp-jscs'
Missing space after line comment at 01.js :
    13 |var passportConf  = require('../config/passport');
    14 |
    15 |//test
--------^
    16 |
    17 |/**
[17:29:52] Starting 'jscs'...
[17:29:52] Finished 'jscs' after 83 ms
^C% 

Greater than 16 files:

To test this copy file 17.js from files-staging to files. Run gulp - see that the jscs task never completes. We already know this is a problem… looks like this:

❯ gulp   
[17:44:16] Using gulpfile ~/Code/gulp-jscsTest/gulpfile.js
[17:44:16] Starting 'jscs'...
[17:44:16] Starting 'watch'...
[17:44:16] Finished 'watch' after 12 ms

Adding something to the stream after jscs:

‘jgrund’ commented that "Putting something, e.x. gulp-debug after gulp-jscs fixes the issue, although it obviously not an ideal fix.” This does indeed allow the task to complete. BUT jscs is not doing anything anymore - it is not reporting errors anymore! We can introduce the same error as we did above and we will see that it is not being picked up. So this is not a solution!

EDIT: if you don't use my "monkey business" to trap the errors then jscs will return the messages but it will crash gulp... which kind of defeats the purpose of my watch task.

HELP!

Background:

rvagg/through2#18

[syamanaka]

@dstroot I ended up doing this: .pipe(j).pipe(term()) where term looks like

return through2.obj(function(file, encoding, callback) {
  callback();
});

See through2.term rvagg/through2#9

[dstroot]

@syamanaka - thanks! Not sure I fully understand but I'll look at your code. ;)

[dstroot]

OK - Got it working due to @syamanaka's hint.

Why this is cool: jscs checks code style - it's not a linter. From my view a style checker should not blow up gulp, stopping my workflow. It should simply give me warning messages and keep on going so I can keep on coding...

Check it out:

'use strict';

var gulp = require('gulp');
var $ = require('gulp-load-plugins')();
var terminus = require("terminus");

/**
 * JSCS Task
 */

gulp.task('jscs', function () {
  // Monkey business to handle jscs errors without
  // stopping gulp, allowing gulp.watch to work
  // *and* with more than 16 files.  ;)
  var j = $.jscs();
  j.on('error', function (e) {
    $.util.log(e.message);
    j.end();
  });
  return gulp.src('files/*.js')
    .pipe(j)
    .pipe(terminus.devnull({ objectMode: true }));
});

/**
 * Default Task
 */

gulp.task('default', ['jscs'], function () {
  gulp.watch('files/*.js', ['jscs']);
});

[dstroot]

Cleaner:

gulp.task('jscs', function () {
  return gulp.src(paths.lint)               // Read .js files
    .pipe($.jscs())                         // jscs .js files
    .on('error', function (e) {
      $.util.log(e.message);
      $.jscs().end();
    })
    .pipe(terminus.devnull({ objectMode: true }));
});

[marcoslhc]

@dstroot In my environment, stoping on style errors is enforced. I think @sindresorhus is working (and wanting help) in a fail reporter a là gulp-jshint that makes the halting optional (#21).
the @syamanaka's solution worked like a charm thanks!.