gulp-help-menu v2.0.1

gulp-help-menu

Help menu for Gulp, Drop in cleaner replacement for task descriptions and flags
for gulp --task (-T). It gets help menu banner info from your package.json.

$ npm run help

|==============================================================|
  demo v1.0.0
  by Marko Kungla
  ISC license 

      Demo of gulp-help-menu

|==============================================================|
  List of Main Commands
    usage: gulp <task> [options]

  your-task                        This is gulp-help-menu example
       -d --dummy-flag             Thats one dummy flag
  another-task                     This is gulp-help-menu example
       -a --another-dummy-flag     Thats one dummy flag

|==============================================================|

Install

$ npm install --save gulp-help-menu

Usage

package.json

"scripts": {
  "help": "gulp -S help"
},

gulpfile.js

// Example gulpfile.js
const gulp = require("gulp");

// Add it to your gulpfile.js
const gulp_help_menu = require("gulp-help-menu");

// Set description [flags] for your tasks
const yourTask = async () => {};
yourTask.description = "This is gulp-help-menu example";
yourTask.flags = {
  "-d --dummy-flag": "Thats one dummy flag"
};
gulp.task("your-task", yourTask);

const anotherTask = async () => {};
anotherTask.description = "This is gulp-help-menu example";
anotherTask.flags = {
  "-a --another-dummy-flag": "Thats one dummy flag"
};
gulp.task("another-task", anotherTask);

// At the end of your gulpfile.js
gulp_help_menu.register(gulp);