diff options
Diffstat (limited to 'node_modules/gulp-debug/readme.md')
| -rw-r--r-- | node_modules/gulp-debug/readme.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/node_modules/gulp-debug/readme.md b/node_modules/gulp-debug/readme.md new file mode 100644 index 000000000..ff1206367 --- /dev/null +++ b/node_modules/gulp-debug/readme.md @@ -0,0 +1,54 @@ +# gulp-debug [](https://travis-ci.org/sindresorhus/gulp-debug) + +> Debug [vinyl](https://github.com/wearefractal/vinyl) file streams to see what files are run through your gulp pipeline + + + + +## Install + +``` +$ npm install --save-dev gulp-debug +``` + + +## Usage + +```js +var gulp = require('gulp'); +var debug = require('gulp-debug'); + +gulp.task('default', function () { + return gulp.src('foo.js') + .pipe(debug({title: 'unicorn:'})) + .pipe(gulp.dest('dist')); +}); +``` + + +## API + +### debug(options) + +#### options + +##### 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](http://nodejs.org/api/fs.html#fs_class_fs_stats) will be shown when you run gulp in verbose mode: `gulp --verbose`. + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |