gulp-help

Adds a default help task to gulp and provides the ability to add custom help messages to your gulp tasks

NOTE: this version only works with gulp 4. For gulp-help that works with prior versions of gulp, use npm v1.6.1.

Install

$ npm install --save-dev chmontgomery/gulp-help#gulp4

Usage

Before defining any tasks, add gulp help to your gulp instance

// gulpfile.js
var gulp = require('gulp-help')(require('gulp'));

Next, define help text for each custom task

// gulpfile.js
function clean(done) {
  //...
  done();
}
clean.description = 'clean all the files';

function coffee(done) {
  //...
  done();
}
coffee.description = 'Compile coffeescript';

var build = gulp.series(clean, coffee);
build.description = 'this builds all the things';

gulp.task('build', build);

gulp.task('clean', clean);

gulp.task(coffee);

Now show that help via gulp help

gulpHelp(gulpInstance[, options])

gulp-help is completely customizable. See here for overridable options.

Pre-built themes

Check out the themes folder for all available, pre-built themes.

License

MIT © Chris Montgomery