aliases

v2.0.0
Parse flag aliases in CLI help output
parse help cli argv command-line man flags arguments alias and 3 more...

aliases

Parse flag aliases in CLI help output

Install

$ npm install aliases

Usage

import aliases from 'aliases';

const help = `
    Usage
      $ unicorn <name>

    Options
      -r, --rainbow  Lorem ipsum dolor sit amet
      -m, --magic    Aenean commodo ligula eget dolor
`;

aliases(help, {h: 'help'});
/*
{
    r: 'rainbow',
    m: 'magic',
    h: 'help'
}
*/

The result can be passed directly to the minimist alias option or used in meow with some effort.

API

aliases(input, extras?)

input

Type: string

CLI help output.

extras

Type: object

Extra aliases to mix into the result.

Related

npm i aliases

Metadata

  • MIT
  • >=12
  • Sindre Sorhus
  • released 4/9/2021

Downloads

Maintainers