From 9f0d38dc0c7fcdee786bc9bd146f6d6d61180ca5 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Mon, 13 Feb 2017 14:50:41 +0700 Subject: [PATCH] Meta tweaks --- package.json | 5 +---- readme.md | 31 ++++++++++++++++--------------- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/package.json b/package.json index b9ffc66..297be82 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -45,8 +45,5 @@ "sinon": "^1.9.1", "strip-ansi": "^3.0.0", "xo": "*" - }, - "xo": { - "esnext": true } } diff --git a/readme.md b/readme.md index 8fb84df..5c3b980 100644 --- a/readme.md +++ b/readme.md @@ -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) + ## Install @@ -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`
+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`
Default: `true` By default only relative paths are shown. Turn off minimal mode to also show `cwd`, `base`, `path`. @@ -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`
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)