Prevent help output from escaping default values as go strings #347
Conversation
This file contains 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
When creating the help text for a flag, the default value shouldn't be be excaped. It isn't clear to an end user that we would be escaping those values. Instead we should be printing the actual value and letting the users decide when/how to add escaping based on how they're utilzing it. Fixes spf13#346 Signed-off-by: John Schnake <jschnake@vmware.com>
johnSchnake
commented
Mar 16, 2022
| @@ -475,7 +475,7 @@ func (f *FlagSet) Set(name, value string) error { | |||
| } else { | |||
| flagName = fmt.Sprintf("--%s", flag.Name) | |||
| } | |||
| return fmt.Errorf("invalid argument %q for %q flag: %v", value, flagName, err) | |||
| return fmt.Errorf(`invalid argument "%v" for "%v" flag: %v`, value, flagName, err) | |||
There was a problem hiding this comment.
Preempting a similar issue here potentially.
johnSchnake
commented
Mar 16, 2022
| @@ -411,7 +411,7 @@ func (f *FlagSet) ArgsLenAtDash() int { | |||
| func (f *FlagSet) MarkDeprecated(name string, usageMessage string) error { | |||
| flag := f.Lookup(name) | |||
| if flag == nil { | |||
| return fmt.Errorf("flag %q does not exist", name) | |||
| return fmt.Errorf(`flag "%v" does not exist`, name) | |||
There was a problem hiding this comment.
Preempting a similar issue here potentially.
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.
When creating the help text for a flag, the default value shouldn't be
be excaped. It isn't clear to an end user that we would be escaping those values.
Instead we should be printing the actual value and letting the users decide
when/how to add escaping based on how they're utilzing it.
Fixes #346
Signed-off-by: John Schnake jschnake@vmware.com