Replicate change from dotnet/command-line-api#2586#49520
Merged
baronfel merged 1 commit intodotnet:mainfrom Jun 23, 2025
Merged
Replicate change from dotnet/command-line-api#2586#49520baronfel merged 1 commit intodotnet:mainfrom
baronfel merged 1 commit intodotnet:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the help label generation logic to take an argument’s or option’s arity into account, ensuring that zero-arity symbols do not display an argument placeholder in the help output.
- Extended GetUsageLabel to accept an ArgumentArity and skip showing a usage label when MaximumNumberOfValues is zero.
- Updated calls to GetUsageLabel from GetArgumentUsageLabel to pass the new arity parameter.
Comments suppressed due to low confidence (1)
src/Cli/Microsoft.TemplateEngine.Cli/Help/HelpBuilder.Default.cs:67
- Add unit tests that verify zero-arity arguments and options do not render an argument placeholder in the help output, covering both minimum and maximum arity scenarios.
&& arity.MaximumNumberOfValues > 0 // allowing zero arguments means we don't need to show usage
joeloff
reviewed
Jun 23, 2025
joeloff
approved these changes
Jun 23, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ensures that any zero-arity options or arguments never show an argument in help output.
This is a no-op right now (because we have no non-bool-typed zero-arity Options), but as soon as we do have one we'd hit this case.