review

Author: ldez

pkg/lint/runner.go

@@ -79,10 +79,10 @@ func NewRunner(log logutils.Log, cfg *config.Config, args []string, goenv *gouti
 			// Must be after FilenameUnadjuster.
 			processors.NewInvalidIssue(log.Child(logutils.DebugKeyInvalidIssue)),
 
-			// Must be before Diff, SkipFiles, SkipDirs,  ExcludeRules processors at least.
+			// Must be before Diff, SkipFiles, SkipDirs, ExcludeRules processors at least.
 			processors.NewPathPrettifier(log),
 
-			// must be after path prettifier
+			// must be after PathPrettifier.
 			skipFilesProcessor,
 			skipDirsProcessor,
 

pkg/result/processors/autogenerated_exclude.go

@@ -40,9 +40,9 @@ type fileSummary struct {
 }
 
 // AutogeneratedExclude filters generated files.
-// - mode "lax": see [isGeneratedFileLax] documentation.
-// - mode "strict": see [isGeneratedFileStrict] documentation.
-// - mode "disable": skips this processor.
+//   - mode "lax": see `isGeneratedFileLax` documentation.
+//   - mode "strict": see `isGeneratedFileStrict` documentation.
+//   - mode "disable": skips this processor.
 type AutogeneratedExclude struct {
 	debugf logutils.DebugFunc
 

pkg/result/processors/diff.go

@@ -21,7 +21,7 @@ var _ Processor = (*Diff)(nil)
 // Diff filters issues based on options `new`, `new-from-rev`, etc.
 //
 // Uses `git`.
-// The paths inside the patch are relative to the path where git/golangci-lint is run.
+// The paths inside the patch are relative to the path where git is run (the same location where golangci-lint is run).
 //
 // Warning: it doesn't use `path-prefix` option.
 type Diff struct {

pkg/result/processors/exclude_rules.go

@@ -16,10 +16,10 @@ type excludeRule struct {
 }
 
 // ExcludeRules filters reports based on multiple criteria:
-// - linter names (string)
-// - file path (regular expressions)
-// - text (regular expressions)
-// - code source (regular expressions)
+//   - linter names (string)
+//   - file path (regular expressions)
+//   - text (regular expressions)
+//   - code source (regular expressions)
 //
 // It uses the shortest relative paths and `path-prefix` option.
 type ExcludeRules struct {

pkg/result/processors/invalid_issue.go

@@ -10,8 +10,8 @@ import (
 var _ Processor = (*InvalidIssue)(nil)
 
 // InvalidIssue filters invalid reports.
-// - non-go files (except `go.mod`)
-// - reports without file path
+//   - non-go files (except `go.mod`)
+//   - reports without file path
 type InvalidIssue struct {
 	log logutils.Log
 }

pkg/result/processors/severity.go

@@ -20,7 +20,7 @@ type severityRule struct {
 }
 
 // Severity modifies report severity.
-// It uses the same [baseRule] structure as [ExcludeRules] processor.
+// It uses the same `baseRule` structure as [ExcludeRules] processor.
 //
 // Warning: it doesn't use `path-prefix` option.
 type Severity struct {

pkg/result/processors/sort_results.go

@@ -10,11 +10,6 @@ import (
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
-// Base propose of this functionality to sort results (issues)
-// produced by various linters by analyzing code. We're achieving this
-// by sorting results.Issues using processor step, and chain based
-// rules that can compare different properties of the Issues struct.
-
 const (
 	orderNameFile     = "file"
 	orderNameLinter   = "linter"
@@ -32,9 +27,9 @@ var _ Processor = (*SortResults)(nil)
 type issueComparator func(a, b *result.Issue) int
 
 // SortResults sorts reports based on criteria:
-// - file names, line numbers, positions
-// - linter names
-// - severity names
+//   - file names, line numbers, positions
+//   - linter names
+//   - severity names
 type SortResults struct {
 	cmps map[string][]issueComparator
 

pkg/result/processors/source_code.go

@@ -11,8 +11,8 @@ var _ Processor = (*SourceCode)(nil)
 // SourceCode modifies displayed information based on [result.Issue.GetLineRange()].
 //
 // This is used:
-// - to display the "UnderLinePointer".
-// - in some rare cases to display multiple lines instead of one (ex: `dupl`)
+//   - to display the "UnderLinePointer".
+//   - in some rare cases to display multiple lines instead of one (ex: `dupl`)
 //
 // It requires to use [fsutils.LineCache] ([fsutils.FileCache]) to get the file information before the fixes.
 type SourceCode struct {