feat: Add more help in error message #72
Merged
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
|
This pull request has been linked to Shortcut Story #237653: show the right usage help on subcommand error. |
dbolson
commented
Mar 26, 2024
| "ldcli/internal/flags" | ||
| ) | ||
|
|
||
| func NewCreateCmd(client flags.Client) (*cobra.Command, error) { | ||
| cmd := &cobra.Command{ | ||
| Use: "create", |
There was a problem hiding this comment.
Sorted and moved the validate function into validators.Validate.
| @@ -12,6 +12,7 @@ import ( | |||
| ) | |||
|
|
|||
| func TestCreate(t *testing.T) { | |||
| errorHelp := ". See `ldcli flags create --help` for supported flags and usage." | |||
There was a problem hiding this comment.
We can refactor these tests to DRY up some duplication.
|
|
||
| // Validate is a validator for commands to print an error when the number provided | ||
| // is different than the arguments passed in | ||
| func Validate() cobra.PositionalArgs { |
There was a problem hiding this comment.
Mostly taken from stripe's CLI.
dbolson
commented
Mar 26, 2024
| return func(cmd *cobra.Command, args []string) error { | ||
| commandPath := getCommandPath(cmd) | ||
|
|
||
| _, err := url.ParseRequestURI(viper.GetString("baseUri")) |
There was a problem hiding this comment.
We may want to extract unexported functions if this grows.
sunnyguduru
approved these changes
Mar 27, 2024
k3llymariee
approved these changes
Mar 27, 2024
cmd/validators/validators.go
Outdated
Comment on lines
14
to
15
| // Validate is a validator for commands to print an error when the number provided | ||
| // is different than the arguments passed in |
There was a problem hiding this comment.
can we update this docstring since we're doing more than just validating the # of args (or just remove)
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 a command doesn't have the right flags, we show a one line error message that describes the error and says how to see more info with --help instead of showing the results of calling --help. This can cut down on noise while still giving the user enough info for how to fix the error.
If the error comes from the API, just show that error like normal.
The "flag needs an argument" message doesn't show the additional help text because it's more difficult to hook into the
pflagserror where it originates instead of the other errors that come fromcobra.