├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 14 14 | - 12 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: actions/setup-node@v2 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import parseHelp from 'parse-help'; 2 | 3 | export default function aliases(input, extras) { 4 | return Object.assign(parseHelp(input).aliases, extras); 5 | } 6 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "aliases", 3 | "version": "2.0.0", 4 | "description": "Parse flag aliases in CLI help output", 5 | "license": "MIT", 6 | "repository": "sindresorhus/aliases", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": ">=12" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava" 20 | }, 21 | "files": [ 22 | "index.js" 23 | ], 24 | "keywords": [ 25 | "parse", 26 | "help", 27 | "cli", 28 | "argv", 29 | "command-line", 30 | "man", 31 | "flags", 32 | "arguments", 33 | "alias", 34 | "aliases", 35 | "short" 36 | ], 37 | "dependencies": { 38 | "parse-help": "^2.0.0" 39 | }, 40 | "devDependencies": { 41 | "ava": "^3.15.0", 42 | "xo": "^0.38.2" 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # aliases 2 | 3 | > Parse flag aliases in CLI help output 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install aliases 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import aliases from 'aliases'; 15 | 16 | const help = ` 17 | Usage 18 | $ unicorn 19 | 20 | Options 21 | -r, --rainbow Lorem ipsum dolor sit amet 22 | -m, --magic Aenean commodo ligula eget dolor 23 | `; 24 | 25 | aliases(help, {h: 'help'}); 26 | /* 27 | { 28 | r: 'rainbow', 29 | m: 'magic', 30 | h: 'help' 31 | } 32 | */ 33 | ``` 34 | 35 | The result can be passed directly to the [minimist](https://github.com/substack/minimist) `alias` option or used in [meow](https://github.com/sindresorhus/meow) with some effort. 36 | 37 | ## API 38 | 39 | ### aliases(input, extras?) 40 | 41 | #### input 42 | 43 | Type: `string` 44 | 45 | CLI help output. 46 | 47 | #### extras 48 | 49 | Type: `object` 50 | 51 | Extra aliases to mix into the result. 52 | 53 | ## Related 54 | 55 | - [parse-help](https://github.com/sindresorhus/parse-help) - Parse CLI help output 56 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import aliases from './index.js'; 3 | 4 | const fixture = ` 5 | Usage 6 | $ unicorn 7 | 8 | Options 9 | -r, --rainbow Lorem ipsum dolor sit amet 10 | -m, --magic Aenean commodo ligula eget dolor 11 | `; 12 | 13 | test('main', t => { 14 | t.deepEqual(aliases(fixture, {h: 'help'}), { 15 | r: 'rainbow', 16 | m: 'magic', 17 | h: 'help' 18 | }); 19 | }); 20 | --------------------------------------------------------------------------------