chore: annotate and re-organize configuration structures

Author: ldez

pkg/config/config.go

@@ -12,18 +12,18 @@ import (
 type Config struct {
 	cfgDir string // The directory containing the golangci-lint config file.
 
-	Run Run
+	Run Run `mapstructure:"run"`
 
-	Output Output
+	Output Output `mapstructure:"output"`
 
 	LintersSettings LintersSettings `mapstructure:"linters-settings"`
-	Linters         Linters
-	Issues          Issues
-	Severity        Severity
+	Linters         Linters         `mapstructure:"linters"`
+	Issues          Issues          `mapstructure:"issues"`
+	Severity        Severity        `mapstructure:"severity"`
 
-	Version Version
+	Version Version // Flag only. // TODO(ldez) only used by the version command.
 
-	InternalCmdTest bool `mapstructure:"internal-cmd-test"` // Option is used only for testing golangci-lint command, don't use it
+	InternalCmdTest bool // Option is used only for testing golangci-lint command, don't use it
 	InternalTest    bool // Option is used only for testing golangci-lint code, don't use it
 }
 

pkg/config/output.go

@@ -28,7 +28,7 @@ var OutFormats = []string{
 }
 
 type Output struct {
-	Format              string
+	Format              string `mapstructure:"format"`
 	PrintIssuedLine     bool   `mapstructure:"print-issued-lines"`
 	PrintLinterName     bool   `mapstructure:"print-linter-name"`
 	UniqByLine          bool   `mapstructure:"uniq-by-line"`
@@ -37,5 +37,5 @@ type Output struct {
 	PathPrefix          string `mapstructure:"path-prefix"`
 
 	// only work with CLI flags because the setup of logs is done before the config file parsing.
-	Color string
+	Color string // Flag only.
 }

pkg/config/run.go

@@ -4,18 +4,9 @@ import "time"
 
 // Run encapsulates the config options for running the linter analysis.
 type Run struct {
-	IsVerbose           bool `mapstructure:"verbose"`
-	Silent              bool
-	CPUProfilePath      string
-	MemProfilePath      string
-	TracePath           string
-	Concurrency         int
-	PrintResourcesUsage bool `mapstructure:"print-resources-usage"`
+	Timeout time.Duration `mapstructure:"timeout"`
 
-	Config   string // The path to the golangci config file, as specified with the --config argument.
-	NoConfig bool
-
-	Args []string
+	Concurrency int `mapstructure:"concurrency"`
 
 	Go string `mapstructure:"go"`
 
@@ -25,9 +16,6 @@ type Run struct {
 	ExitCodeIfIssuesFound int  `mapstructure:"issues-exit-code"`
 	AnalyzeTests          bool `mapstructure:"tests"`
 
-	Timeout time.Duration
-
-	PrintVersion       bool
 	SkipFiles          []string `mapstructure:"skip-files"`
 	SkipDirs           []string `mapstructure:"skip-dirs"`
 	UseDefaultSkipDirs bool     `mapstructure:"skip-dirs-use-default"`
@@ -36,4 +24,21 @@ type Run struct {
 	AllowSerialRunners   bool `mapstructure:"allow-serial-runners"`
 
 	ShowStats bool `mapstructure:"show-stats"`
+
+	// --- Flags only section.
+
+	IsVerbose bool `mapstructure:"verbose"` // Flag only
+
+	PrintVersion bool // Flag only. (used by the root command)
+
+	CPUProfilePath string // Flag only.
+	MemProfilePath string // Flag only.
+	TracePath      string // Flag only.
+
+	PrintResourcesUsage bool `mapstructure:"print-resources-usage"` // Flag only. // TODO(ldez) need to be enforced.
+
+	Config   string // Flag only. The path to the golangci config file, as specified with the --config argument.
+	NoConfig bool   // Flag only.
+
+	Args []string // Flag only. // TODO(ldez) identify the real need and usage.
 }