https://github.com/potch/gulp-helptext
https://github.com/potch/gulp-helptext
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/potch/gulp-helptext
- Owner: potch
- Created: 2014-06-06T22:15:09.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-06-06T22:55:07.000Z (about 12 years ago)
- Last Synced: 2025-04-30T06:07:46.696Z (about 1 year ago)
- Language: JavaScript
- Size: 165 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gulp-helptext
Generates pretty help text for your gulpfile.
## Usage
Supply an optional `description` object to specify pretty descriptions for tasks. Tasks will automatically print out their names and dependent tasks.
```js
var helptext = require('gulp-helptext');
gulp.task('help', helptext({
'default': 'Shows the help message',
'help': 'This help message',
'styles': 'Compiles stylus',
'lint': 'Runs JSHint on your code',
'server': 'Start the development server'
}));
```
Output looks like the following:
```
Registered tasks:
lint - Runs JSHint on your code
styles - Compiles stylus
build - Runs lint, styles
connect
watch
server - Start the development server
Runs build, connect, watch
bump
help - This help message
deploy
default - Shows the help message
Runs help
```