refactor: use isolate MetaFormatter from linters

Author: ldez

pkg/config/linters_settings.go

@@ -10,6 +10,8 @@ import (
 )
 
 var defaultLintersSettings = LintersSettings{
+	FormatterSettings: defaultFormatterSettings,
+
 	Asasalint: AsasalintSettings{
 		UseBuiltinExclusions: true,
 	},
@@ -43,10 +45,6 @@ var defaultLintersSettings = LintersSettings{
 	Forbidigo: ForbidigoSettings{
 		ExcludeGodocExamples: true,
 	},
-	Gci: GciSettings{
-		Sections:      []string{"standard", "default"},
-		SkipGenerated: true,
-	},
 	GoChecksumType: GoChecksumTypeSettings{
 		DefaultSignifiesExhaustive: true,
 	},
@@ -74,14 +72,6 @@ var defaultLintersSettings = LintersSettings{
 		Scope:  "declarations",
 		Period: true,
 	},
-	Gofmt: GoFmtSettings{
-		Simplify: true,
-	},
-	Gofumpt: GoFumptSettings{
-		LangVersion: "",
-		ModulePath:  "",
-		ExtraRules:  false,
-	},
 	Gosec: GoSecSettings{
 		Concurrency: runtime.NumCPU(),
 	},
@@ -209,6 +199,8 @@ var defaultLintersSettings = LintersSettings{
 }
 
 type LintersSettings struct {
+	FormatterSettings `mapstructure:",squash"`
+
 	Asasalint       AsasalintSettings
 	BiDiChk         BiDiChkSettings
 	CopyLoopVar     CopyLoopVarSettings
@@ -226,7 +218,6 @@ type LintersSettings struct {
 	Fatcontext      FatcontextSettings
 	Forbidigo       ForbidigoSettings
 	Funlen          FunlenSettings
-	Gci             GciSettings
 	GinkgoLinter    GinkgoLinterSettings
 	Gocognit        GocognitSettings
 	GoChecksumType  GoChecksumTypeSettings
@@ -235,10 +226,7 @@ type LintersSettings struct {
 	Gocyclo         GoCycloSettings
 	Godot           GodotSettings
 	Godox           GodoxSettings
-	Gofmt           GoFmtSettings
-	Gofumpt         GoFumptSettings
 	Goheader        GoHeaderSettings
-	Goimports       GoImportsSettings
 	GoModDirectives GoModDirectivesSettings
 	Gomodguard      GoModGuardSettings
 	Gosec           GoSecSettings

pkg/config/loader.go

@@ -319,8 +319,7 @@ func (l *Loader) handleGoVersion() {
 
 	l.cfg.LintersSettings.ParallelTest.Go = l.cfg.Run.Go
 
-	l.cfg.LintersSettings.Gofumpt.LangVersion = cmp.Or(l.cfg.LintersSettings.Gofumpt.LangVersion, l.cfg.Run.Go)
-
+	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)
@@ -428,16 +427,22 @@ func (l *Loader) handleLinterOptionDeprecations() {
 	if l.cfg.LintersSettings.Gci.LocalPrefixes != "" {
 		l.log.Warnf("The configuration option `linters.gci.local-prefixes` is deprecated, please use `prefix()` inside `linters.gci.sections`.")
 	}
+	if l.cfg.Formatters.Settings.Gci.LocalPrefixes != "" {
+		l.log.Warnf("The configuration option `formatters.settings.gci.local-prefixes` is deprecated, please use `prefix()` inside `formatters.settings.gci.sections`.")
+	}
 
 	// Deprecated since v1.33.0.
 	if l.cfg.LintersSettings.Godot.CheckAll != nil {
 		l.log.Warnf("The configuration option `linters.godot.check-all` is deprecated, please use `linters.godot.scope: all`.")
 	}
 
 	// Deprecated since v1.47.0
-	if l.cfg.LintersSettings.Gofumpt.LangVersion != "" {
+	if l.cfg.LintersSettings.GoFumpt.LangVersion != "" {
 		l.log.Warnf("The configuration option `linters.gofumpt.lang-version` is deprecated, please use global `run.go`.")
 	}
+	if l.cfg.Formatters.Settings.GoFumpt.LangVersion != "" {
+		l.log.Warnf("The configuration option `formatters.settings.gofumpt.lang-version` is deprecated, please use global `run.go`.")
+	}
 
 	// Deprecated since v1.47.0
 	if l.cfg.LintersSettings.Staticcheck.GoVersion != "" {

pkg/goformatters/meta_formatter.go

@@ -4,13 +4,13 @@ import (
 	"bytes"
 	"fmt"
 	"go/format"
+	"slices"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/goformatters/gci"
 	"github.com/golangci/golangci-lint/pkg/goformatters/gofmt"
 	"github.com/golangci/golangci-lint/pkg/goformatters/gofumpt"
 	"github.com/golangci/golangci-lint/pkg/goformatters/goimports"
-	"github.com/golangci/golangci-lint/pkg/lint/linter"
 	"github.com/golangci/golangci-lint/pkg/logutils"
 )
 
@@ -19,24 +19,30 @@ type MetaFormatter struct {
 	formatters []Formatter
 }
 
-func NewMetaFormatter(log logutils.Log, cfg *config.Config, enabledLinters map[string]*linter.Config) (*MetaFormatter, error) {
+func NewMetaFormatter(log logutils.Log, cfg *config.Formatters, runCfg *config.Run) (*MetaFormatter, error) {
+	for _, formatter := range cfg.Enable {
+		if !IsFormatter(formatter) {
+			return nil, fmt.Errorf("invalid formatter %q", formatter)
+		}
+	}
+
 	m := &MetaFormatter{log: log}
 
-	if _, ok := enabledLinters[gofmt.Name]; ok {
-		m.formatters = append(m.formatters, gofmt.New(&cfg.LintersSettings.Gofmt))
+	if slices.Contains(cfg.Enable, gofmt.Name) {
+		m.formatters = append(m.formatters, gofmt.New(&cfg.Settings.GoFmt))
 	}
 
-	if _, ok := enabledLinters[gofumpt.Name]; ok {
-		m.formatters = append(m.formatters, gofumpt.New(&cfg.LintersSettings.Gofumpt, cfg.Run.Go))
+	if slices.Contains(cfg.Enable, gofumpt.Name) {
+		m.formatters = append(m.formatters, gofumpt.New(&cfg.Settings.GoFumpt, runCfg.Go))
 	}
 
-	if _, ok := enabledLinters[goimports.Name]; ok {
-		m.formatters = append(m.formatters, goimports.New(&cfg.LintersSettings.Goimports))
+	if slices.Contains(cfg.Enable, goimports.Name) {
+		m.formatters = append(m.formatters, goimports.New(&cfg.Settings.GoImports))
 	}
 
 	// gci is a last because the only goal of gci is to handle imports.
-	if _, ok := enabledLinters[gci.Name]; ok {
-		formatter, err := gci.New(&cfg.LintersSettings.Gci)
+	if slices.Contains(cfg.Enable, gci.Name) {
+		formatter, err := gci.New(&cfg.Settings.Gci)
 		if err != nil {
 			return nil, fmt.Errorf("gci: creating formatter: %w", err)
 		}
@@ -72,3 +78,7 @@ func (m *MetaFormatter) Format(filename string, src []byte) []byte {
 
 	return data
 }
+
+func IsFormatter(name string) bool {
+	return slices.Contains([]string{gofmt.Name, gofumpt.Name, goimports.Name, gci.Name}, name)
+}

pkg/lint/lintersdb/builder_linter.go

@@ -394,13 +394,13 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithAutoFix().
 			WithURL("https://github.com/Djarvur/go-err113"),
 
-		linter.NewConfig(gofmt.New(&cfg.LintersSettings.Gofmt)).
+		linter.NewConfig(gofmt.New(&cfg.LintersSettings.GoFmt)).
 			WithSince("v1.0.0").
 			WithPresets(linter.PresetFormatting).
 			WithAutoFix().
 			WithURL("https://pkg.go.dev/cmd/gofmt"),
 
-		linter.NewConfig(gofumpt.New(&cfg.LintersSettings.Gofumpt)).
+		linter.NewConfig(gofumpt.New(&cfg.LintersSettings.GoFumpt)).
 			WithSince("v1.28.0").
 			WithPresets(linter.PresetFormatting).
 			WithAutoFix().
@@ -412,7 +412,7 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithAutoFix().
 			WithURL("https://github.com/denis-tingaikin/go-header"),
 
-		linter.NewConfig(goimports.New(&cfg.LintersSettings.Goimports)).
+		linter.NewConfig(goimports.New(&cfg.LintersSettings.GoImports)).
 			WithSince("v1.20.0").
 			WithPresets(linter.PresetFormatting, linter.PresetImport).
 			WithAutoFix().

pkg/lint/runner.go

@@ -7,6 +7,8 @@ import (
 	"runtime/debug"
 	"strings"
 
+	"golang.org/x/exp/maps"
+
 	"github.com/golangci/golangci-lint/internal/errorutil"
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/fsutils"
@@ -71,7 +73,19 @@ func NewRunner(log logutils.Log, cfg *config.Config, args []string, goenv *gouti
 		return nil, fmt.Errorf("failed to get enabled linters: %w", err)
 	}
 
-	metaFormatter, err := goformatters.NewMetaFormatter(log, cfg, enabledLinters)
+	var enabledFormatters []string
+	for _, name := range maps.Keys(enabledLinters) {
+		if goformatters.IsFormatter(name) {
+			enabledFormatters = append(enabledFormatters, name)
+		}
+	}
+
+	formattersCfg := &config.Formatters{
+		Enable:   enabledFormatters,
+		Settings: cfg.LintersSettings.FormatterSettings,
+	}
+
+	metaFormatter, err := goformatters.NewMetaFormatter(log, formattersCfg, &cfg.Run)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create meta-formatter: %w", err)
 	}