chore: provide usage instruction for CLI argument failures #12309
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
mafredri
approved these changes
Feb 27, 2024
cli/clibase/cmd.go
Outdated
| @@ -562,6 +562,16 @@ func Chain(ms ...MiddlewareFunc) MiddlewareFunc { | |||
| return chain(reversed...) | |||
| } | |||
|
|
|||
| func UsageErrorPrefix(next HandlerFunc) HandlerFunc { | |||
There was a problem hiding this comment.
I think this could be a bit more descriptive as ShowUsageOnError or something like that? LGTM otherwise.
6308a00 to
7fab067
Compare
7fab067 to
18fbeb7
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What this does
When you do not provide enough args, you get an error telling you how many you need. It does not tell you what the arguments should be, so the user needs to run
coder <cmd> --helpto see.Now we always print the
FullUsage()when the number of arguments is incorrect for a cli command.Before
$ coder exp example-error arg-required Encountered an error running "coder exp example-error arg-required" wanted 1 args but got 0 []After