{"_id":"gulp-help-four","_rev":"8-b8086a2a88a47693d091886afb6f6875","name":"gulp-help-four","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","dist-tags":{"latest":"0.2.3"},"versions":{"0.1.0":{"name":"gulp-help-four","version":"0.1.0","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","main":"index.js","scripts":{"test":"mocha -R spec"},"repository":{"type":"git","url":"https://github.com/adviceinteractivegroup/gulp-help-four.git"},"keywords":["gulp","help","tasks","list","gulpfriendly"],"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","devDependencies":{"gulp":"git://github.com/gulpjs/gulp#4.0","mocha":"^2.1.0","unit.js":"^1.1.3"},"dependencies":{"chalk":"^1.0.0","cli-table":"^0.3.1"},"gitHead":"12e01bec52d59b702c92facb67fe27b6d8c50288","_id":"gulp-help-four@0.1.0","_shasum":"209f1e2fa9b2f95b57a99c8fb91bc0c501db14ce","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"thotjs","email":"jfugett@thotjs.io"},"maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}],"dist":{"shasum":"209f1e2fa9b2f95b57a99c8fb91bc0c501db14ce","tarball":"https://registry.npmjs.org/gulp-help-four/-/gulp-help-four-0.1.0.tgz","integrity":"sha512-qzspo0Ziv1/2/dsYHIoMU+2TMFNPtN50GNQx/wMzuH0eBlIR7PktIE2vrKNLgN4dHRpcVW5Ukql9OpIsKiPX7Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG5wkjuEqxWbHtE5ntk3unlQZcMLgyqZfZGFlXh24GH9AiEAg/QcFkGSUyDg9PMvOMSv6GdSAVroYLHF0WaH63F+jdo="}]}},"0.2.0":{"name":"gulp-help-four","version":"0.2.0","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","main":"index.js","scripts":{"test":"mocha -R spec"},"repository":{"type":"git","url":"git+https://github.com/adviceinteractivegroup/gulp-help-four.git"},"keywords":["gulp","help","tasks","list","gulpfriendly"],"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","devDependencies":{"gulp":"git://github.com/gulpjs/gulp.git#4.0","mocha":"^2.1.0","unit.js":"^1.1.3"},"dependencies":{"chalk":"^1.0.0","cli-table":"^0.3.1"},"gitHead":"8d04fc70de778c83452aeff45e330a6e9f4afc36","_id":"gulp-help-four@0.2.0","_shasum":"0ab4cb734c5c04acc1decad0cb62cbf58114ca08","_from":".","_npmVersion":"2.11.1","_nodeVersion":"2.3.0","_npmUser":{"name":"thotjs","email":"jfugett@thotjs.io"},"dist":{"shasum":"0ab4cb734c5c04acc1decad0cb62cbf58114ca08","tarball":"https://registry.npmjs.org/gulp-help-four/-/gulp-help-four-0.2.0.tgz","integrity":"sha512-oldWTSjmwC/4havKkEiG0kbvdunYCsGR86FpWQtvkWiiMrKfIKEtnk+X1C7j6IdLqVwNy5SIOiK76eg9vxZYNA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIASXvuMFiqnRUAk85qvRIturlIsr6QvS+PsA1HPig2eDAiADTuC/qi0KU/N+MpKyZWQPGt3bEl+akmR42IA+bvWboQ=="}]},"maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}]},"0.2.1":{"name":"gulp-help-four","version":"0.2.1","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","main":"index.js","scripts":{"test":"mocha -R spec"},"repository":{"type":"git","url":"git+https://github.com/adviceinteractivegroup/gulp-help-four.git"},"keywords":["gulp","help","tasks","list","gulpfriendly"],"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","devDependencies":{"gulp":"git://github.com/gulpjs/gulp.git#4.0","mocha":"^2.1.0","unit.js":"^1.1.3"},"dependencies":{"chalk":"^1.0.0","cli-table":"^0.3.1"},"gitHead":"c58ff872f8436eab9d8a765719f6ffa0ccf46ea5","_id":"gulp-help-four@0.2.1","_shasum":"02e08707b8591e40a2e1c4ffef58f5260c7e2fd0","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.5.0","_npmUser":{"name":"thotjs","email":"jfugett@thotjs.io"},"dist":{"shasum":"02e08707b8591e40a2e1c4ffef58f5260c7e2fd0","tarball":"https://registry.npmjs.org/gulp-help-four/-/gulp-help-four-0.2.1.tgz","integrity":"sha512-bX+fF78rFqaAiKRS7qESQUUcJ/6MlvwpTdRAekp182DsifqG0APpww6qAqU1znBLN8oXKSzblt5FEx8KI7lN7g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGMOzaNett4sJhqjlmXSzq1fKbvmNhn6n+N6BPk4MnHtAiAKTSUKvaoZQ//S3z7FAHVLjkEoXl74HzF+xEWzY6u/6Q=="}]},"maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/gulp-help-four-0.2.1.tgz_1475663478588_0.287373713683337"}},"0.2.2":{"name":"gulp-help-four","version":"0.2.2","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","main":"index.js","scripts":{"test":"mocha -R spec"},"repository":{"type":"git","url":"git+https://github.com/adviceinteractivegroup/gulp-help-four.git"},"keywords":["gulp","help","tasks","list","gulpfriendly"],"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","devDependencies":{"gulp":"git://github.com/gulpjs/gulp.git#4.0","mocha":"^2.1.0","unit.js":"^1.1.3"},"dependencies":{"chalk":"^1.0.0","cli-table":"^0.3.1"},"gitHead":"49ffd595902f9e76daeb38ad3a40c35c1bde4918","_id":"gulp-help-four@0.2.2","_shasum":"cd26546ccc8342bd83c36f58e38e2d7466288c6b","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.5.0","_npmUser":{"name":"thotjs","email":"jfugett@thotjs.io"},"dist":{"shasum":"cd26546ccc8342bd83c36f58e38e2d7466288c6b","tarball":"https://registry.npmjs.org/gulp-help-four/-/gulp-help-four-0.2.2.tgz","integrity":"sha512-ZjdD6Xi9kRv3EkwPCQHjZIx8eDakGQdHTari20djwSLoZnzwhweBCciM6pPmCi8bgnrCMvS48jG6gtk4I6Zezg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICuYPZyeVONBuP7sCJKpPceu81ysDdBJ5JaRi6kFrZ+oAiB6TglZ0/46iVwjzyAwTMCLB/IVRwdo46fMk1IcVT8NQQ=="}]},"maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/gulp-help-four-0.2.2.tgz_1475664870684_0.06431149016134441"}},"0.2.3":{"name":"gulp-help-four","version":"0.2.3","description":"Temporary gulp help module for gulp 4.0 while task descriptions are still pending","main":"index.js","scripts":{"test":"mocha -R spec"},"repository":{"type":"git","url":"git+https://github.com/adviceinteractivegroup/gulp-help-four.git"},"keywords":["gulp","help","tasks","list","gulpfriendly"],"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","devDependencies":{"gulp":"git://github.com/gulpjs/gulp.git#4.0","mocha":"^2.1.0","unit.js":"^1.1.3"},"dependencies":{"chalk":"^1.0.0","cli-table":"^0.3.1"},"gitHead":"f32ea204b1b49150b7f32b35cf9707564ca1b78a","_id":"gulp-help-four@0.2.3","_shasum":"a3bd5e2de8afbd00a6b71e298cef143d2b5497aa","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.5.0","_npmUser":{"name":"thotjs","email":"jfugett@thotjs.io"},"dist":{"shasum":"a3bd5e2de8afbd00a6b71e298cef143d2b5497aa","tarball":"https://registry.npmjs.org/gulp-help-four/-/gulp-help-four-0.2.3.tgz","integrity":"sha512-ggcPV4BIN3MRgsMbdlDLvr6BCAObUBrPezQidT7uDpoOkOJWbiQKJmfQoHoSMWPCcT3jo24wjzViywSdmqZeQQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDUpdFJwyOWU13UQu9HTkUzGJnr1HwKMhDf1LeyyiznogIhAOFs5colKWwCoC+EcxK4ccd4mg3Cd9vDrach4t2AyMxy"}]},"maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/gulp-help-four-0.2.3.tgz_1475665045025_0.3016367598902434"}}},"readme":"# gulp-help-four\n> Temporary gulp help module for gulp 4.0 while task descriptions and 4.0 are still pending\n> Adds a default help task to gulp and provides the ability to add custom help messages to your gulp tasks\n\nThis is basically a quick rewrite of gulp-help to support the unreleased gulp 4.0 branch\n\nDifferences:\n* Order of arguments are different\n* Works with the new gulp 4.0 task api\n* Aliases are treated as completely separate tasks due to the quick rewrite\n* help options are slightly modified\n* Added hideEmpty option to hide empty descriptions or show them\n\nWhile I updated the docs and created unit tests for this it is possible I missed something,\nI did put this together pretty quickly.\nI'll be glad to look into any bugs or answer any questions but I suspect that once 4.0 is\nofficially released gulp-help will be updated to work with the new task format.\n\nCode cleanup is also welcome :)\n\n## Install\n\n```bash\n$ npm install --save-dev gulp-help-four\n```\n\n## Usage\n\nBefore defining any tasks, add `gulp-help-four` to your gulp instance\n\n```js\n// gulpfile.js\nvar gulp = require('gulp');\nvar help = require('gulp-help-four');\nhelp(gulp, opts);\n```\n\nAvailable options are:\n* description - The default description for the help message\n* hideEmpty - Boolean whether to hide tasks with empty descriptions\n* aliases - Array of aliases for the help command\n* cb - Function to call after the help output has been rendered \n\nNext, define help text for each custom task\n\n```js\n// gulpfile.js\ngulp.task('lint', 'Lints all server side js', function () {\n    gulp.src('./lib/**/*.js')\n      .pipe(jshint());\n});\n```\n\nNow show that help via `gulp help`\n\n```bash\n$ gulp help\n[gulp] Running 'help'...\n\nUsage: gulp [task]\n\nAvailable tasks\n  help Display this help text.\n  lint Lints all server side js\n\n[gulp] Finished 'help' in 607 μs\n```\n\n## New task API\n\n### gulp.task(name[, help, aliases, opts], fn)\n\n#### name\n\nType: `string`\n\n#### help\n\nType: `string | boolean`\n\nCustom help message as a string.\nIf you want to hide the task from the help menu, supply `false`.\n\n```js\ngulp.task('task-hidden-from-help', false, function () {\n  // ...\n});\n```\n\n#### fn\n\nType: `function`\n\nThe task function\nIf this is an anonymous function you must include a name\n\n#### aliases\n\nType: `Array`\n\nList of aliases for this task.\n\n\n```js\ngulp.task('version', 'prints the version.', ['v', 'V'], function() {\n  // ...\n});\n```\n\nwhich results in\n\n```bash\n[gulp] Starting 'help'...\n\nUsage\n  gulp [task]\n\nAvailable tasks\n  help     Display this help text.\n  version  prints the version.\n  v        prints the version.\n  V        prints the version.\n\n[gulp] Finished 'help' after 928 μs\n```\n\n## Options\n\nYou can optionally pass options to your targets by supplying an options object, e.g.\n\n```js\ngulp.task('version', 'prints the version.', {\n  'env=prod': 'description of env, perhaps with available values',\n  'key=val': 'description of key & val',\n  'key': 'description of key'\n}, function () {\n  // ...\n});\n```\nwhich results in\n\n```bash\n[gulp] Starting 'help'...\n\nUsage\n  gulp [task]\n\nAvailable tasks\n  help          Display this help text.\n  version       prints the version.\n    --env=prod  description of env, perhaps with available values\n    --key=val   description of key & val\n    --key       description of key\n\n[gulp] Finished 'help' after 928 μs\n```\n\n## Override default help message\n\n```js\nrequire('gulp-help')(gulp, { description: 'you are looking at it.', aliases: ['h', '?'] });\n```\n\nThen, calling\n\n```shell\n$ gulp      #or\n$ gulp help #or\n$ gulp h    #or\n$ gulp ?\n```\n\nwill now result in\n\n```\n[gulp] Starting 'help'...\n\nUsage:\n  gulp [task]\n\nAvailable tasks:\n  help     you are looking at it.\n  h        you are looking at it.\n  ?        you are looking at it.\n\n[gulp] Finished 'help' after 1.05 ms\n```\n\n## Post-help callback\n\nYou can define a function to run after the default help task runs.\n\n```js\nrequire('gulp-help')(gulp, {\n  cb: function(done) {\n    var tasks = gulp.registry().tasks();\n    console.log(tasks);\n    done();\n  }\n});\n```\n\n## License\n\n[MIT](http://opensource.org/licenses/MIT)\n","maintainers":[{"name":"thotjs","email":"jfugett@thotjs.io"}],"time":{"modified":"2022-06-18T17:11:28.747Z","created":"2015-03-04T21:57:22.063Z","0.1.0":"2015-03-04T21:57:22.063Z","0.2.0":"2015-07-14T21:32:41.344Z","0.2.1":"2016-10-05T10:31:21.407Z","0.2.2":"2016-10-05T10:54:33.601Z","0.2.3":"2016-10-05T10:57:27.775Z"},"homepage":"https://github.com/adviceinteractivegroup/gulp-help-four","keywords":["gulp","help","tasks","list","gulpfriendly"],"repository":{"type":"git","url":"git+https://github.com/adviceinteractivegroup/gulp-help-four.git"},"author":{"name":"Joshwa Fugett","email":"jfugett27@gmail.com"},"bugs":{"url":"https://github.com/adviceinteractivegroup/gulp-help-four/issues"},"license":"MIT","readmeFilename":"README.md"}