简介
gulp-help 是一个npm包，可以为Gulp任务自动生成帮助信息。它能够让你的团队更加高效地使用 Gulp 工具，并且减少查看文档或者询问其他开发人员的时间。
安装
npm install --save-dev gulp-help
用法
在你的 gulpfile.js 文件中引入 gulp 和 gulp-help：
const gulp = require('gulp');
const help = require('gulp-help')(gulp);然后定义你的任务：
gulp.task('default', 'This is the default task.', function() {
// ...
});
gulp.task('build', 'Build your project for production.', function() {
// ...
});当你运行 gulp --tasks 命令时，会输出以下信息：
[15:34:40] Tasks for /Users/me/project/gulpfile.js [15:34:40] ├── default This is the default task. [15:34:40] └── build Build your project for production.
你还可以添加更多的信息，比如说任务的参数和返回值。在任务定义的第二个参数中添加描述即可：
gulp.task('serve', 'Serve your project for development. Options:\n--port {number} The server port. Default is 3000.', function() {
// ...
});当你运行 gulp help serve 命令时，会输出以下信息：
[15:34:40] Task: serve
[15:34:40] Description:
Serve your project for development. Options:
--port {number} The server port. Default is 3000.示例代码
这是一个使用 gulp-help 的完整示例：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ---- - --------------------------- -------------------- ----- -- --- ------- ------- ---------- - -- --- --- ------------------ ------ ---- ------- --- ------------- ---------- - -- --- --- ------------------ ------ ---- ------- --- ------------ ---------------- -------- --- ------ ----- ------- -- ------- ---------- - -- --- ---
总结
使用 gulp-help 可以使你的 Gulp 任务更加容易使用和维护。它可以让你的团队成员快速了解项目中的任务，并且减少查看文档或者询问其他开发人员的时间。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/51908