{"_id":"@webpack-contrib/cli-utils","_rev":"402308","name":"@webpack-contrib/cli-utils","description":"A suite of utilities for webpack projects which expose a CLI","dist-tags":{"latest":"1.0.2"},"maintainers":[{"name":"d3viant0ne","email":"wiens.joshua@gmail.com"},{"name":"evilebottnawi","email":"sheo13666q@gmail.com"},{"name":"jhnns","email":"mail@johannesewald.de"},{"name":"sokra","email":""}],"time":{"modified":"2021-08-04T04:35:05.000Z","created":"2018-06-20T19:37:28.941Z","1.0.2":"2018-07-09T23:51:37.434Z","1.0.1":"2018-06-21T14:06:39.568Z","1.0.0":"2018-06-20T19:37:28.941Z"},"users":{},"author":{"name":"Andrew Powell","email":"andrew@shellscape.org"},"repository":{"type":"git","url":"git+https://github.com/webpack-contrib/cli-utils.git"},"versions":{"1.0.2":{"name":"@webpack-contrib/cli-utils","version":"1.0.2","publishConfig":{"access":"public"},"description":"A suite of utilities for webpack projects which expose a CLI","license":"MIT","repository":{"type":"git","url":"git+https://github.com/webpack-contrib/cli-utils.git"},"author":{"name":"Andrew Powell","email":"andrew@shellscape.org"},"homepage":"https://github.com/webpack-contrib/cli-utils","bugs":{"url":"https://github.com/webpack-contrib/cli-utils/issues"},"bin":"","main":"lib/index.js","engines":{"node":">= 6.9.0 <7.0.0 || >= 8.9.0"},"scripts":{"commitlint":"commitlint","commitmsg":"commitlint -e $GIT_PARAMS","lint":"eslint --cache lib test","ci:lint:commits":"commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}","lint-staged":"lint-staged","release":"standard-version","release:ci":"conventional-github-releaser -p angular","release:validate":"commitlint --from=$(git describe --tags --abbrev=0) --to=$(git rev-parse HEAD)","security":"nsp check","test":"jest","test:watch":"jest --watch","test:coverage":"jest --collectCoverageFrom='lib/**/*.js' --coverage","ci:lint":"npm run lint && npm run security","ci:test":"npm run test -- --runInBand","ci:coverage":"npm run test:coverage -- --runInBand","defaults":"webpack-defaults"},"files":["dist/","lib/","index.js"],"peerDependencies":{"webpack":"^4.3.0"},"dependencies":{"@webpack-contrib/schema-utils":"^1.0.0-beta.0","camelize":"^1.0.0","chalk":"^2.4.1","decamelize":"^2.0.0","loader-utils":"^1.1.0","meant":"^1.0.1","strip-ansi":"^4.0.0","text-table":"^0.2.0","webpack-log":"^1.2.0"},"devDependencies":{"@commitlint/cli":"^7.0.0","@commitlint/config-conventional":"^7.0.1","@webpack-contrib/defaults":"^2.4.0","@webpack-contrib/eslint-config-webpack":"^2.0.4","babel-cli":"^6.26.0","babel-jest":"^23.0.1","babel-plugin-transform-object-rest-spread":"^6.26.0","babel-polyfill":"^6.26.0","babel-preset-env":"^1.7.0","conventional-github-releaser":"^3.1.1","cross-env":"^5.1.6","del":"^3.0.0","del-cli":"^1.1.0","eslint":"^4.19.1","eslint-plugin-import":"^2.12.0","eslint-plugin-prettier":"^2.6.0","husky":"^0.14.3","jest":"^23.1.0","lint-staged":"^7.1.3","memory-fs":"^0.4.1","nsp":"^3.2.1","pre-commit":"^1.2.2","prettier":"^1.13.4","standard-version":"^4.4.0","webpack":"^4.11.1"},"keywords":["webpack"],"jest":{"testEnvironment":"node"},"pre-commit":"lint-staged","lint-staged":{"*.js":["eslint --fix","git add"]},"gitHead":"46e24b619cdc30c7bb6ada5e9dbc9a565b6fa65a","_id":"@webpack-contrib/cli-utils@1.0.2","_npmVersion":"5.6.0","_nodeVersion":"10.1.0","_npmUser":{"name":"shellscape","email":"andrew@shellscape.org"},"dist":{"shasum":"9618b68a79f5b3462224e0ecca416cc812b65054","size":5090,"noattachment":false,"key":"/@webpack-contrib/cli-utils/-/@webpack-contrib/cli-utils-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/@webpack-contrib/cli-utils/download/@webpack-contrib/cli-utils-1.0.2.tgz"},"maintainers":[{"name":"d3viant0ne","email":"wiens.joshua@gmail.com"},{"name":"evilebottnawi","email":"sheo13666q@gmail.com"},{"name":"jhnns","email":"mail@johannesewald.de"},{"name":"sokra","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-utils_1.0.2_1531180297350_0.3784878432399006"},"_hasShrinkwrap":false,"publish_time":1531180297434,"_cnpm_publish_time":1531180297434},"1.0.1":{"name":"@webpack-contrib/cli-utils","version":"1.0.1","publishConfig":{"access":"public"},"description":"A suite of utilities for webpack projects which expose a CLI","license":"MIT","repository":{"type":"git","url":"git+https://github.com/webpack-contrib/cli-utils.git"},"author":{"name":"Andrew Powell","email":"andrew@shellscape.org"},"homepage":"https://github.com/webpack-contrib/cli-utils","bugs":{"url":"https://github.com/webpack-contrib/cli-utils/issues"},"bin":"","main":"lib/index.js","engines":{"node":">= 6.9.0 <7.0.0 || >= 8.9.0"},"scripts":{"commitlint":"commitlint","commitmsg":"commitlint -e $GIT_PARAMS","lint":"eslint --cache lib test","ci:lint:commits":"commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}","lint-staged":"lint-staged","release":"standard-version","release:ci":"conventional-github-releaser -p angular","release:validate":"commitlint --from=$(git describe --tags --abbrev=0) --to=$(git rev-parse HEAD)","security":"nsp check","test":"jest","test:watch":"jest --watch","test:coverage":"jest --collectCoverageFrom='lib/**/*.js' --coverage","ci:lint":"npm run lint && npm run security","ci:test":"npm run test -- --runInBand","ci:coverage":"npm run test:coverage -- --runInBand","defaults":"webpack-defaults"},"files":["dist/","lib/","index.js"],"peerDependencies":{"webpack":"^4.3.0"},"dependencies":{"@webpack-contrib/schema-utils":"^1.0.0-beta.0","camelize":"^1.0.0","chalk":"^2.4.1","decamelize":"^2.0.0","loader-utils":"^1.1.0","meant":"^1.0.1","strip-ansi":"^4.0.0","text-table":"^0.2.0","webpack-log":"^1.2.0"},"devDependencies":{"@commitlint/cli":"^7.0.0","@commitlint/config-conventional":"^7.0.1","@webpack-contrib/defaults":"^2.4.0","@webpack-contrib/eslint-config-webpack":"^2.0.4","babel-cli":"^6.26.0","babel-jest":"^23.0.1","babel-plugin-transform-object-rest-spread":"^6.26.0","babel-polyfill":"^6.26.0","babel-preset-env":"^1.7.0","conventional-github-releaser":"^3.1.1","cross-env":"^5.1.6","del":"^3.0.0","del-cli":"^1.1.0","eslint":"^4.19.1","eslint-plugin-import":"^2.12.0","eslint-plugin-prettier":"^2.6.0","husky":"^0.14.3","jest":"^23.1.0","lint-staged":"^7.1.3","memory-fs":"^0.4.1","nsp":"^3.2.1","pre-commit":"^1.2.2","prettier":"^1.13.4","standard-version":"^4.4.0","webpack":"^4.11.1"},"keywords":["webpack"],"jest":{"testEnvironment":"node"},"pre-commit":"lint-staged","lint-staged":{"*.js":["eslint --fix","git add"]},"gitHead":"76cc5c6e20ad7dc816d357df9a66c7e0d98cd318","_id":"@webpack-contrib/cli-utils@1.0.1","_npmVersion":"5.6.0","_nodeVersion":"10.1.0","_npmUser":{"name":"shellscape","email":"andrew@shellscape.org"},"dist":{"shasum":"c51ac91194be72d777e5a087fa0d584eb3f08f06","size":5035,"noattachment":false,"key":"/@webpack-contrib/cli-utils/-/@webpack-contrib/cli-utils-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@webpack-contrib/cli-utils/download/@webpack-contrib/cli-utils-1.0.1.tgz"},"maintainers":[{"name":"d3viant0ne","email":"wiens.joshua@gmail.com"},{"name":"evilebottnawi","email":"sheo13666q@gmail.com"},{"name":"jhnns","email":"mail@johannesewald.de"},{"name":"sokra","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-utils_1.0.1_1529589999512_0.667273279533471"},"_hasShrinkwrap":false,"publish_time":1529589999568,"_cnpm_publish_time":1529589999568},"1.0.0":{"name":"@webpack-contrib/cli-utils","version":"1.0.0","publishConfig":{"access":"public"},"description":"A suite of utilities for webpack projects which expose a CLI","license":"MIT","repository":{"type":"git","url":"git+https://github.com/webpack-contrib/cli-utils.git"},"author":{"name":"Andrew Powell","email":"andrew@shellscape.org"},"homepage":"https://github.com/webpack-contrib/cli-utils","bugs":{"url":"https://github.com/webpack-contrib/cli-utils/issues"},"bin":"","main":"lib/index.js","engines":{"node":">= 6.9.0 <7.0.0 || >= 8.9.0"},"scripts":{"commitlint":"commitlint","commitmsg":"commitlint -e $GIT_PARAMS","lint":"eslint --cache lib test","ci:lint:commits":"commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}","lint-staged":"lint-staged","release":"standard-version","release:ci":"conventional-github-releaser -p angular","release:validate":"commitlint --from=$(git describe --tags --abbrev=0) --to=$(git rev-parse HEAD)","security":"nsp check","test":"jest","test:watch":"jest --watch","test:coverage":"jest --collectCoverageFrom='lib/**/*.js' --coverage","ci:lint":"npm run lint && npm run security","ci:test":"npm run test -- --runInBand","ci:coverage":"npm run test:coverage -- --runInBand","defaults":"webpack-defaults"},"files":["dist/","lib/","index.js"],"peerDependencies":{"webpack":"^4.3.0"},"dependencies":{"@webpack-contrib/schema-utils":"^1.0.0-beta.0","camelize":"^1.0.0","chalk":"^2.4.1","decamelize":"^2.0.0","loader-utils":"^1.1.0","meant":"^1.0.1","strip-ansi":"^4.0.0","text-table":"^0.2.0","webpack-log":"^1.2.0"},"devDependencies":{"@commitlint/cli":"^7.0.0","@commitlint/config-conventional":"^7.0.1","@webpack-contrib/defaults":"^2.4.0","@webpack-contrib/eslint-config-webpack":"^2.0.4","babel-cli":"^6.26.0","babel-jest":"^23.0.1","babel-plugin-transform-object-rest-spread":"^6.26.0","babel-polyfill":"^6.26.0","babel-preset-env":"^1.7.0","conventional-github-releaser":"^3.1.1","cross-env":"^5.1.6","del":"^3.0.0","del-cli":"^1.1.0","eslint":"^4.19.1","eslint-plugin-import":"^2.12.0","eslint-plugin-prettier":"^2.6.0","husky":"^0.14.3","jest":"^23.1.0","lint-staged":"^7.1.3","memory-fs":"^0.4.1","nsp":"^3.2.1","pre-commit":"^1.2.2","prettier":"^1.13.4","standard-version":"^4.4.0","webpack":"^4.11.1"},"keywords":["webpack"],"jest":{"testEnvironment":"node"},"pre-commit":"lint-staged","lint-staged":{"*.js":["eslint --fix","git add"]},"gitHead":"afb85aa2f77f6578cd0c7790b794ff7360ad3b7b","_id":"@webpack-contrib/cli-utils@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"10.1.0","_npmUser":{"name":"shellscape","email":"andrew@shellscape.org"},"dist":{"shasum":"6284ede9ca9557d1bc38b881f038399eb5522afd","size":5006,"noattachment":false,"key":"/@webpack-contrib/cli-utils/-/@webpack-contrib/cli-utils-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/@webpack-contrib/cli-utils/download/@webpack-contrib/cli-utils-1.0.0.tgz"},"maintainers":[{"name":"d3viant0ne","email":"wiens.joshua@gmail.com"},{"name":"evilebottnawi","email":"sheo13666q@gmail.com"},{"name":"jhnns","email":"mail@johannesewald.de"},{"name":"sokra","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-utils_1.0.0_1529523448877_0.763706297542269"},"_hasShrinkwrap":false,"publish_time":1529523448941,"_cnpm_publish_time":1529523448941}},"readme":"
\n \n \n \n
\n\n[![npm][npm]][npm-url]\n[![node][node]][node-url]\n[![deps][deps]][deps-url]\n[![tests][tests]][tests-url]\n[![chat][chat]][chat-url]\n[![size][size]][size-url]\n\n# cli-utils\n\nA suite of utilities for webpack projects which expose a CLI. The aim of this\nmodule is to provide a uniform experience for displaying CLI help (`--help`),\nparsing options for CLI flags, flag recommendations - or \"did you mean\", and\nvalidation of flags.\n\n## Requirements\n\nThis module requires a minimum of Node v6.9.0 and Webpack v4.0.0.\n\n## Getting Started\n\nTo begin, you'll need to install `cli-utils`:\n\n```console\n$ npm install @webpack-contrib/cli-utils --save\n```\n\n## Flags Schema\n\nThe exported functions of this module assume that flags are stored in a JSON\nschema compatible with [`meow`](https://github.com/sindresorhus/meow). The\nschema should follow the format of:\n\n```js\n{\n key: { object description }\n}\n```\n\nWhere `key` represents a flag, including any hyphens, but excluding the leading\nhyphen(s). And `object description` matches the following format:\n\n```js\n{\n \"alias\": ,\n \"deprecated\": ,\n \"desc\": ,\n \"type\": of [array, boolean, object, string]\n}\n```\n\nFor which all keys are optional, but a `desc` should be provided at a minimum.\n\nThe `alias` property contains a flag which can be used as an alias to the parent\nkey/flag. \nThe `deprecated` property indicates that a flag has been deprecated and requires\nspecial notation. \nThe `desc` property should contain a reasonable description of the flag. This\ncan include newline characters which will be considered when rendering help. \nThe `type` property specifies the type of value that the flag should contain.\nIf this property is omitted, any type is considered valid. If more than one type\nis possible, specify an array of the valid types. eg. `[\"boolean\", \"string\"]`.\n\n## API\n\nThis module exports three functions: `getHelp`, `getOpts`, and `validate`.\n\n### `getHelp(flags)`\n\nReturns: `String` \nParameters:\n\n#### `flags`\n\nType: `Object` \n_Required_\n\nAn object containing a valid flag schema.\n\n### `getOpts(flags)`\n\nReturns: `Object`\nParameters:\n\n#### `flags`\n\nType: `Object` \n_Required_\n\nAn object containing a valid flag schema.\n\n### `validate(options)`\n\nReturns: `Boolean`\nParameters:\n\n#### `options`\n\nType: `Object { argv, flags, prefix, throw }` \n_Required_\n\nAn object containing properties used to validate a set of flags against a\nflag schema.\n\n#### `options.argv`\n\nType: `Object` \n_Required_\n\nAn object containing the parsed result from either\n[`minimist`](https://github.com/substack/minimist) or\n[`yargs-parser`](https://github.com/yargs/yargs-parser).\n\n#### `options.flags`\n\nType: `Object` \n_Required_\n\nAn object containing a valid flag schema.\n\n#### `options.prefix`\n\nType: `String` \nDefault: `'webpack'`\n\nA `String` specifying a prefix identifier for the consuming module, used when\nreporting errors.\n\n#### `options.throw`\n\nType: `Boolean` \nDefault: `true`\n\nA `Boolean` specifying whether or not to throw an error when a validation\nerror is encountered. If `false`, will simply log the error and return `false`.\n\n## Contributing\n\nPlease take a moment to read our contributing guidelines if you haven't yet done so.\n\n#### [CONTRIBUTING](./.github/CONTRIBUTING.md)\n\n## License\n\n#### [MIT](./LICENSE)\n\n[npm]: https://img.shields.io/npm/v/cli-utils.svg\n[npm-url]: https://npmjs.com/package/cli-utils\n\n[node]: https://img.shields.io/node/v/cli-utils.svg\n[node-url]: https://nodejs.org\n\n[deps]: https://david-dm.org/webpack-contrib/cli-utils.svg\n[deps-url]: https://david-dm.org/webpack-contrib/cli-utils\n\n[tests]: \thttps://img.shields.io/circleci/project/github/webpack-contrib/cli-utils.svg\n[tests-url]: https://circleci.com/gh/webpack-contrib/cli-utils\n\n[cover]: https://codecov.io/gh/webpack-contrib/cli-utils/branch/master/graph/badge.svg\n[cover-url]: https://codecov.io/gh/webpack-contrib/cli-utils\n\n[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg\n[chat-url]: https://gitter.im/webpack/webpack\n\n[size]: https://packagephobia.now.sh/badge?p=cli-utils\n[size-url]: https://packagephobia.now.sh/result?p=cli-utils","_attachments":{},"homepage":"https://github.com/webpack-contrib/cli-utils","bugs":{"url":"https://github.com/webpack-contrib/cli-utils/issues"},"license":"MIT"}