gulp-debug

Debug vinyl file streams to see what files are run through your gulp pipeline

Example output (Mac):

[16:03:04] inject.js:44 bower_components/font-awesome/fonts/fontawesome-webfont.eot
[16:03:04] inject.js:44 bower_components/font-awesome/fonts/fontawesome-webfont.woff2
[16:03:04] inject.js:44 bower_components/font-awesome/fonts/fontawesome-webfont.woff
[16:03:04] inject.js:44 bower_components/font-awesome/fonts/fontawesome-webfont.ttf
[16:03:04] inject.js:44 bower_components/font-awesome/fonts/fontawesome-webfont.svg
[16:03:04] inject.js:44 5 items
[16:03:40] Custom Message
cwd:         ~/myproject/client
process.cwd: ~/myproject/client
relative:    styles/app.css
base:        src
path:        src/styles/app.css

[16:03:40] Custom Message
cwd:         ~/myproject/client
process.cwd: ~/myproject/client
relative:    styles/vendor.css
base:        src
path:        src/styles/vendor.css

[16:03:40] Custom Message 2 items

Example output (Windows):

[16:34:20] inject.js:43 src\app\index.run.js
[16:34:20] inject.js:43 src\app\index.route.js
[16:34:20] inject.js:43 src\app\index.config.js
[16:34:20] inject.js:43 3 items
[16:34:20] Custom Message
cwd:         C:\myproject
process.cwd: C:\myproject
relative:    src\app\common\services\picture.service.js
base:        .
path:        C:\myproject\src\app\common\services\picture.service.js

[16:34:20] Custom Message
cwd:         C:\myproject
process.cwd: C:\myproject
relative:    bower_components\restangular\dist\restangular.js
base:        .
path:        C:\myproject\bower_components\restangular\dist\restangular.js
[16:34:20] Custom Message 2 items

Install

$ npm install --save-dev gulp-debug-streams

Usage

var gulp = require('gulp');
var debug = require('gulp-debug-streams');
 
gulp.task('default', function() {
    return gulp.src('foo.js')
        .pipe(debug())
        .pipe(gulp.dest('dist'));
});

API

.pipe(debug())

If you invoke debug() without any options, it will default to displaying 1 line per file that passes though. The line will have a default title and the file's file.relative property will be displayed. The default title is the filename and line number where debug() was called.

.pipe(debug('Custom title'))

If you provide a string, it will be used as the title for the messages.

.pipe(debug.verbose(optionalTitle))

By default only file.relative for each file is shown. Enabling verbose mode adds process.cwd, file.cwd, file.base, and file.path to the output.

If you provide a string, it will be used as the title for the messages.

CLI

If you invoke gulp with the --verbose option (i.e. gulp --verbose), it will make verbose output display by default. Note: You can still override verbose on each call to debug().

License

MIT