Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Feb 13, 2017
1 parent 8fbfa9d commit 9f0d38d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 19 deletions.
5 changes: 1 addition & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gulp-debug",
"version": "3.0.0",
"description": "Debug vinyl file streams to see what files are run through your gulp pipeline",
"description": "Debug Vinyl file streams to see what files are run through your Gulp pipeline",
"license": "MIT",
"repository": "sindresorhus/gulp-debug",
"author": {
Expand Down Expand Up @@ -45,8 +45,5 @@
"sinon": "^1.9.1",
"strip-ansi": "^3.0.0",
"xo": "*"
},
"xo": {
"esnext": true
}
}
31 changes: 16 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# gulp-debug [![Build Status](https://travis-ci.org/sindresorhus/gulp-debug.svg?branch=master)](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
![](screenshot.png)
<img src="screenshot.png" width="415">


## Install
Expand All @@ -15,33 +15,33 @@ $ 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`.
Expand All @@ -50,11 +50,12 @@ The [`stat` property](http://nodejs.org/api/fs.html#fs_class_fs_stats) will be s

##### showFiles

Type: `boolean`
Type: `boolean`<br>
Default: `true`

Setting this to false will skip printing the file names and only show file counts.
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)

0 comments on commit 9f0d38d

Please sign in to comment.