{"_id":"yargs-get-help","_rev":"42-5e3d1d686966d853510d96fbba14a762","name":"yargs-get-help","description":"Get the help output from a yargs instance","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"yargs-get-help","description":"Get the help output from a yargs instance","version":"1.0.0","keywords":["yargs","get","help","usage"],"author":{"name":"André Cruz","email":"andre@moxy.studio"},"homepage":"https://github.com/moxystudio/yargs-get-help","repository":{"type":"git","url":"git+ssh://git@github.com/moxystudio/yargs-get-help.git"},"license":"MIT","scripts":{"lint":"eslint .","test":"jest --env node --coverage","posttest":"npm run lint","precommit":"lint-staged","prerelease":"npm t","release":"standard-version"},"standard-version":{"scripts":{"posttag":"git push --follow-tags origin master && npm publish"}},"lint-staged":{"*.js":"eslint"},"devDependencies":{"babel-plugin-transform-runtime":"^6.23.0","babel-preset-es2015":"^6.22.0","eslint":"^4.3.0","eslint-config-moxy":"^3.0.0","husky":"^0.14.3","jest":"^21.2.1","lint-staged":"^4.0.2","standard-version":"^4.2.0","yargs":"^10.0.3"},"gitHead":"333c716cfc7a76153fc1a22282a446e03b1795c5","bugs":{"url":"https://github.com/moxystudio/yargs-get-help/issues"},"_id":"yargs-get-help@1.0.0","_npmVersion":"5.5.1","_nodeVersion":"8.4.0","_npmUser":{"name":"satazor","email":"andremiguelcruz@msn.com"},"dist":{"integrity":"sha512-nE/ElabftfETUq+HBcmN1W2kAh7UF5nAl6BlVY0HcQPCxbTNqDlrH4zaBC+ncyrjJxu2arumAF5d3Wli6BKt0w==","shasum":"a851420e54684ee16ccdc28a68a0dffabf65b71c","tarball":"https://registry.npmjs.org/yargs-get-help/-/yargs-get-help-1.0.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE2lQPilSgNKdlkg9tTot9p76SBoZdu/yeDcXKILUCsVAiAcgJZyanzbQ/fdBZUaMcFRqWgpLxP8OIKGylNkah6bLA=="}]},"maintainers":[{"name":"satazor","email":"andremiguelcruz@msn.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/yargs-get-help-1.0.0.tgz_1508860827083_0.6360360325779766"},"directories":{}},"1.1.0":{"name":"yargs-get-help","description":"Get the help output from a yargs instance","version":"1.1.0","keywords":["yargs","get","help","usage"],"author":{"name":"André Cruz","email":"andre@moxy.studio"},"homepage":"https://github.com/moxystudio/yargs-get-help","repository":{"type":"git","url":"git+ssh://git@github.com/moxystudio/yargs-get-help.git"},"license":"MIT","scripts":{"lint":"eslint .","test":"jest --env node --coverage","posttest":"npm run lint","precommit":"lint-staged","prerelease":"npm t","release":"standard-version"},"standard-version":{"scripts":{"posttag":"git push --follow-tags origin master && npm publish"}},"lint-staged":{"*.js":"eslint"},"devDependencies":{"eslint":"^4.3.0","eslint-config-moxy":"^3.0.0","husky":"^0.14.3","jest":"^21.2.1","lint-staged":"^4.0.2","standard-version":"^4.2.0","yargs":"^10.0.3"},"dependencies":{"strip-ansi":"^4.0.0"},"gitHead":"fda87bf3cf4a7905f15a117e1ce61c2b0dfc0f2c","bugs":{"url":"https://github.com/moxystudio/yargs-get-help/issues"},"_id":"yargs-get-help@1.1.0","_npmVersion":"5.5.1","_nodeVersion":"8.4.0","_npmUser":{"name":"satazor","email":"andremiguelcruz@msn.com"},"dist":{"integrity":"sha512-I1DtOUIXCBv115UVUE46N74O9apuN5dia0Wrj/Mq8md+NLUm8dLxcFR2Wc7q2OX3A9XLUV2ebGZgDlrhdwFsQA==","shasum":"035aff4aa6fad0df5b4b7168c9f034e7e22fa1d8","tarball":"https://registry.npmjs.org/yargs-get-help/-/yargs-get-help-1.1.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHJYyFxVLtejOOGCOc/awqk56F6EUD8RJ1rJe06GH1ZnAiB8g3vWCvhNgSk1TssGPnC1B6ym3NLg5u8ewvM45hMXew=="}]},"maintainers":[{"name":"satazor","email":"andremiguelcruz@msn.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/yargs-get-help-1.1.0.tgz_1508897381276_0.9816928338259459"},"directories":{}},"1.1.1":{"name":"yargs-get-help","description":"Get the help output from a yargs instance","version":"1.1.1","keywords":["yargs","get","help","usage","jest","snapshot"],"author":{"name":"André Cruz","email":"andre@moxy.studio"},"homepage":"https://github.com/moxystudio/yargs-get-help","repository":{"type":"git","url":"git+ssh://git@github.com/moxystudio/yargs-get-help.git"},"license":"MIT","main":"index.js","files":[],"scripts":{"lint":"eslint .","test":"jest --env node --coverage","prerelease":"npm t && npm run lint","release":"standard-version","precommit":"lint-staged","commitmsg":"commitlint -e $GIT_PARAMS"},"standard-version":{"scripts":{"posttag":"git push --follow-tags origin master && npm publish"}},"lint-staged":{"*.js":["eslint --fix","git add"]},"commitlint":{"extends":["@commitlint/config-angular"]},"devDependencies":{"@commitlint/cli":"^5.0.1","@commitlint/config-angular":"^4.3.0","eslint":"^4.3.0","eslint-config-moxy":"^4.1.0","husky":"^0.14.3","jest":"^21.2.1","lint-staged":"^6.0.0","standard-version":"^4.2.0","yargs":"^10.0.3"},"dependencies":{"strip-ansi":"^4.0.0"},"gitHead":"3995b7d2da4380b9206c910ca1f6f0dae94c5191","bugs":{"url":"https://github.com/moxystudio/yargs-get-help/issues"},"_id":"yargs-get-help@1.1.1","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"satazor","email":"andremiguelcruz@msn.com"},"dist":{"integrity":"sha512-0arhl/hhKupNWFlnU8qqwikznxVF0LlGg30lvRMI/NDak2IxAkrfIxCxdLfuQajh9zXRtAT/o33PUvwHFb/0Zg==","shasum":"008d996dc914cbbb5a4f5f86baf443e9ad936fd1","tarball":"https://registry.npmjs.org/yargs-get-help/-/yargs-get-help-1.1.1.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEBVxxkCkRT4CoXmZBLcc4pMP6V9l5FQ1dtUAyR8ETpcAiBCxz+6769za6dRe16rDErI/39nhjWsRZnLwPlso++KkA=="}]},"maintainers":[{"email":"andreclima.pt@gmail.com","name":"acostalima"},{"email":"ivolimasilva@outlook.com","name":"ivolimasilva"},{"email":"paulobmarcos@outlook.com","name":"paulobmarcos"},{"email":"ruimpmonteiro12345@gmail.com","name":"ruimonteiro"},{"email":"fsdiogo@gmail.com","name":"fsdiogo"},{"email":"nelsonfonseca.18@gmail.com","name":"nlfonseca"},{"email":"andre.neves@moxy.studio","name":"andreneves"},{"email":"jonnybel91@gmail.com","name":"jonnybel"},{"email":"rui.neves@moxy.studio","name":"ruipneves"},{"email":"andregoncalves20007@gmail.com","name":"andregoncalvesdev"},{"email":"antonio.c.capelo@gmail.com","name":"capelo"},{"email":"santos.vasco10@gmail.com","name":"vascosantos"},{"email":"marcooliveira@me.com","name":"marcooliveira"},{"email":"andremiguelcruz@msn.com","name":"satazor"},{"email":"filipediasferreira@me.com","name":"filipediasf"},{"email":"hello@moxy.studio","name":"moxyhq"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/yargs-get-help-1.1.1.tgz_1513212276501_0.31377390725538135"},"directories":{}}},"readme":"# yargs-get-help\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]\n\n[npm-url]:https://npmjs.org/package/yargs-get-help\n[npm-image]:http://img.shields.io/npm/v/yargs-get-help.svg\n[downloads-image]:http://img.shields.io/npm/dm/yargs-get-help.svg\n[travis-url]:https://travis-ci.org/moxystudio/yargs-get-help\n[travis-image]:http://img.shields.io/travis/moxystudio/yargs-get-help/master.svg\n[codecov-url]:https://codecov.io/gh/moxystudio/yargs-get-help\n[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/yargs-get-help/master.svg\n[david-dm-url]:https://david-dm.org/moxystudio/yargs-get-help\n[david-dm-image]:https://img.shields.io/david/moxystudio/yargs-get-help.svg\n[david-dm-dev-url]:https://david-dm.org/moxystudio/yargs-get-help?type=dev\n[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/yargs-get-help.svg\n[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/yargs-get-help.svg\n[greenkeeper-url]:https://greenkeeper.io\n\nGet the help output from a yargs instance.\n\nThis module is very handy when you are developing tests for a project that has a CLI,\nspecially when used in conjunction with snapshot testing.\n\n\n## Installation\n\n`$ npm install yargs-get-help`\n\n\n## Usage\n\n### getHelp(yargs, [options])\n\n```js\nimport yargs from 'yargs';\nimport getHelp from 'yargs-get-help';\n\nyargs\n.option('include', { type: 'boolean', describe: 'This is the include option' });\n\nconst help = getHelp(yargs);\n// `help` will contain yargs `$0 --help` output as a string\n```\n\n### getHelp(yargs, [args], [options])\n\n```js\nimport yargs from 'yargs';\nimport getHelp from 'yargs-get-help';\n\nyargs\n.command('serve', 'Start the server', (yargs) => {\n    yargs\n    .option('port', {\n        describe: 'The port to bind on',\n        default: 5000,\n    });\n}, (argv) => {\n    serve(argv.port);\n})\n.command('build', 'Builds the project', (yargs) => {\n    yargs\n    .option('public-path', {\n        describe: 'The webpack public-path',\n        default: '/',\n    });\n}, (argv) => {\n    build(argv.publicPath);\n});\n\nconst help = getHelp(yargs, ['serve']);\n// `help` will contain yargs `$0 serve --help` output as a string\n```\n\nAvailable options:\n\n- `normalize`: Normalizes the output, unifying things like terminal sizes, locale, $0 and ansi-codes (defaults to `true`)\n\n\n**NOTE:** This package mutates the passed `yargs` instance. If this is a problem, please consider using [yargs/yargs](https://github.com/moxystudio/yargs-get-help/blob/7d797ca29c49e6ffd27c496356657e19a8973069/test/index.spec.js#L3) instead.\n\n\n## Tests\n\n`$ npm test`   \n`$ npm test -- --watch` during development\n\n\n## License\n\n[MIT License](http://opensource.org/licenses/MIT)\n","maintainers":[{"email":"tiagoddinis@gmail.com","name":"tiagodinis"},{"email":"hello@moxy.studio","name":"moxyhq"},{"email":"filipediasferreira@me.com","name":"filipediasf"},{"email":"andremiguelcruz@msn.com","name":"satazor"},{"email":"marcooliveira@me.com","name":"marcooliveira"},{"email":"andreclima.pt@gmail.com","name":"acostalima"},{"email":"andregoncalves20007@gmail.com","name":"andregoncalvesdev"}],"time":{"modified":"2022-05-25T04:08:18.622Z","created":"2017-10-24T16:00:28.007Z","1.0.0":"2017-10-24T16:00:28.007Z","1.1.0":"2017-10-25T02:09:42.239Z","1.1.1":"2017-12-14T00:44:36.564Z"},"homepage":"https://github.com/moxystudio/yargs-get-help","keywords":["yargs","get","help","usage","jest","snapshot"],"repository":{"type":"git","url":"git+ssh://git@github.com/moxystudio/yargs-get-help.git"},"author":{"name":"André Cruz","email":"andre@moxy.studio"},"bugs":{"url":"https://github.com/moxystudio/yargs-get-help/issues"},"license":"MIT","readmeFilename":"README.md"}