Option columns in help text don't have enough separation
Open
Nobody has claimed this yet.
feature request
- Dominant language
- JavaScript
- Stars
- 11.5k
- Forks
- 1k
- PR merge metrics
- No merged PRs in 30d
Description
require('yargs')
.default('option', 'description', 'x'.repeat(59))
.parse(['--help'])
Options:
--help Show help [boolean]
--version Show version number [boolean]
--option[default: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx]
Note that there is no whitespace between --option and the subsequent [default: ...]
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the JavaScript reproduction with yargs and inspect how the --help output formats a long default value. Done means the generated help text includes whitespace between --option and [default: ...] without disrupting the other option rows.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100