feat: add JSON output format to many CLI commands #6082
Conversation
There was a problem hiding this comment.
This is awesome! One nice addition would be to have a golden file test for the JSON output for one or multiple commands. It might help us make sure we don't have any regressions when messing with struct tags.
I feel I have to mention the panics though.. I know why they're there, I just don't like them. 😂 (Won't ask for a change this time around. 😉)
|
I've added golden files for Regarding panics, it'd be awkward to return an error from the new outputter function as this func is called from within a new command function, which does not return an error. |
| replace[k] = []byte(v) | ||
| } | ||
| for k, v := range replace { | ||
| got = bytes.ReplaceAll(got, []byte(k), v) |
There was a problem hiding this comment.
Maybe we can just use a map[string]string and strings.ReplaceAll to simplify and avoid the byte/string conversions?
There was a problem hiding this comment.
We'd have to convert got to a string in that case:
gotStr := strings.ReplaceAll([]byte(got), k, v)
got = []byte(gotStr)
Reworks the output format code which is scattered across many commands into a consistent output formatter object, which handles applying flags and the final output operation.
The output formatter provides an interface for making custom formatters (which some commands utilize, e.g.
coder user show).Some commands do some messy stuff currently as they run extra code before formatting, which I've accommodated for by reusing the existing functions to avoid breaking existing output formatting.