![](\"/.documentary/section-breaks/0.svg?sanitize=true\")
\n| Arguments.xml File (view source) |
|---|
| \n\n```xml\n |
| \n Closure-Compatible Arguments\n |
|---|
| \n\n```js\nimport argufy from 'argufy'\n\nexport const argsConfig = {\n 'inputs': {\n description: 'The locations of `arguments.xml` files.',\n command: true,\n multiple: true,\n default: 'types/arguments.xml',\n },\n 'output': {\n description: 'The destination where to save output.\\nIf not passed, prints to stdout.',\n short: 'o',\n },\n 'help': {\n description: 'Print the help information and exit.',\n boolean: true,\n short: 'h',\n },\n 'version': {\n description: 'Show the version\\'s number and exit.',\n boolean: true,\n short: 'v',\n },\n}\n\nconst args = argufy(argsConfig)\n\n/**\n * The locations of `arguments.xml` files. Default `types/arguments.xml`.\n */\nexport const _inputs = /** @type {!Array |
| Usually Integration (view source) |
|---|
| \n\n```js\nimport usually from 'usually'\nimport { reduceUsage } from 'argufy'\nimport { _help, _output, _input, _version,\n argsConfig } from '../src/get-args'\n\nif (_help) {\n const usage = reduceUsage(argsConfig)\n console.log(usually({\n usage,\n description: `Generates the JavaScript file that exports all arguments\nbased on the configuration found in the arguments.xml file.`,\n line: 'argufy input [-o output] [-hv]',\n example: 'argufy types/arguments.xml -o src/bin/get-args.js',\n }))\n process.exit()\n}\n\n// program\n```\n |
\nWhen run as node example -h, the following output will be shown to the user to indicate how to use the program:\n |
| \n\n```\nGenerates the JavaScript file that exports all arguments\nbased on the configuration found in the arguments.xml file.\n\n argufy input [-o output] [-hv]\n\n\tinputs \tThe locations of `arguments.xml` files.\n\t \tDefault: types/arguments.xml.\n\t--output, -o \tThe destination where to save output.\n\t \tIf not passed, prints to stdout.\n\t--help, -h \tPrint the help information and exit.\n\t--version, -v\tShow the version's number and exit.\n\n Example:\n\n argufy types/arguments.xml -o src/bin/get-args.js\n```\n |
| Argument | \nShort | \nDescription | \n
|---|---|---|
| inputs | \n\n | The locations of arguments.xml files. Default types/arguments.xml. | \n
| --output | \n-o | \nThe destination where to save output.\n If not passed, prints to stdout. | \n
| --help | \n-h | \nPrint the help information and exit. | \n
| --version | \n-v | \nShow the version's number and exit. | \n
| 1.xml, anonymous | 2.xml, Bundle |
|---|---|
| \n\n```xml\n | \n\n```xml\n |
| 1.xml, original | 2.xml, additional |
|---|---|
| \n\n```xml\n | \n\n```xml\n |
![](\"/.documentary/section-breaks/1.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/2.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/3.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/4.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/5.svg?sanitize=true\")
\nargufy(): !Object\nThe flags from the arguments will be extracted according to the configuration object and the arguments array. If arguments array is not passed, `process.argv` is used to find arguments.\n\n - config* !Config: The config.\n - argv !Array<string> (optional): The `argv` to parse, by default will be looked up in the process.\n\nThe package assumes that the arguments begin from the 3rd position, i.e., standard _Node.JS_ use such as `node example.js --title \"Hello World\"`, or `example --title \"Hello World\"` if the program has a shebang and/or is run via the `bin` _package.json_ property.\n\n```js\nimport argufy from 'argufy'\n\nconst config = {\n title: { short: 't', command: true },\n list: { short: 'l', boolean: true },\n app: 'a',\n delay: 'y',\n file: 'f',\n wait: { short: 'w', number: true },\n 'no-empty': 'e',\n resize: 'z',\n colors: 'c',\n dir: 'D',\n}\n\nconst res = argufy(config, process.argv)\nconsole.log(JSON.stringify(res, null, 2))\n```\n\n```sh\nnode example.js --title \"Hello World\" -w 10 -l --app Argufy\n# or\nnode example.js HelloWorld -w 10 -l --app Argufy\n```\n\n```json\n{\n \"title\": \"HelloWorld\",\n \"list\": true,\n \"app\": \"Argufy\",\n \"wait\": 10,\n \"_argv\": []\n}\n```\n\nThe configuration for each flag can either be a shorthand string, or an object of the _Flag_ type. The types are shown below. The special `_argv` property will be assigned to contain all unmatched arguments. For example, it can be used to pass any additional parameters through to other program.\n\nObject<string, (string \\| !Flag)> __`Config`__: The configuration for parsing, where each key is a flag name and values are either strings, or objects with possible properties:\n\n__`Flag`__: The flag passed to the program.\n\n| Name | Type | Description | Default |\n| ----------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |\n| short | string | Shorthand for this argument, usually one letter. | - |\n| boolean | boolean | Whether the flag is a boolean and does not require a value. | `false` |\n| number | boolean | Specifies whether the flag should be parsed as a number. | `false` |\n| command | boolean | If set to true, the value is read from the first argument passed to the CLI command (e.g., `$ cli command`). | `false` |\n| multiple | boolean | When using the `command` property, will parse the commands as an array. | `false` |\n| default | string | The default value for the argument. Does not actually set the value, only used in reducing the usage info (`argufy` bin on the other hand will set the default). | - |\n| description | string | The description to be used by `usually`. | - |\n\n\n\n### ![](\"/.documentary/section-breaks/6.svg?sanitize=true\")
\nreduceUsage(): !Object\nGiven the _Argufy_ config, creates an object that can be passed to [_Usually_](https://artdecocode.com/usually/). Can be used to reduce the config auto-generated and exported from the JavaScript file with the CLI.\n\n - config* !Config: The config.\n\n```js\nimport { reduceUsage } from 'argufy'\nimport { argsConfig } from '../src/get-args'\n\nconsole.log(reduceUsage(argsConfig))\n```\n```js\n{ inputs: 'The locations of `arguments.xml` files.\\nDefault: types/arguments.xml.',\n '--output, -o': 'The destination where to save output.\\nIf not passed, prints to stdout.',\n '--help, -h': 'Print the help information and exit.',\n '--version, -v': 'Show the version\\'s number and exit.' }\n```\n\n\n\n## Copyright\n\n\n \n ![\"Art](\"https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png\"\n) \n \n | \n © Art Deco 2019 | \n\n \n ![\"Tech](\"https://raw.githubusercontent.com/idiocc/cookies/master/wiki/arch4.jpg\"\n) \n \n | \n Tech Nation Visa Sucks | \n
|---|
![](\"/.documentary/section-breaks/7.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/-1.svg?sanitize=true\")
\n