From 1f019066c7abc53cd5e1da95470d7112d3f529d9 Mon Sep 17 00:00:00 2001 From: Yann Hamon Date: Mon, 1 Jun 2020 12:59:46 +0200 Subject: [PATCH] -verbose instead of -quiet, -quiet seems a better default --- main.go | 29 ++++++++++------------------- pkg/output/json.go | 6 +++--- pkg/output/text.go | 10 +++++----- 3 files changed, 18 insertions(+), 27 deletions(-) diff --git a/main.go b/main.go index c102056..bb54261 100644 --- a/main.go +++ b/main.go @@ -118,16 +118,7 @@ func validateFile(r io.Reader, regs []registry.Registry, k8sVersion string, c *c type arrayParam []string func (ap *arrayParam) String() string { - s := "" - for _, param := range *ap { - if s == "" { - s += param - } else { - s += " - " + param - } - } - - return s + return strings.Join(*ap, " - ") } func (ap *arrayParam) Set(value string) error { @@ -135,12 +126,12 @@ func (ap *arrayParam) Set(value string) error { return nil } -func getLogger(outputFormat string, printSummary, quiet bool) (output.Output, error) { +func getLogger(outputFormat string, printSummary, verbose bool) (output.Output, error) { switch { case outputFormat == "text": - return output.Text(printSummary, quiet), nil + return output.Text(printSummary, verbose), nil case outputFormat == "json": - return output.JSON(printSummary, quiet), nil + return output.JSON(printSummary, verbose), nil default: return nil, fmt.Errorf("-output must be text or json") } @@ -158,7 +149,7 @@ func skipKindsMap(skipKindsCSV string) map[string]bool { func realMain() int { var files, dirs, schemas arrayParam var skipKindsCSV, k8sVersion, outputFormat string - var printSummary, strict, quiet bool + var summary, strict, verbose bool var nWorkers int var err error @@ -166,16 +157,16 @@ func realMain() int { flag.Var(&files, "file", "file to validate (can be specified multiple times)") flag.Var(&dirs, "dir", "directory to validate (can be specified multiple times)") flag.Var(&schemas, "schema", "file containing an additional Schema (can be specified multiple times)") - flag.BoolVar(&printSummary, "printsummary", false, "print a summary at the end") - flag.IntVar(&nWorkers, "workers", 4, "number of routines to run in parallel") - flag.StringVar(&skipKindsCSV, "skipKinds", "", "comma-separated list of kinds to ignore") + flag.BoolVar(&summary, "summary", false, "print a summary at the end") + flag.IntVar(&nWorkers, "n", 4, "number of routines to run in parallel") + flag.StringVar(&skipKindsCSV, "skip", "", "comma-separated list of kinds to ignore") flag.BoolVar(&strict, "strict", false, "disallow additional properties not in schema") flag.StringVar(&outputFormat, "output", "text", "output format - text, json") - flag.BoolVar(&quiet, "quiet", false, "quiet output - only print invalid files, and errors") + flag.BoolVar(&verbose, "verbose", false, "print results for all resources") flag.Parse() var o output.Output - if o, err = getLogger(outputFormat, printSummary, quiet); err != nil { + if o, err = getLogger(outputFormat, summary, verbose); err != nil { fmt.Println(err) return 1 } diff --git a/pkg/output/json.go b/pkg/output/json.go index 83b3867..1545431 100644 --- a/pkg/output/json.go +++ b/pkg/output/json.go @@ -15,7 +15,7 @@ type result struct { type jsono struct { withSummary bool - quiet bool + verbose bool results []result nValid, nInvalid, nErrors, nSkipped int } @@ -23,7 +23,7 @@ type jsono struct { func JSON(withSummary bool, quiet bool) Output { return &jsono{ withSummary: withSummary, - quiet: quiet, + verbose: quiet, results: []result{}, nValid: 0, nInvalid: 0, @@ -54,7 +54,7 @@ func (o *jsono) Write(filename, kind, version string, err error, skipped bool) { o.nSkipped++ } - if !o.quiet || (s != VALID && s != SKIPPED) { + if o.verbose || s == VALID || s == SKIPPED { o.results = append(o.results, result{Filename: filename, Kind: kind, Version: version, Status: st, Msg: msg}) } } diff --git a/pkg/output/text.go b/pkg/output/text.go index cb44ffe..bf4a78d 100644 --- a/pkg/output/text.go +++ b/pkg/output/text.go @@ -8,14 +8,14 @@ import ( type text struct { sync.Mutex withSummary bool - quiet bool + verbose bool nValid, nInvalid, nErrors, nSkipped int } -func Text(withSummary, quiet bool) Output { +func Text(withSummary, verbose bool) Output { return &text{ withSummary: withSummary, - quiet: quiet, + verbose: verbose, nValid: 0, nInvalid: 0, nErrors: 0, @@ -29,7 +29,7 @@ func (o *text) Write(filename, kind, version string, err error, skipped bool) { switch status(err, skipped) { case VALID: - if !o.quiet { + if !o.verbose { fmt.Printf("%s - %s is valid\n", filename, kind) } o.nValid++ @@ -40,7 +40,7 @@ func (o *text) Write(filename, kind, version string, err error, skipped bool) { fmt.Printf("%s - %s failed validation: %s\n", filename, kind, err) o.nErrors++ case SKIPPED: - if !o.quiet { + if o.verbose { fmt.Printf("%s - %s skipped\n", filename, kind) } o.nSkipped++