yargs/yargs

Allow customising of "extra" help

Open

#427 opened on Mar 10, 2016

View on GitHub
 (3 comments) (4 reactions) (0 assignees)JavaScript (1,053 forks)batch import
Help Wantedfeature requesttriaged

Repository metrics

Stars
 (10,829 stars)
PR merge metrics
 (Avg merge 113d 19h) (11 merged PRs in 30d)

Description

When I use certain things like choices or default values the outputted help looks quite convoluted to me. It would be nice to optionally hide that output of format it differently.

E.g. I have this:

Options:
  -l, --log-level  Set log level
      [choices: "silly", "verbose", "info", "warn", "error", "silent"] [default:
                                                                         "info"]
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]

Maybe something like this is nicer:

Options:
  -l, --log-level  Set log level (default: "info")
                   [ "silly", "verbose", "info", "warn", "error", "silent" ]
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (defaults to "info" or use "silly", "verbose", "warn", "error", "silent")
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (defaults to "info")
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (info,silly,verbose,warn,error,silent)
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]

Contributor guide