cli: add --checks.pretty

RTradeLtd · May 8, 2020 · 344c4d9 · 344c4d9
1 parent 97f14df
commit 344c4d9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -244,7 +244,7 @@ regressions don't happen:
 
 ```sh
 gobenchdata checks generate
-gobenchdata checks eval [base benchmarks] [current benchmarks]
+gobenchdata checks eval ${base benchmarks} ${current benchmarks} --checks.pretty
 ```
 
 For more details on how to use checks, see the [pull request checks documentation](#pull-request-checks).

diff --git a/doc.go b/doc.go
@@ -26,7 +26,7 @@ Visualize the results:
 Compare results:
 
 	gobenchdata checks generate # generates config file to define checks
-	gobenchdata checks eval base-benchmarks.json current-benchmarks.json
+	gobenchdata checks eval base-benchmarks.json current-benchmarks.json --checks.pretty
 
 Learn more in the repository README: https://github.com/bobheadxi/gobenchdata
 */

diff --git a/main.go b/main.go
@@ -31,6 +31,7 @@ var (
 	webIndexTitle = pflag.String("web.title", "gobenchdata web", "header <title> for 'gobenchdata web'")
 	webIndexHead  = pflag.StringArray("web.head", []string{}, "additional <head> elements for 'gobenchdata web'")
 
+	checksPretty     = pflag.Bool("checks.pretty", false, "output report as human-readable format instead of JSON")
 	checksConfigPath = pflag.String("checks.config", "gobenchdata-checks.yml", "path to checks configuraton file")
 
 	version = pflag.StringP("version", "v", "", "version to tag in your benchmark output")
@@ -171,23 +172,27 @@ func main() {
 				if err != nil {
 					panic(err)
 				}
-
-				var b []byte
-				if *flat {
-					b, err = json.Marshal(res)
-				} else {
-					b, err = json.MarshalIndent(res, "", "  ")
-				}
-				if err != nil {
-					panic(err)
-				}
-
-				if *jsonOut == "" {
-					println(string(b))
+				if *checksPretty {
+					outputChecksReport(res)
 				} else {
-					if err := ioutil.WriteFile(*jsonOut, b, os.ModePerm); err != nil {
+					var b []byte
+					if *flat {
+						b, err = json.Marshal(res)
+					} else {
+						b, err = json.MarshalIndent(res, "", "  ")
+					}
+					if err != nil {
 						panic(err)
 					}
+
+					if *jsonOut == "" {
+						println(string(b))
+					} else {
+						if err := ioutil.WriteFile(*jsonOut, b, os.ModePerm); err != nil {
+							panic(err)
+						}
+						fmt.Printf("report output written to %s\n", *jsonOut)
+					}
 				}
 			case "report":
 				if len(pflag.Args()) < 3 {
@@ -198,6 +203,8 @@ func main() {
 					panic(err)
 				}
 				outputChecksReport(results)
+
+				// exit with code corresponding to status
 				if results.Status != checks.StatusPass {
 					os.Exit(1)
 				}