(#123) Add validation to prevent value with short verbose option #3730
Conversation
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
1929d7a to
cff106f
Compare
Detect and throw an exception when a value is passed to the short `-v` (verbose) option, which does not support explicit values. This prevents user confusion and incorrect usage by suggesting the correct `--version` option instead. Add a test to verify that passing a value to `-v` triggers the expected exception with a helpful message. This improves command line argument parsing robustness and user experience.
cff106f to
27f6e75
Compare
|
The docker build is failing due to connection to NuGet.org. Going to move forward with getting this merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description Of Changes
Adds validation to detect and reject attempts to pass a value to the
-v(verbose) short option, which does not support values. If such usage is detected (e.g.,-v:5.2.1or/v='5.2.1'), the parser throws a helpful exception suggesting the user may have meant--versioninstead.Also adds a corresponding test using
[Fact, Combinatorial]to ensure the exception is thrown correctly across combinations of separators, quotes, and prefixes.Motivation and Context
Users commonly mistake the
-v(verbose) option for--version, leading to confusing or incorrect behavior when supplying a value. This change preempts the error by detecting the misuse early in argument parsing and providing a targeted suggestion to improve the user experience and prevent unintentional silent failures.Testing
Fact, Combinatorialtest that validates the parser throws anApplicationExceptionfor common invalid usages of-vwith a value.--versionusage.Manual Tests:
choco -v 5.2.1and verify the expected excetpion message is outputted.choco search /v 2.1.6and verify the expected exception message is outputted.=,:andOperating Systems Testing
Change Types Made
Change Checklist
Related Issue
-voption in conjunction with a version number is detected #123