feat: Use structs for errors returned by pflag. #425
Merged
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
Add tests to ensure invalid arguments and unknown flag error messages don't change.
|
|
This allows callers to differentiate between error types without having to parse the error message string.
tomasaschan
approved these changes
Apr 22, 2025
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.
This pull request is the pflag complement to spf13/cobra#2266, converting a bunch of
fmt.Errorferrors into structs implementing theerrorinterface.The goal of this pull request is to make it easier for callers of the
Parsefunction to determine why flag parsing failed without having to resort to regex matching or parsing the returned error message. This pull request goes a bit further than using the%werror-wrapping format verb, opting to use structs as a way to both determine the type of returned error and get specific details about it (e.g. the relevant*pflag.Flag).Giving callers this info enables them to do new things such as:
The error structs added are:
NotExistErrorValueRequiredErrorInvalidValueErrorInvalidSyntaxErrorTests have been added as well, and I made sure to maintain compatibility with versions of pflag prior to this pull request by using the exact same error messages.