docs: add godoc for all processors

Author: ldez

pkg/result/processors/autogenerated_exclude.go

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

pkg/result/processors/cgo.go

@@ -10,10 +10,11 @@ import (
 
 var _ Processor = (*Cgo)(nil)
 
-// Cgo some linters (e.g. gosec, deadcode) return incorrect filepaths for cgo issues,
-// also cgo files have strange issues looking like false positives.
+// Cgo filters cgo artifacts.
 //
-// Require absolute filepath.
+// Some linters (e.g. gosec, etc.) return incorrect file paths for cgo files.
+//
+// Require absolute file path.
 type Cgo struct {
 	goCacheDir string
 }

pkg/result/processors/diff.go

@@ -18,6 +18,12 @@ const envGolangciDiffProcessorPatch = "GOLANGCI_DIFF_PROCESSOR_PATCH"
 
 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.
+//
+// Warning: it doesn't use `path-prefix` option.
 type Diff struct {
 	onlyNew       bool
 	fromRev       string

pkg/result/processors/exclude.go

@@ -11,6 +11,7 @@ import (
 
 var _ Processor = (*Exclude)(nil)
 
+// Exclude filters reports only based on regular expressions applied to the report text.
 type Exclude struct {
 	name string
 

pkg/result/processors/exclude_rules.go

@@ -15,6 +15,13 @@ type excludeRule struct {
 	baseRule
 }
 
+// ExcludeRules filters reports based on multiple criteria:
+// 	- 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 {
 	name string
 

pkg/result/processors/filename_unadjuster.go

@@ -22,11 +22,13 @@ type adjustMap struct {
 	m map[string]posMapper
 }
 
-// FilenameUnadjuster is needed because a lot of linters use `fset.Position(f.Pos())` to get filename.
-// And they return adjusted filename (e.g.` *.qtpl`) for an issue.
+// FilenameUnadjuster fixes filename based on adjusted and unadjusted position (related to line directives and cgo).
+//
+// A lot of linters use `fset.Position(f.Pos())` to get filename,
+// and they return adjusted filename (e.g.` *.qtpl`) for an issue.
 // We need restore real `.go` filename to properly output it, parse it, etc.
 //
-// Require absolute filepath.
+// Require absolute file path.
 type FilenameUnadjuster struct {
 	m                   map[string]posMapper // map from adjusted filename to position mapper: adjusted -> unadjusted position
 	log                 logutils.Log

pkg/result/processors/fixer.go

@@ -31,6 +31,8 @@ var _ Processor = (*Fixer)(nil)
 
 const filePerm = 0644
 
+// Fixer fixes reports if possible.
+// The reports that are not fixed are passed to the next processor.
 type Fixer struct {
 	cfg       *config.Config
 	log       logutils.Log

pkg/result/processors/identifier_marker.go

@@ -13,6 +13,9 @@ type replacePattern struct {
 	repl string
 }
 
+// IdentifierMarker modifies report text.
+// It must be before [Exclude] and [ExcludeRules]:
+// users configure exclusions based on the modified text.
 type IdentifierMarker struct {
 	patterns map[string][]replacePattern
 }

pkg/result/processors/invalid_issue.go

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

pkg/result/processors/max_from_linter.go

@@ -8,6 +8,7 @@ import (
 
 var _ Processor = (*MaxFromLinter)(nil)
 
+// MaxFromLinter limits the number of reports from the same linter.
 type MaxFromLinter struct {
 	linterCounter map[string]int
 	limit         int