feat: formatters configuration structures

Author: ldez

pkg/config/config.go

@@ -29,6 +29,8 @@ type Config struct {
 	Issues          Issues          `mapstructure:"issues"`
 	Severity        Severity        `mapstructure:"severity"`
 
+	Formatters Formatters `mapstructure:"formatters"`
+
 	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
 }
@@ -64,6 +66,9 @@ func (c *Config) Validate() error {
 func NewDefault() *Config {
 	return &Config{
 		LintersSettings: defaultLintersSettings,
+		Formatters: Formatters{
+			Settings: defaultFormatterSettings,
+		},
 	}
 }
 

pkg/config/formatters.go

@@ -0,0 +1,12 @@
+package config
+
+type Formatters struct {
+	Enable     []string            `mapstructure:"enable"`
+	Settings   FormatterSettings   `mapstructure:"settings"`
+	Exclusions FormatterExclusions `mapstructure:"exclusions"`
+}
+
+type FormatterExclusions struct {
+	Generated string   `mapstructure:"generated"`
+	Paths     []string `mapstructure:"paths"`
+}

pkg/config/formatters_settings.go

@@ -0,0 +1,52 @@
+package config
+
+var defaultFormatterSettings = FormatterSettings{
+	GoFmt: GoFmtSettings{
+		Simplify: true,
+	},
+	Gci: GciSettings{
+		Sections:      []string{"standard", "default"},
+		SkipGenerated: true,
+	},
+}
+
+type FormatterSettings struct {
+	Gci       GciSettings       `mapstructure:"gci"`
+	GoFmt     GoFmtSettings     `mapstructure:"gofmt"`
+	GoFumpt   GoFumptSettings   `mapstructure:"gofumpt"`
+	GoImports GoImportsSettings `mapstructure:"goimports"`
+}
+
+type GciSettings struct {
+	Sections         []string `mapstructure:"sections"`
+	NoInlineComments bool     `mapstructure:"no-inline-comments"`
+	NoPrefixComments bool     `mapstructure:"no-prefix-comments"`
+	SkipGenerated    bool     `mapstructure:"skip-generated"`
+	CustomOrder      bool     `mapstructure:"custom-order"`
+	NoLexOrder       bool     `mapstructure:"no-lex-order"`
+
+	// Deprecated: use Sections instead.
+	LocalPrefixes string `mapstructure:"local-prefixes"`
+}
+
+type GoFmtSettings struct {
+	Simplify     bool
+	RewriteRules []GoFmtRewriteRule `mapstructure:"rewrite-rules"`
+}
+
+type GoFmtRewriteRule struct {
+	Pattern     string
+	Replacement string
+}
+
+type GoFumptSettings struct {
+	ModulePath string `mapstructure:"module-path"`
+	ExtraRules bool   `mapstructure:"extra-rules"`
+
+	// Deprecated: use the global `run.go` instead.
+	LangVersion string `mapstructure:"lang-version"`
+}
+
+type GoImportsSettings struct {
+	LocalPrefixes string `mapstructure:"local-prefixes"`
+}

pkg/config/linters_settings.go

@@ -77,7 +77,7 @@ var defaultLintersSettings = LintersSettings{
 	Gofmt: GoFmtSettings{
 		Simplify: true,
 	},
-	Gofumpt: GofumptSettings{
+	Gofumpt: GoFumptSettings{
 		LangVersion: "",
 		ModulePath:  "",
 		ExtraRules:  false,
@@ -236,7 +236,7 @@ type LintersSettings struct {
 	Godot           GodotSettings
 	Godox           GodoxSettings
 	Gofmt           GoFmtSettings
-	Gofumpt         GofumptSettings
+	Gofumpt         GoFumptSettings
 	Goheader        GoHeaderSettings
 	Goimports       GoImportsSettings
 	GoModDirectives GoModDirectivesSettings
@@ -483,18 +483,6 @@ type FunlenSettings struct {
 	IgnoreComments bool `mapstructure:"ignore-comments"`
 }
 
-type GciSettings struct {
-	Sections         []string `mapstructure:"sections"`
-	NoInlineComments bool     `mapstructure:"no-inline-comments"`
-	NoPrefixComments bool     `mapstructure:"no-prefix-comments"`
-	SkipGenerated    bool     `mapstructure:"skip-generated"`
-	CustomOrder      bool     `mapstructure:"custom-order"`
-	NoLexOrder       bool     `mapstructure:"no-lex-order"`
-
-	// Deprecated: use Sections instead.
-	LocalPrefixes string `mapstructure:"local-prefixes"`
-}
-
 type GinkgoLinterSettings struct {
 	SuppressLenAssertion       bool `mapstructure:"suppress-len-assertion"`
 	SuppressNilAssertion       bool `mapstructure:"suppress-nil-assertion"`
@@ -562,34 +550,12 @@ type GodoxSettings struct {
 	Keywords []string
 }
 
-type GoFmtSettings struct {
-	Simplify     bool
-	RewriteRules []GoFmtRewriteRule `mapstructure:"rewrite-rules"`
-}
-
-type GoFmtRewriteRule struct {
-	Pattern     string
-	Replacement string
-}
-
-type GofumptSettings struct {
-	ModulePath string `mapstructure:"module-path"`
-	ExtraRules bool   `mapstructure:"extra-rules"`
-
-	// Deprecated: use the global `run.go` instead.
-	LangVersion string `mapstructure:"lang-version"`
-}
-
 type GoHeaderSettings struct {
 	Values       map[string]map[string]string `mapstructure:"values"`
 	Template     string                       `mapstructure:"template"`
 	TemplatePath string                       `mapstructure:"template-path"`
 }
 
-type GoImportsSettings struct {
-	LocalPrefixes string `mapstructure:"local-prefixes"`
-}
-
 type GoModDirectivesSettings struct {
 	ReplaceAllowList          []string `mapstructure:"replace-allow-list"`
 	ReplaceLocal              bool     `mapstructure:"replace-local"`

pkg/config/loader.go

@@ -321,6 +321,8 @@ func (l *Loader) handleGoVersion() {
 
 	l.cfg.LintersSettings.Gofumpt.LangVersion = cmp.Or(l.cfg.LintersSettings.Gofumpt.LangVersion, l.cfg.Run.Go)
 
+	l.cfg.Formatters.Settings.GoFumpt.LangVersion = cmp.Or(l.cfg.Formatters.Settings.GoFumpt.LangVersion, l.cfg.Run.Go)
+
 	trimmedGoVersion := goutil.TrimGoVersion(l.cfg.Run.Go)
 
 	l.cfg.LintersSettings.Revive.Go = trimmedGoVersion

pkg/goformatters/gofumpt/gofumpt.go

@@ -14,7 +14,7 @@ type Formatter struct {
 	options gofumpt.Options
 }
 
-func New(settings *config.GofumptSettings, goVersion string) *Formatter {
+func New(settings *config.GoFumptSettings, goVersion string) *Formatter {
 	var options gofumpt.Options
 
 	if settings != nil {

pkg/golinters/gofumpt/gofumpt.go

@@ -12,7 +12,7 @@ import (
 
 const linterName = "gofumpt"
 
-func New(settings *config.GofumptSettings) *goanalysis.Linter {
+func New(settings *config.GoFumptSettings) *goanalysis.Linter {
 	a := goformatters.NewAnalyzer(
 		internal.LinterLogger.Child(linterName),
 		"Checks if code and import statements are formatted, with additional rules.",