dev: clean up (#4495)

Author: ldez

pkg/config/output.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"slices"
+	"strings"
 )
 
 const (
@@ -49,8 +50,16 @@ func (o *Output) Validate() error {
 		return errors.New("sort-results should be 'true' to use sort-order")
 	}
 
+	validOrders := []string{"linter", "file", "severity"}
+
+	all := strings.Join(o.SortOrder, " ")
+
 	for _, order := range o.SortOrder {
-		if !slices.Contains([]string{"linter", "file", "severity"}, order) {
+		if strings.Count(all, order) > 1 {
+			return fmt.Errorf("the sort-order name %q is repeated several times", order)
+		}
+
+		if !slices.Contains(validOrders, order) {
 			return fmt.Errorf("unsupported sort-order name %q", order)
 		}
 	}

pkg/config/output_test.go

@@ -32,6 +32,13 @@ func TestOutput_Validate(t *testing.T) {
 				SortOrder:   []string{"severity"},
 			},
 		},
+		{
+			desc: "multiple",
+			settings: &Output{
+				SortResults: true,
+				SortOrder:   []string{"file", "linter", "severity"},
+			},
+		},
 	}
 
 	for _, test := range testCases {
@@ -66,6 +73,14 @@ func TestOutput_Validate_error(t *testing.T) {
 			},
 			expected: `unsupported sort-order name "a"`,
 		},
