dev: option to not check deprecation (golangci#4591)

Author: ldez

.golangci.yml

@@ -161,20 +161,11 @@ issues:
     - path: pkg/commands/run.go
       linters: [staticcheck]
       text: "SA1019: c.cfg.Run.ShowStats is deprecated: use Output.ShowStats instead."
-    - path: pkg/commands/config.go
-      linters: [staticcheck]
-      text: "SA1019: cfg.Run.UseDefaultSkipDirs is deprecated: use Issues.UseDefaultExcludeDirs instead."
-    - path: pkg/commands/linters.go
-      linters: [staticcheck]
-      text: "SA1019: c.cfg.Run.UseDefaultSkipDirs is deprecated: use Issues.UseDefaultExcludeDirs instead."
 
     # Deprecated linter options.
     - path: pkg/golinters/errcheck.go
       linters: [staticcheck]
       text: "SA1019: errCfg.Exclude is deprecated: use ExcludeFunctions instead"
-    - path: pkg/commands/run.go
-      linters: [staticcheck]
-      text: "SA1019: lsc.Errcheck.Exclude is deprecated: use ExcludeFunctions instead"
     - path: pkg/golinters/govet.go
       linters: [staticcheck]
       text: "SA1019: cfg.CheckShadowing is deprecated: the linter should be enabled inside Enable."

pkg/commands/config.go

@@ -84,16 +84,10 @@ func (c *configCommand) preRunE(cmd *cobra.Command, args []string) error {
 	// It only needs to know the path of the configuration file.
 	cfg := config.NewDefault()
 
-	// Hack to hide deprecation messages related to `--skip-dirs-use-default`:
-	// Flags are not bound then the default values, defined only through flags, are not applied.
-	// In this command, file path and file information are the only requirements, i.e. it don't need flag values.
-	//
-	// TODO(ldez) add an option (check deprecation) to `Loader.Load()` but this require a dedicated PR.
-	cfg.Run.UseDefaultSkipDirs = true
-
 	loader := config.NewLoader(c.log.Child(logutils.DebugKeyConfigReader), c.viper, cmd.Flags(), c.opts, cfg, args)
 
-	if err := loader.Load(); err != nil {
+	err := loader.Load(config.LoadOptions{})
+	if err != nil {
 		return fmt.Errorf("can't load config: %w", err)
 	}
 

pkg/commands/linters.go

@@ -59,16 +59,10 @@ func newLintersCommand(logger logutils.Log) *lintersCommand {
 }
 
 func (c *lintersCommand) preRunE(cmd *cobra.Command, args []string) error {
-	// Hack to hide deprecation messages related to `--skip-dirs-use-default`:
-	// Flags are not bound then the default values, defined only through flags, are not applied.
-	// In this command, linters information are the only requirements, i.e. it don't need flag values.
-	//
-	// TODO(ldez) add an option (check deprecation) to `Loader.Load()` but this require a dedicated PR.
-	c.cfg.Run.UseDefaultSkipDirs = true
-
 	loader := config.NewLoader(c.log.Child(logutils.DebugKeyConfigReader), c.viper, cmd.Flags(), c.opts.LoaderOptions, c.cfg, args)
 
-	if err := loader.Load(); err != nil {
+	err := loader.Load(config.LoadOptions{Validation: true})
+	if err != nil {
 		return fmt.Errorf("can't load config: %w", err)
 	}
 

pkg/commands/run.go

@@ -154,7 +154,8 @@ func (c *runCommand) persistentPreRunE(cmd *cobra.Command, args []string) error
 
 	loader := config.NewLoader(c.log.Child(logutils.DebugKeyConfigReader), c.viper, cmd.Flags(), c.opts.LoaderOptions, c.cfg, args)
 
-	if err := loader.Load(); err != nil {
+	err := loader.Load(config.LoadOptions{CheckDeprecation: true, Validation: true})
+	if err != nil {
 		return fmt.Errorf("can't load config: %w", err)
 	}
 

pkg/config/config.go

@@ -33,12 +33,12 @@ func (c *Config) GetConfigDir() string {
 
 func (c *Config) Validate() error {
 	validators := []func() error{
-		c.Issues.Validate,
-		c.Severity.Validate,
+		c.Run.Validate,
+		c.Output.Validate,
 		c.LintersSettings.Validate,
 		c.Linters.Validate,
-		c.Output.Validate,
-		c.Run.Validate,
+		c.Issues.Validate,
+		c.Severity.Validate,
 	}
 
 	for _, v := range validators {

pkg/config/loader.go

@@ -24,6 +24,11 @@ type LoaderOptions struct {
 	NoConfig bool   // Flag only.
 }
 
+type LoadOptions struct {
+	CheckDeprecation bool
+	Validation       bool
+}
+
 type Loader struct {
 	opts LoaderOptions
 
@@ -47,7 +52,7 @@ func NewLoader(log logutils.Log, v *viper.Viper, fs *pflag.FlagSet, opts LoaderO
 	}
 }
 
-func (l *Loader) Load() error {
+func (l *Loader) Load(opts LoadOptions) error {
 	err := l.setConfigFile()
 	if err != nil {
 		return err
@@ -60,9 +65,11 @@ func (l *Loader) Load() error {
 
 	l.applyStringSliceHack()
 
-	err = l.handleDeprecation()
-	if err != nil {
-		return err
+	if opts.CheckDeprecation {
+		err = l.handleDeprecation()
+		if err != nil {
+			return err
+		}
 	}
 
 	l.handleGoVersion()
@@ -72,6 +79,13 @@ func (l *Loader) Load() error {
 		return err
 	}
 
+	if opts.Validation {
+		err = l.cfg.Validate()
+		if err != nil {
+			return err
+		}
+	}
+
 	return nil
 }
 
@@ -293,35 +307,39 @@ func (l *Loader) handleGoVersion() {
 }
 
 func (l *Loader) handleDeprecation() error {
+	if l.cfg.InternalTest || l.cfg.InternalCmdTest || os.Getenv(logutils.EnvTestRun) == "1" {
+		return nil
+	}
+
 	// Deprecated since v1.57.0
 	if len(l.cfg.Run.SkipFiles) > 0 {
-		l.warn("The configuration option `run.skip-files` is deprecated, please use `issues.exclude-files`.")
+		l.log.Warnf("The configuration option `run.skip-files` is deprecated, please use `issues.exclude-files`.")
 		l.cfg.Issues.ExcludeFiles = l.cfg.Run.SkipFiles
 	}
 
 	// Deprecated since v1.57.0
 	if len(l.cfg.Run.SkipDirs) > 0 {
-		l.warn("The configuration option `run.skip-dirs` is deprecated, please use `issues.exclude-dirs`.")
+		l.log.Warnf("The configuration option `run.skip-dirs` is deprecated, please use `issues.exclude-dirs`.")
 		l.cfg.Issues.ExcludeDirs = l.cfg.Run.SkipDirs
 	}
 
 	// The 2 options are true by default.
 	// Deprecated since v1.57.0
 	if !l.cfg.Run.UseDefaultSkipDirs {
-		l.warn("The configuration option `run.skip-dirs-use-default` is deprecated, please use `issues.exclude-dirs-use-default`.")
+		l.log.Warnf("The configuration option `run.skip-dirs-use-default` is deprecated, please use `issues.exclude-dirs-use-default`.")
 	}
 	l.cfg.Issues.UseDefaultExcludeDirs = l.cfg.Run.UseDefaultSkipDirs && l.cfg.Issues.UseDefaultExcludeDirs
 
 	// The 2 options are false by default.
 	// Deprecated since v1.57.0
 	if l.cfg.Run.ShowStats {
-		l.warn("The configuration option `run.show-stats` is deprecated, please use `output.show-stats`")
+		l.log.Warnf("The configuration option `run.show-stats` is deprecated, please use `output.show-stats`")
 	}
 	l.cfg.Output.ShowStats = l.cfg.Run.ShowStats || l.cfg.Output.ShowStats
 
 	// Deprecated since v1.57.0
 	if l.cfg.Output.Format != "" {
-		l.warn("The configuration option `output.format` is deprecated, please use `output.formats`")
+		l.log.Warnf("The configuration option `output.format` is deprecated, please use `output.formats`")
 
 		var f OutputFormats
 		err := f.UnmarshalText([]byte(l.cfg.Output.Format))
@@ -341,49 +359,49 @@ func (l *Loader) handleLinterOptionDeprecations() {
 	// Deprecated since v1.57.0,
 	// but it was unofficially deprecated since v1.19 (2019) (https://github.com/golangci/golangci-lint/pull/697).
 	if l.cfg.LintersSettings.Govet.CheckShadowing {
-		l.warn("The configuration option `linters.govet.check-shadowing` is deprecated. " +
+		l.log.Warnf("The configuration option `linters.govet.check-shadowing` is deprecated. " +
 			"Please enable `shadow` instead, if you are not using `enable-all`.")
 	}
 
 	// Deprecated since v1.42.0.
 	if l.cfg.LintersSettings.Errcheck.Exclude != "" {
-		l.warn("The configuration option `linters.errcheck.exclude` is deprecated, please use `linters.errcheck.exclude-functions`.")
+		l.log.Warnf("The configuration option `linters.errcheck.exclude` is deprecated, please use `linters.errcheck.exclude-functions`.")
 	}
 
 	// Deprecated since v1.44.0.
 	if l.cfg.LintersSettings.Gci.LocalPrefixes != "" {
-		l.warn("The configuration option `linters.gci.local-prefixes` is deprecated, please use `prefix()` inside `linters.gci.sections`.")
+		l.log.Warnf("The configuration option `linters.gci.local-prefixes` is deprecated, please use `prefix()` inside `linters.gci.sections`.")
 	}
 
 	// Deprecated since v1.33.0.
 	if l.cfg.LintersSettings.Godot.CheckAll {
-		l.warn("The configuration option `linters.godot.check-all` is deprecated, please use `linters.godot.scope: all`.")
+		l.log.Warnf("The configuration option `linters.godot.check-all` is deprecated, please use `linters.godot.scope: all`.")
 	}
 
 	// Deprecated since v1.44.0.
 	if len(l.cfg.LintersSettings.Gomnd.Settings) > 0 {
-		l.warn("The configuration option `linters.gomnd.settings` is deprecated. Please use the options " +
+		l.log.Warnf("The configuration option `linters.gomnd.settings` is deprecated. Please use the options " +
 			"`linters.gomnd.checks`,`linters.gomnd.ignored-numbers`,`linters.gomnd.ignored-files`,`linters.gomnd.ignored-functions`.")
 	}
 
 	// Deprecated since v1.47.0
 	if l.cfg.LintersSettings.Gofumpt.LangVersion != "" {
-		l.warn("The configuration option `linters.gofumpt.lang-version` is deprecated, please use global `run.go`.")
+		l.log.Warnf("The configuration option `linters.gofumpt.lang-version` is deprecated, please use global `run.go`.")
 	}
 
 	// Deprecated since v1.47.0
 	if l.cfg.LintersSettings.Staticcheck.GoVersion != "" {
-		l.warn("The configuration option `linters.staticcheck.go` is deprecated, please use global `run.go`.")
+		l.log.Warnf("The configuration option `linters.staticcheck.go` is deprecated, please use global `run.go`.")
 	}
 
 	// Deprecated since v1.47.0
 	if l.cfg.LintersSettings.Gosimple.GoVersion != "" {
-		l.warn("The configuration option `linters.gosimple.go` is deprecated, please use global `run.go`.")
+		l.log.Warnf("The configuration option `linters.gosimple.go` is deprecated, please use global `run.go`.")
 	}
 
 	// Deprecated since v1.47.0
 	if l.cfg.LintersSettings.Stylecheck.GoVersion != "" {
-		l.warn("The configuration option `linters.stylecheck.go` is deprecated, please use global `run.go`.")
+		l.log.Warnf("The configuration option `linters.stylecheck.go` is deprecated, please use global `run.go`.")
 	}
 }
 
@@ -408,14 +426,6 @@ func (l *Loader) handleEnableOnlyOption() error {
 	return nil
 }
 
-func (l *Loader) warn(format string) {
-	if l.cfg.InternalTest || l.cfg.InternalCmdTest || os.Getenv(logutils.EnvTestRun) == "1" {
-		return
-	}
-
-	l.log.Warnf(format)
-}
-
 func customDecoderHook() viper.DecoderConfigOption {
 	return viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
 		// Default hooks (https://github.com/spf13/viper/blob/518241257478c557633ab36e474dfcaeb9a3c623/viper.go#L135-L138).

pkg/lint/lintersdb/validator.go

@@ -22,11 +22,6 @@ func NewValidator(m *Manager) *Validator {
 // Validate validates the configuration by calling all other validators for different
 // sections in the configuration and then some additional linter validation functions.
 func (v Validator) Validate(cfg *config.Config) error {
-	err := cfg.Validate()
-	if err != nil {
-		return err
-	}
-
 	validators := []func(cfg *config.Linters) error{
 		v.validateLintersNames,
 		v.validatePresets,