https://github.com/mkungla/gulp-help-menu

Help menu for Gulp
https://github.com/mkungla/gulp-help-menu

gulp gulp-plugin gulp-tasks gulpjs

Last synced: 29 days ago
JSON representation

Help menu for Gulp

• Host: GitHub
• URL: https://github.com/mkungla/gulp-help-menu
• Owner: mkungla
• License: mit
• Created: 2016-10-13T00:51:59.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-07-16T14:23:35.000Z (over 3 years ago)
• Last Synced: 2024-12-15T22:15:20.560Z (2 months ago)
• Topics: gulp, gulp-plugin, gulp-tasks, gulpjs
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 version][npm-v-image]][npm-v-url] [![Downloads][npm-downloads-image]][npm-downloads-url]

```

$ npm run help

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

  demo v1.0.0

  by Marko Kungla

  ISC license 

      Demo of gulp-help-menu

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

  List of Main Commands

    usage: gulp  [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`

```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);

```

[npm-v-image]: https://img.shields.io/npm/v/gulp-help-menu.svg

[npm-v-url]: https://npmjs.org/package/gulp-help-menu

[npm-downloads-image]: http://img.shields.io/npm/dt/gulp-help-menu.svg

[npm-downloads-url]: https://npmjs.org/package/gulp-help-menu