disable the congrats message

There is now an extra switch '-s' to disable the congrats message when
there are no issues detected

Fixes: golangci#110

Author: dahankzter

README.md

@@ -294,6 +294,7 @@ Global Flags:
   -j, --concurrency int           Concurrency (default NumCPU) (default 8)
       --cpu-profile-path string   Path to CPU profile output file
       --mem-profile-path string   Path to memory profile output file
+  -s, --no-congrats               disable congrats output
   -v, --verbose                   verbose output
 
 ```

pkg/commands/root.go

@@ -84,6 +84,7 @@ func (e *Executor) needVersionOption() bool {
 
 func initRootFlagSet(fs *pflag.FlagSet, cfg *config.Config, needVersionOption bool) {
 	fs.BoolVarP(&cfg.Run.IsVerbose, "verbose", "v", false, wh("verbose output"))
+	fs.BoolVarP(&cfg.Run.DisableCongrats, "no-congrats", "s", false, wh("disable congrats output"))
 	fs.StringVar(&cfg.Run.CPUProfilePath, "cpu-profile-path", "", wh("Path to CPU profile output file"))
 	fs.StringVar(&cfg.Run.MemProfilePath, "mem-profile-path", "", wh("Path to memory profile output file"))
 	fs.IntVarP(&cfg.Run.Concurrency, "concurrency", "j", getDefaultConcurrency(), wh("Concurrency (default NumCPU)"))

pkg/commands/run.go

@@ -255,16 +255,16 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
 	format := e.cfg.Output.Format
 	switch format {
 	case config.OutFormatJSON:
-		p = printers.NewJSON()
+		p = printers.NewJSON(e.cfg.Run.DisableCongrats)
 	case config.OutFormatColoredLineNumber, config.OutFormatLineNumber:
 		p = printers.NewText(e.cfg.Output.PrintIssuedLine,
-			format == config.OutFormatColoredLineNumber, e.cfg.Output.PrintLinterName,
+			format == config.OutFormatColoredLineNumber, e.cfg.Output.PrintLinterName, e.cfg.Run.DisableCongrats,
 			e.log.Child("text_printer"))
 	case config.OutFormatTab:
-		p = printers.NewTab(e.cfg.Output.PrintLinterName,
+		p = printers.NewTab(e.cfg.Output.PrintLinterName, e.cfg.Run.DisableCongrats,
 			e.log.Child("tab_printer"))
 	case config.OutFormatCheckstyle:
-		p = printers.NewCheckstyle()
+		p = printers.NewCheckstyle(e.cfg.Run.DisableCongrats)
 	default:
 		return fmt.Errorf("unknown output format %s", format)
 	}

pkg/config/config.go

@@ -92,6 +92,7 @@ func GetDefaultExcludePatternsStrings() []string {
 
 type Run struct {
 	IsVerbose           bool `mapstructure:"verbose"`
+	DisableCongrats     bool
 	CPUProfilePath      string
 	MemProfilePath      string
 	Concurrency         int

pkg/printers/checkstyle.go

@@ -29,13 +29,17 @@ type checkstyleError struct {
 
 const defaultSeverity = "error"
 
-type Checkstyle struct{}
+type Checkstyle struct {
+	disableCongrats bool
+}
 
-func NewCheckstyle() *Checkstyle {
-	return &Checkstyle{}
+func NewCheckstyle(disableCongrats bool) *Checkstyle {
+	return &Checkstyle{
+		disableCongrats: disableCongrats,
+	}
 }
 
-func (Checkstyle) Print(ctx context.Context, issues <-chan result.Issue) (bool, error) {
+func (c Checkstyle) Print(ctx context.Context, issues <-chan result.Issue) (bool, error) {
 	out := checkstyleOutput{
 		Version: "5.0",
 	}
@@ -63,6 +67,10 @@ func (Checkstyle) Print(ctx context.Context, issues <-chan result.Issue) (bool,
 		file.Errors = append(file.Errors, newError)
 	}
 
+	if len(files) == 0 && c.disableCongrats {
+		return true, nil
+	}
+
 	out.Files = make([]*checkstyleFile, 0, len(files))
 	for _, file := range files {
 		out.Files = append(out.Files, file)

pkg/printers/json.go

@@ -8,22 +8,30 @@ import (
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
-type JSON struct{}
+type JSON struct {
+	disableCongrats bool
+}
 
-func NewJSON() *JSON {
-	return &JSON{}
+func NewJSON(disableCongrats bool) *JSON {
+	return &JSON{
+		disableCongrats: disableCongrats,
+	}
 }
 
 type JSONResult struct {
 	Issues []result.Issue
 }
 
-func (JSON) Print(ctx context.Context, issues <-chan result.Issue) (bool, error) {
+func (j JSON) Print(ctx context.Context, issues <-chan result.Issue) (bool, error) {
 	allIssues := []result.Issue{}
 	for i := range issues {
 		allIssues = append(allIssues, i)
 	}
 
+	if len(allIssues) == 0 && j.disableCongrats {
+		return true, nil
+	}
+
 	res := JSONResult{
 		Issues: allIssues,
 	}

pkg/printers/tab.go

@@ -13,12 +13,14 @@ import (
 
 type Tab struct {
 	printLinterName bool
+	disableCongrats bool
 	log             logutils.Log
 }
 
-func NewTab(printLinterName bool, log logutils.Log) *Tab {
+func NewTab(printLinterName bool, disableCongrats bool, log logutils.Log) *Tab {
 	return &Tab{
 		printLinterName: printLinterName,
+		disableCongrats: disableCongrats,
 		log:             log,
 	}
 }
@@ -40,8 +42,10 @@ func (p *Tab) Print(ctx context.Context, issues <-chan result.Issue) (bool, erro
 	if issuesN != 0 {
 		p.log.Infof("Found %d issues", issuesN)
 	} else if ctx.Err() == nil { // don't print "congrats" if timeouted
-		outStr := p.SprintfColored(color.FgGreen, "Congrats! No issues were found.")
-		fmt.Fprintln(StdOut, outStr)
+		if !p.disableCongrats {
+			outStr := p.SprintfColored(color.FgGreen, "Congrats! No issues were found.")
+			fmt.Fprintln(StdOut, outStr)
+		}
 	}
 
 	if err := w.Flush(); err != nil {

pkg/printers/text.go

@@ -20,16 +20,18 @@ type Text struct {
 	printIssuedLine bool
 	useColors       bool
 	printLinterName bool
+	disableCongrats bool
 
 	cache filesCache
 	log   logutils.Log
 }
 
-func NewText(printIssuedLine, useColors, printLinterName bool, log logutils.Log) *Text {
+func NewText(printIssuedLine, useColors, printLinterName bool, disableCongrats bool, log logutils.Log) *Text {
 	return &Text{
 		printIssuedLine: printIssuedLine,
 		useColors:       useColors,
 		printLinterName: printLinterName,
+		disableCongrats: disableCongrats,
 		cache:           filesCache{},
 		log:             log,
 	}
@@ -92,8 +94,10 @@ func (p *Text) Print(ctx context.Context, issues <-chan result.Issue) (bool, err
 	if issuesN != 0 {
 		p.log.Infof("Found %d issues", issuesN)
 	} else if ctx.Err() == nil { // don't print "congrats" if timeouted
-		outStr := p.SprintfColored(color.FgGreen, "Congrats! No issues were found.")
-		fmt.Fprintln(StdOut, outStr)
+		if !p.disableCongrats {
+			outStr := p.SprintfColored(color.FgGreen, "Congrats! No issues were found.")
+			fmt.Fprintln(StdOut, outStr)
+		}
 	}
 
 	return issuesN != 0, nil

test/run_test.go

@@ -33,6 +33,12 @@ func checkNoIssuesRun(t *testing.T, out string, exitCode int) {
 	assert.Equal(t, "Congrats! No issues were found.\n", out)
 }
 
+func TestCongratsMessageGoneIfNoIssuesAndDisableCongrats(t *testing.T) {
+	out, exitCode := runGolangciLint(t, "../...", "-s")
+	assert.Equal(t, exitcodes.Success, exitCode)
+	assert.Equal(t, "", out)
+}
+
 func TestCongratsMessageIfNoIssues(t *testing.T) {
 	out, exitCode := runGolangciLint(t, "../...")
 	checkNoIssuesRun(t, out, exitCode)