+		{
+			desc: "duplicate",
+			settings: &Output{
+				SortResults: true,
+				SortOrder:   []string{"file", "linter", "severity", "linter"},
+			},
+			expected: `the sort-order name "linter" is repeated several times`,
+		},
 	}
 
 	for _, test := range testCases {

pkg/result/processors/sort_results.go

@@ -17,9 +17,9 @@ import (
 // rules that can compare different properties of the Issues struct.
 
 const (
-	fileOrderName      = "file"
-	linterOrderName    = "linter"
-	linterSeverityName = "severity"
+	orderNameFile     = "file"
+	orderNameLinter   = "linter"
+	orderNameSeverity = "severity"
 )
 
 var _ Processor = (*SortResults)(nil)
@@ -35,11 +35,11 @@ func NewSortResults(cfg *config.Config) *SortResults {
 		cmps: map[string][]comparator{
 			// For sorting we are comparing (in next order):
 			// file names, line numbers, position, and finally - giving up.
-			fileOrderName: {&byName{}, &byLine{}, &byColumn{}},
+			orderNameFile: {&byFileName{}, &byLine{}, &byColumn{}},
 			// For sorting we are comparing: linter name
-			linterOrderName: {&byLinter{}},
+			orderNameLinter: {&byLinter{}},
 			// For sorting we are comparing: severity
-			linterSeverityName: {&bySeverity{}},
+			orderNameSeverity: {&bySeverity{}},
 		},
 		cfg: &cfg.Output,
 	}
@@ -52,7 +52,7 @@ func (sr SortResults) Process(issues []result.Issue) ([]result.Issue, error) {
 	}
 
 	if len(sr.cfg.SortOrder) == 0 {
-		sr.cfg.SortOrder = []string{fileOrderName}
+		sr.cfg.SortOrder = []string{orderNameFile}
 	}
 
 	var cmps []comparator
@@ -64,13 +64,13 @@ func (sr SortResults) Process(issues []result.Issue) ([]result.Issue, error) {
 		}
 	}
 
-	cmp, err := mergeComparator(cmps)
+	cmp, err := mergeComparators(cmps)
 	if err != nil {
 		return nil, err
 	}
 
 	sort.Slice(issues, func(i, j int) bool {
-		return cmp.Compare(&issues[i], &issues[j]) == Less
+		return cmp.Compare(&issues[i], &issues[j]) == less
 	})
 
 	return issues, nil
@@ -83,31 +83,31 @@ func (sr SortResults) Finish() {}
 type compareResult int
 
 const (
-	Less compareResult = iota - 1
-	Equal
-	Greater
-	None
+	less compareResult = iota - 1
+	equal
+	greater
+	none
 )
 
 func (c compareResult) isNeutral() bool {
 	// return true if compare result is incomparable or equal.
-	return c == None || c == Equal
+	return c == none || c == equal
 }
 
 func (c compareResult) String() string {
 	switch c {
-	case Less:
-		return "Less"
-	case Equal:
-		return "Equal"
-	case Greater:
-		return "Greater"
+	case less:
+		return "less"
+	case equal:
+		return "equal"
+	case greater:
+		return "greater"
 	default:
-		return "None"
+		return "none"
 	}
 }
 
-// comparator describe how to implement compare for two "issues" lexicographically
+// comparator describes how to implement compare for two "issues".
 type comparator interface {
 	Compare(a, b *result.Issue) compareResult
 	Next() comparator
@@ -116,26 +116,25 @@ type comparator interface {
 }
 
 var (
-	_ comparator = (*byName)(nil)
+	_ comparator = (*byFileName)(nil)
 	_ comparator = (*byLine)(nil)
 	_ comparator = (*byColumn)(nil)
 	_ comparator = (*byLinter)(nil)
 	_ comparator = (*bySeverity)(nil)
 )
 
-type byName struct{ next comparator }
+type byFileName struct{ next comparator }
 
-func (cmp *byName) Next() comparator { return cmp.next }
+func (cmp *byFileName) Next() comparator { return cmp.next }
 
-func (cmp *byName) AddNext(c comparator) comparator {
+func (cmp *byFileName) AddNext(c comparator) comparator {
 	cmp.next = c
 	return cmp
 }
 
-func (cmp *byName) Compare(a, b *result.Issue) compareResult {
-	var res compareResult
-
-	if res = compareResult(strings.Compare(a.FilePath(), b.FilePath())); !res.isNeutral() {
+func (cmp *byFileName) Compare(a, b *result.Issue) compareResult {
+	res := compareResult(strings.Compare(a.FilePath(), b.FilePath()))
+	if !res.isNeutral() {
 		return res
 	}
 
@@ -146,8 +145,8 @@ func (cmp *byName) Compare(a, b *result.Issue) compareResult {
 	return res
 }
 
-func (cmp *byName) String() string {
-	return comparatorToString("byName", cmp)
+func (cmp *byFileName) String() string {
+	return comparatorToString("byFileName", cmp)
 }
 
 type byLine struct{ next comparator }
@@ -160,9 +159,8 @@ func (cmp *byLine) AddNext(c comparator) comparator {
 }
 
 func (cmp *byLine) Compare(a, b *result.Issue) compareResult {
-	var res compareResult
-
-	if res = numericCompare(a.Line(), b.Line()); !res.isNeutral() {
+	res := numericCompare(a.Line(), b.Line())
+	if !res.isNeutral() {
 		return res
 	}
 
@@ -187,9 +185,8 @@ func (cmp *byColumn) AddNext(c comparator) comparator {
 }
 
 func (cmp *byColumn) Compare(a, b *result.Issue) compareResult {
-	var res compareResult
-
-	if res = numericCompare(a.Column(), b.Column()); !res.isNeutral() {
+	res := numericCompare(a.Column(), b.Column())
+	if !res.isNeutral() {
 		return res
 	}
 
@@ -214,9 +211,8 @@ func (cmp *byLinter) AddNext(c comparator) comparator {
 }
 
 func (cmp *byLinter) Compare(a, b *result.Issue) compareResult {
-	var res compareResult
-
-	if res = compareResult(strings.Compare(a.FromLinter, b.FromLinter)); !res.isNeutral() {
+	res := compareResult(strings.Compare(a.FromLinter, b.FromLinter))
+	if !res.isNeutral() {
 		return res
 	}
 
@@ -241,9 +237,8 @@ func (cmp *bySeverity) AddNext(c comparator) comparator {
 }
 
 func (cmp *bySeverity) Compare(a, b *result.Issue) compareResult {
-	var res compareResult
-
-	if res = severityCompare(a.Severity, b.Severity); !res.isNeutral() {
+	res := severityCompare(a.Severity, b.Severity)
+	if !res.isNeutral() {
 		return res
 	}
 
@@ -258,7 +253,7 @@ func (cmp *bySeverity) String() string {
 	return comparatorToString("bySeverity", cmp)
 }
 
-func mergeComparator(cmps []comparator) (comparator, error) {
+func mergeComparators(cmps []comparator) (comparator, error) {
 	if len(cmps) == 0 {
 		return nil, errors.New("no comparator")
 	}
@@ -277,14 +272,22 @@ func severityCompare(a, b string) compareResult {
 	if slices.Contains(classic, a) && slices.Contains(classic, b) {
 		switch {
 		case slices.Index(classic, a) > slices.Index(classic, b):
-			return Greater
+			return greater
 		case slices.Index(classic, a) < slices.Index(classic, b):
-			return Less
+			return less
 		default:
-			return Equal
+			return equal
 		}
 	}
 
+	if slices.Contains(classic, a) {
+		return greater
+	}
+
+	if slices.Contains(classic, b) {
+		return less
+	}
+
 	return compareResult(strings.Compare(a, b))
 }
 
@@ -299,16 +302,16 @@ func numericCompare(a, b int) compareResult {
 
 	switch {
 	case isZeroValuesBoth || isEqual:
-		return Equal
+		return equal
 	case isValuesInvalid || isZeroValueInA || isZeroValueInB:
-		return None
+		return none
 	case a > b:
-		return Greater
+		return greater
 	case a < b:
-		return Less
+		return less
 	}
 
-	return Equal
+	return equal
 }
 
 func comparatorToString(name string, c comparator) string {