Issue with Description Column not Rendering on Separate Line
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- cli
Research direction
Open index.ts and inspect the _renderInLine function, especially the leadingWhitespace and targetTextWidth condition. Verify the rendering behavior for descriptions at the maximum field width, then confirm that the type and default text break onto a separate line without affecting shorter descriptions.
Written by the indexing model from the issue text.
Description
I inadvertently created an argument description that turned out to be 37 characters long. When help is displayed, the description displays as follows:
--lts, -l Download 'Long Term Support' releases[boolean] [default: false]
Personally I think it would look better if the line had a line break inserted via the _renderInLine function in order to keep the description from running into the square bracket. If the description is 38 characters in length, it will render the type and default on a separate line.
A simple change to the _renderInLine function in index.ts, changing this code:
if (leadingWhitespace < targetTextWidth) {
to this:
if (leadingWhitespace < targetTextWidth + 1) {
allows the line to break if the description is the maximum width of the field.
- Dominant language
- JavaScript
- Stars
- 395
- Forks
- 44
- Avg merge
- 6m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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.
More from yargs/cliui
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
task
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
antfu-collective/icones#398 ·
-
ECmail.com Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
wesbos/burner-email-providers#554 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
components-web-app/docs#92 ·