gulp-task-doc
Description
Print gulp task list by reading task comments. Output example:
$ gulp help[11:25:58] Using gulpfile /www/gulp-task-doc/gulpfile.js[11:25:58] Starting 'help'...Usage: gulp [task] [task2] ... Tasks: help Display this help bump Bump the version --type=pre will bump the prerelease version *.*.*-x --type=patch or no flag will bump the patch version *.*.x --type=minor will bump the minor version *.x.* --type=major will bump the major version x.*.* --version=1.2.3 will bump to a specific version and ignore other flags jscs Check code style jshint Analise code quality test Run tests[11:25:59] Finished 'help' after 15 ms
Features
- Support a separation of gulpfile into multiple files
- @internal jsdoc-like tag to hide a task from help
- @verbose jsdoc-like tag to show a task only with a --verbose argument
- Help output can be customized
Installation
Install with npm:
npm install --save-dev gulp-task-doc
Usage
var gulp = ; // Instead of require('gulp');var jscs = ; // @internalgulp; /** * Display this help */gulp; /** * Check code style * @verbose */gulp; /** * Bump the version * --type=pre will bump the prerelease version *.*.*-x * --type=patch or no flag will bump the patch version *.*.x * --type=minor will bump the minor version *.x.* * --type=major will bump the major version x.*.* * --version=1.2.3 will bump to a specific version and ignore other flags */gulp;
Alternative initialization
If you want to use gulp instead of gulp-task-doc to define tasks you can use a patchGulp method that uses monkey-patching to override a gulp.task method:
var gulp = ;var doc = ; // Display this helpgulp;
Options
;
License
Licensed under MIT.