diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-08-14 05:01:11 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-08-14 05:02:09 +0200 |
commit | 363723fc84f7b8477592e0105aeb331ec9a017af (patch) | |
tree | 29f92724f34131bac64d6a318dd7e30612e631c7 /node_modules/gulp-debug/readme.md | |
parent | 5634e77ad96bfe1818f6b6ee70b7379652e5487f (diff) |
node_modules
Diffstat (limited to 'node_modules/gulp-debug/readme.md')
-rw-r--r-- | node_modules/gulp-debug/readme.md | 33 |
1 files changed, 20 insertions, 13 deletions
diff --git a/node_modules/gulp-debug/readme.md b/node_modules/gulp-debug/readme.md index ff1206367..5c3b98061 100644 --- a/node_modules/gulp-debug/readme.md +++ b/node_modules/gulp-debug/readme.md @@ -1,8 +1,8 @@ # 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 +> Debug [Vinyl](https://github.com/gulpjs/vinyl) file streams to see what files are run through your Gulp pipeline - +<img src="screenshot.png" width="415"> ## Install @@ -15,40 +15,47 @@ $ npm install --save-dev gulp-debug ## Usage ```js -var gulp = require('gulp'); -var debug = require('gulp-debug'); +const gulp = require('gulp'); +const debug = require('gulp-debug'); -gulp.task('default', function () { - return gulp.src('foo.js') +gulp.task('default', () => + gulp.src('foo.js') .pipe(debug({title: 'unicorn:'})) - .pipe(gulp.dest('dist')); -}); + .pipe(gulp.dest('dist')) +); ``` ## API -### debug(options) +### debug([options]) #### options ##### title -Type: `string` -Default: `'gulp-debug:'` +Type: `string`<br> +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` +Type: `boolean`<br> 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`. +##### showFiles + +Type: `boolean`<br> +Default: `true` + +Setting this to false will skip printing the file names and only show the file count. + ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT © [Sindre Sorhus](https://sindresorhus.com) |