chore: change cli error message handling #9952
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
Emyrk
changed the title
ammario
approved these changes
Sep 29, 2023
|
|
||
| func errorWithStackTrace() error { | ||
| return xerrors.Errorf("function decided not to work, and it never will") | ||
| } |
There was a problem hiding this comment.
[Re: lines 103 to 103]
Nifty
See this comment inline on Graphite.
| } | ||
| return str.String() | ||
| } |
There was a problem hiding this comment.
I believe this is the last remnant of lipgloss in our codebase. If you could edit the code to use the pretty style that would be a nice side-win for the change.
There was a problem hiding this comment.
Lipgloss is still in the go.mod file because of slogtest:
https://github.com/coder/slog/blob/main/internal/entryhuman/entry.go#L19
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
This changes how we format cli error messages, and adds a hidden command to easily get these errors on the UI. I was trying to run commands with bad args to test the visuals, and it was annoying.
Basically, instead of trying to handle errors as a general construct, I just wrote a formatter for each error type we expect to encounter. If we add more sentinel errors, we can just write a custom formatter here. It is easier then trying to be "smart" and general.
I am writing these all in 1 spot rather than making some
CliError() stringmethod to share styles and keep it all together. I think we will modify this more as we tailor the look of things.The biggest thing here is that verbosity is now a flag passed to the formatter.
Closes:
#9492
#9577
Error examples
Multi-Errors
These would be very rare. Before on left, after on right.
CMD Errors
Very common. All cmd errors are wrapped as RunCommandErrors.
API Errors
Missing required flag
Flag validation
This one sucks. The error from pflag is opaque: https://github.com/spf13/pflag/blob/master/flag.go#L478
😢 The package is very unmaintained. Might be worth forking and adding some better errors for us.
There is some conversation on the maintenance of it, but who knows what will come of that.
spf13/pflag#385
Issue that is related to what we want here: spf13/pflag#269
https://github.com/spf13/pflag/pulls?q=is%3Apr+is%3Aclosed