From b3ffe708b4acc88158fdda187e1667e939e8af9c Mon Sep 17 00:00:00 2001
From: Mostafa Moradian <mstfmoradian@gmail.com>
Date: Fri, 2 Feb 2024 20:32:46 +0100
Subject: [PATCH] feat: implement stats per linter with a flag (#4341)

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
---
 .golangci.reference.yml |  4 ++++
 pkg/commands/run.go     | 30 ++++++++++++++++++++++++++++++
 pkg/config/run.go       |  2 ++
 3 files changed, 36 insertions(+)

diff --git a/.golangci.reference.yml b/.golangci.reference.yml
index 8df0419b78e7..f9a8d0feec32 100644
--- a/.golangci.reference.yml
+++ b/.golangci.reference.yml
@@ -84,6 +84,10 @@ run:
   # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.17
   go: '1.19'
 
+  # Show statistics per linter.
+  # Default: false
+  show-stats: true
+
 
 # output configuration options
 output:
diff --git a/pkg/commands/run.go b/pkg/commands/run.go
index a082d7adfc91..933096ada434 100644
--- a/pkg/commands/run.go
+++ b/pkg/commands/run.go
@@ -8,12 +8,14 @@ import (
 	"log"
 	"os"
 	"runtime"
+	"sort"
 	"strings"
 	"time"
 
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
+	"golang.org/x/exp/maps"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/exitcodes"
@@ -125,6 +127,7 @@ func initFlagSet(fs *pflag.FlagSet, cfg *config.Config, m *lintersdb.Manager, is
 	const allowSerialDesc = "Allow multiple golangci-lint instances running, but serialize them around a lock. " +
 		"If false (default) - golangci-lint exits with an error if it fails to acquire file lock on start."
 	fs.BoolVar(&rc.AllowSerialRunners, "allow-serial-runners", false, wh(allowSerialDesc))
+	fs.BoolVar(&rc.ShowStats, "show-stats", false, wh("Show statistics per linter"))
 
 	// Linters settings config
 	lsc := &cfg.LintersSettings
@@ -408,6 +411,8 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
 		}
 	}
 
+	e.printStats(issues)
+
 	e.setExitCodeIfIssuesFound(issues)
 
 	e.fileCache.PrintStats(e.log)
@@ -489,6 +494,31 @@ func (e *Executor) createPrinter(format string, w io.Writer) (printers.Printer,
 	return p, nil
 }
 
+func (e *Executor) printStats(issues []result.Issue) {
+	if !e.cfg.Run.ShowStats {
+		return
+	}
+
+	if len(issues) == 0 {
+		e.runCmd.Println("0 issues.")
+		return
+	}
+
+	stats := map[string]int{}
+	for idx := range issues {
+		stats[issues[idx].FromLinter]++
+	}
+
+	e.runCmd.Printf("%d issues:\n", len(issues))
+
+	keys := maps.Keys(stats)
+	sort.Strings(keys)
+
+	for _, key := range keys {
+		e.runCmd.Printf("* %s: %d\n", key, stats[key])
+	}
+}
+
 // executeRun executes the 'run' CLI command, which runs the linters.
 func (e *Executor) executeRun(_ *cobra.Command, args []string) {
 	needTrackResources := e.cfg.Run.IsVerbose || e.cfg.Run.PrintResourcesUsage
diff --git a/pkg/config/run.go b/pkg/config/run.go
index ff812d0a2583..2bb21d9fa224 100644
--- a/pkg/config/run.go
+++ b/pkg/config/run.go
@@ -37,4 +37,6 @@ type Run struct {
 
 	AllowParallelRunners bool `mapstructure:"allow-parallel-runners"`
 	AllowSerialRunners   bool `mapstructure:"allow-serial-runners"`
+
+	ShowStats bool `mapstructure:"show-stats"`
 }