Debug Vinyl file streams to see what files are run through your Gulp pipeline (evacuated from NSA/Microsoft Github)

Sindre Sorhus 12f594c932 4.0.0 6 years ago
.editorconfig 26226ca61e Meta tweaks 6 years ago
.gitattributes 27a20c5a1a [breaking] ES2015ify and require Node.js 4 7 years ago
.gitignore 26226ca61e Meta tweaks 6 years ago
.npmrc 26226ca61e Meta tweaks 6 years ago
.travis.yml c679c5d342 Require Node.js 6 and Gulp 4 6 years ago
gulpfile.js 26226ca61e Meta tweaks 6 years ago
index.js c679c5d342 Require Node.js 6 and Gulp 4 6 years ago
license 26226ca61e Meta tweaks 6 years ago
package.json 12f594c932 4.0.0 6 years ago
readme.md f00098e1b9 Add `showCount` option (#39) 6 years ago
screenshot.png 7d97766f9e update screenshot 9 years ago
test.js f00098e1b9 Add `showCount` option (#39) 6 years ago

readme.md

gulp-debug Build Status

Debug Vinyl file streams to see what files are run through your Gulp pipeline

Install

$ npm install --save-dev gulp-debug

Usage

const gulp = require('gulp');
const debug = require('gulp-debug');

gulp.task('default', () =>
	gulp.src('foo.js')
		.pipe(debug({title: 'unicorn:'}))
		.pipe(gulp.dest('dist'))
);

API

debug([options])

options

Type: Object

title

Type: string
Default: gulp-debug:

Give it a custom title so it's possible to distinguish the output of multiple instances logging at once.

minimal

Type: boolean
Default: true

By default only relative paths are shown. Turn off minimal mode to also show cwd, base, path.

The stat property will be shown when you run gulp in verbose mode: gulp --verbose.

showFiles

Type: boolean
Default: true

Print filenames.

showCount

Type: boolean
Default: true

Print the file count.

logger(message)

Type: Function
Default: fancy-log

Provide your own logging utility in place of fancy-log. The message is passed as a string in the first argument. Note that ANSI colors may be used in the message.

License

MIT © Sindre Sorhus