feat: only one log

Author: ldez

pkg/printers/checkstyle.go

@@ -18,15 +18,16 @@ const defaultCheckstyleSeverity = "error"
 // Checkstyle prints issues in the Checkstyle format.
 // https://checkstyle.org/config.html
 type Checkstyle struct {
+	log       logutils.Log
 	w         io.Writer
 	sanitizer severitySanitizer
 }
 
 func NewCheckstyle(log logutils.Log, w io.Writer) *Checkstyle {
 	return &Checkstyle{
-		w: w,
+		log: log.Child(logutils.DebugKeyCheckstylePrinter),
+		w:   w,
 		sanitizer: severitySanitizer{
-			log: log.Child(logutils.DebugKeyCheckstylePrinter),
 			// https://checkstyle.org/config.html#Severity
 			// https://checkstyle.org/property_types.html#SeverityLevel
 			allowedSeverities: []string{"ignore", "info", "warning", defaultCheckstyleSeverity},
@@ -35,7 +36,7 @@ func NewCheckstyle(log logutils.Log, w io.Writer) *Checkstyle {
 	}
 }
 
-func (p Checkstyle) Print(issues []result.Issue) error {
+func (p *Checkstyle) Print(issues []result.Issue) error {
 	out := checkstyleOutput{
 		Version: "5.0",
 	}
@@ -58,12 +59,17 @@ func (p Checkstyle) Print(issues []result.Issue) error {
 			Line:     issue.Line(),
 			Message:  issue.Text,
 			Source:   issue.FromLinter,
-			Severity: p.sanitizer.Clean(issue.Severity),
+			Severity: p.sanitizer.Sanitize(issue.Severity),
 		}
 
 		file.Errors = append(file.Errors, newError)
 	}
 
+	err := p.sanitizer.Err()
+	if err != nil {
+		p.log.Infof("%v", err)
+	}
+
 	out.Files = maps.Values(files)
 
 	sort.Slice(out.Files, func(i, j int) bool {

pkg/printers/codeclimate.go

@@ -13,23 +13,24 @@ const defaultCodeClimateSeverity = "critical"
 // CodeClimate prints issues in the Code Climate format.
 // https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md
 type CodeClimate struct {
+	log       logutils.Log
 	w         io.Writer
 	sanitizer severitySanitizer
 }
 
 func NewCodeClimate(log logutils.Log, w io.Writer) *CodeClimate {
 	return &CodeClimate{
-		w: w,
+		log: log.Child(logutils.DebugKeyCodeClimatePrinter),
+		w:   w,
 		sanitizer: severitySanitizer{
-			log: log.Child(logutils.DebugKeyCodeClimatePrinter),
 			// https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types
 			allowedSeverities: []string{"info", "minor", "major", defaultCodeClimateSeverity, "blocker"},
 			defaultSeverity:   defaultCodeClimateSeverity,
 		},
 	}
 }
 
-func (p CodeClimate) Print(issues []result.Issue) error {
+func (p *CodeClimate) Print(issues []result.Issue) error {
 	codeClimateIssues := make([]CodeClimateIssue, 0, len(issues))
 
 	for i := range issues {
@@ -41,11 +42,16 @@ func (p CodeClimate) Print(issues []result.Issue) error {
 		codeClimateIssue.Location.Path = issue.Pos.Filename
 		codeClimateIssue.Location.Lines.Begin = issue.Pos.Line
 		codeClimateIssue.Fingerprint = issue.Fingerprint()
-		codeClimateIssue.Severity = p.sanitizer.Clean(issue.Severity)
+		codeClimateIssue.Severity = p.sanitizer.Sanitize(issue.Severity)
 
 		codeClimateIssues = append(codeClimateIssues, codeClimateIssue)
 	}
 
+	err := p.sanitizer.Err()
+	if err != nil {
+		p.log.Infof("%v", err)
+	}
+
 	return json.NewEncoder(p.w).Encode(codeClimateIssues)
 }
 

pkg/printers/printer.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 	"slices"
+	"strings"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/logutils"
@@ -142,18 +143,36 @@ func (c *Printer) createPrinter(format string, w io.Writer) (issuePrinter, error
 }
 
 type severitySanitizer struct {
-	log logutils.Log
-
 	allowedSeverities []string
 	defaultSeverity   string
+
+	unsupportedSeverities map[string]struct{}
 }
 
-func (s *severitySanitizer) Clean(severity string) string {
+func (s *severitySanitizer) Sanitize(severity string) string {
 	if slices.Contains(s.allowedSeverities, severity) {
 		return severity
 	}
 
-	s.log.Infof("severity '%s' is not inside %v, fallback to '%s'", severity, s.allowedSeverities, s.defaultSeverity)
+	if s.unsupportedSeverities == nil {
+		s.unsupportedSeverities = make(map[string]struct{})
+	}
+
+	s.unsupportedSeverities[severity] = struct{}{}
 
 	return s.defaultSeverity
 }
+
+func (s *severitySanitizer) Err() error {
+	if len(s.unsupportedSeverities) == 0 {
+		return nil
+	}
+
+	var foo []string
+	for k := range s.unsupportedSeverities {
+		foo = append(foo, "'"+k+"'")
+	}
+
+	return fmt.Errorf("some severities (%v) are not inside supported values (%v), fallback to '%s'",
+		strings.Join(foo, ", "), strings.Join(s.allowedSeverities, ", "), s.defaultSeverity)
+}

pkg/printers/sarif.go

@@ -19,23 +19,24 @@ const defaultSarifSeverity = "error"
 // https://sarifweb.azurewebsites.net/
 // https://docs.oasis-open.org/sarif/sarif/v2.1.0/
 type Sarif struct {
+	log       logutils.Log
 	w         io.Writer
 	sanitizer severitySanitizer
 }
 
 func NewSarif(log logutils.Log, w io.Writer) *Sarif {
 	return &Sarif{
-		w: w,
+		log: log.Child(logutils.DebugKeySarifPrinter),
+		w:   w,
 		sanitizer: severitySanitizer{
-			log: log.Child(logutils.DebugKeySarifPrinter),
 			// https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790898
 			allowedSeverities: []string{"none", "note", "warning", defaultSarifSeverity},
 			defaultSeverity:   defaultSarifSeverity,
 		},
 	}
 }
 
-func (p Sarif) Print(issues []result.Issue) error {
+func (p *Sarif) Print(issues []result.Issue) error {
 	run := sarifRun{}
 	run.Tool.Driver.Name = "golangci-lint"
 	run.Results = make([]sarifResult, 0)
@@ -45,7 +46,7 @@ func (p Sarif) Print(issues []result.Issue) error {
 
 		sr := sarifResult{
 			RuleID:  issue.FromLinter,
-			Level:   p.sanitizer.Clean(issue.Severity),
+			Level:   p.sanitizer.Sanitize(issue.Severity),
 			Message: sarifMessage{Text: issue.Text},
 			Locations: []sarifLocation{
 				{
@@ -65,6 +66,11 @@ func (p Sarif) Print(issues []result.Issue) error {
 		run.Results = append(run.Results, sr)
 	}
 
+	err := p.sanitizer.Err()
+	if err != nil {
+		p.log.Infof("%v", err)
+	}
+
 	output := SarifOutput{
 		Version: sarifVersion,
 		Schema:  sarifSchemaURI,

pkg/printers/teamcity.go

@@ -20,6 +20,7 @@ const defaultTeamCitySeverity = "ERROR"
 // TeamCity prints issues in the TeamCity format.
 // https://www.jetbrains.com/help/teamcity/service-messages.html
 type TeamCity struct {
+	log       logutils.Log
 	w         io.Writer
 	escaper   *strings.Replacer
 	sanitizer severitySanitizer
@@ -28,7 +29,8 @@ type TeamCity struct {
 // NewTeamCity output format outputs issues according to TeamCity service message format.
 func NewTeamCity(log logutils.Log, w io.Writer) *TeamCity {
 	return &TeamCity{
-		w: w,
+		log: log.Child(logutils.DebugKeyTeamCityPrinter),
+		w:   w,
 		// https://www.jetbrains.com/help/teamcity/service-messages.html#Escaped+Values
 		escaper: strings.NewReplacer(
 			"'", "|'",
@@ -39,7 +41,6 @@ func NewTeamCity(log logutils.Log, w io.Writer) *TeamCity {
 			"]", "|]",
 		),
 		sanitizer: severitySanitizer{
-			log: log.Child(logutils.DebugKeyTeamCityPrinter),
 			// https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance
 			allowedSeverities: []string{"INFO", defaultTeamCitySeverity, "WARNING", "WEAK WARNING"},
 			defaultSeverity:   defaultTeamCitySeverity,
@@ -75,7 +76,7 @@ func (p *TeamCity) Print(issues []result.Issue) error {
 			message:  issue.Text,
 			file:     issue.FilePath(),
 			line:     issue.Line(),
-			severity: p.sanitizer.Clean(strings.ToUpper(issue.Severity)),
+			severity: p.sanitizer.Sanitize(strings.ToUpper(issue.Severity)),
 		}
 
 		_, err := instance.Print(p.w, p.escaper)
@@ -84,6 +85,11 @@ func (p *TeamCity) Print(issues []result.Issue) error {
 		}
 	}
 
+	err := p.sanitizer.Err()
+	if err != nil {
+		p.log.Infof("%v", err)
+	}
+
 	return nil
 }