Skip to content

Fix leading space in option helptext #2348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2025
Merged

Fix leading space in option helptext #2348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f4c4b9
Trim description when there's only extra info
mmkal Mar 24, 2025
7f24676
Merge branch 'develop' into trim-description
mmkal Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion lib/help.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,11 @@ class Help {
extraInfo.push(`env: ${option.envVar}`);
}
if (extraInfo.length > 0) {
return `${option.description} (${extraInfo.join(', ')})`;
const extraDescription = `(${extraInfo.join(', ')})`;
if (option.description) {
return `${option.description} ${extraDescription}`;
}
return extraDescription;
}

return option.description;
Expand Down
12 changes: 12 additions & 0 deletions tests/help.optionDescription.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,18 @@ describe('optionDescription', () => {
);
});

test('when option has default value but not description then return custom default', () => {
const defaultValueDescription = 'custom';
const option = new commander.Option('-a <value>').default(
'default value',
defaultValueDescription,
);
const helper = new commander.Help();
expect(helper.optionDescription(option)).toEqual(
`(default: ${defaultValueDescription})`,
);
});

test('when option has choices then return description and choices', () => {
const description = 'description';
const choices = ['one', 'two'];
Expand Down