Add support for JSON output writing #14
Conversation
Add JSON output (with pretty-print option)
cmd/gocognit/main.go
Outdated
| over = flag.Int("over", defaultValueIndicator, "show functions with complexity > N only") | ||
| top = flag.Int("top", defaultValueIndicator, "show the top N most complex functions only") | ||
| avg = flag.Bool("avg", false, "show the average complexity") | ||
| format = flag.String("format", "text", fmt.Sprintf("which format to use, supported formats: %v", supportedFormats)) |
There was a problem hiding this comment.
Do you think better to use textFormat constant value instead of "text"? It yield the same value
There was a problem hiding this comment.
ofc, haven't seen that - thanks
cmd/gocognit/main.go
Outdated
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| return len(sortedStats) |
There was a problem hiding this comment.
This should returned the filtered stats? Initially the return value used on main() to indicate wether we have stats written or not.
With your changes, the exit code not only decided in main() function, but also in writeStats(..). Do you have any idea to make it better?
There was a problem hiding this comment.
Yes, I've now refactored it a bit. Nevertheless this should be a very rare case.
|
I've made some changes on master. Could you rebase from master, it might help to ensure the behavior of the command line is backward compatible |
|
I've refactored it and also did the rebase. Please review again |
cmd/gocognit/main.go
Outdated
| break | ||
| default: | ||
| fmt.Printf("Format '%s' is not valid, use a supported format %v", *format, supportedFormats) | ||
| os.Exit(1) |
There was a problem hiding this comment.
Let's put all the exit (os.Exit or log.Fatal) on the func main(). What if we return an error?
|
The test is fail on 1.16. Do you have any specific reason why you upgrade the go version to 1.18? |
|
Change it back to Go 1.16 should make it work |
|
@davidkroell May I know why you need this json format? |
|
I need this because I'd like to build a suite of quality checkers like this and generate reports based on these results and therefore json is an easy format to work with. |
|
Hi @davidkroell, do you really need feature for for non-pretty JSON? Or any kind of JSON output is fine? |
|
Hi @uudashr any JSON output is fine. |
Adding a new flag
-formatto set the output writer formatting. The default behavior keeps the same, astextis the default format.Adding this functionality required to refactor the code a bit. Logic for filtering (top/over) and writing is now moved to the
gocognitpackage.Also updated to go1.18