Example in help output on one line

Author: alber70gCreated May 17, 2017Updated Aug 1, 2026

Labelsenhancement

Suggestion: put the examples on one line so that it can be easier copy/pasted. Right now, in the --help output, the example and the description of it, are in two columns. This hurts when a user wants to use the example that's given. It can also confuse the user since the parts of the command are not in one line. See below for an example

Also, the types could be as 2nd column in the options. this way it'll always be next to the description, which has a more variable length than the options, abbreviations and the type.

Current:

$ node scripts/run-wct --help
Usage: node scripts/run-wct [options]

Options:
  --all, -a   Run all test suites (ignores + and - prefixes)           [boolean]
  --wct       Provide wct arguments                                     [string]
  --help, -h  Show help                                                [boolean]

Examples:
  node scripts/run-wct --all                Run all test stuites, without
  --wct="--skip-selenium-install            installing selenium and keep
  --persistent"                             browser open

Suggestion:

$ node scripts/run-wct --help
Usage: node scripts/run-wct [options]

Options:
  --all, -a   [boolean]    Run all test suites (ignores + and - prefixes)
  --wct       [string]     Provide wct arguments
  --help, -h  [boolean]    Show help

Examples:
  Run all test stuites, without installing selenium and keep browser open
  $ node scripts/run-wct --all --wct="--skip-selenium-install --persistent"

Source: yargs/yargs

View original on GitHub View discussion on GitHub