wsl: new v5

Co-authored-by: Fernandez Ludovic <[email protected]>

Author: bombsimon

.golangci.next.reference.yml

@@ -126,6 +126,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - wsl_v5
     - zerologlint
 
   # Disable specific linters.
@@ -236,6 +237,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - wsl_v5
     - zerologlint
 
   # All available settings of specific linters.
@@ -3912,6 +3914,61 @@ linters:
       # Default: false
       force-short-decl-cuddling: true
 
+    wsl_v5:
+      # Allow cuddling a variable if it's used first in the immediate following
+      # block, even if the statement with the block doesn't use the variable
+      # Default: true
+      allow-first-in-block: true
+
+      # Same as above, but allows cuddling if the variable is used anywhere in
+      # the following (or nested) block
+      # Default: false
+      allow-whole-block: false
+
+      # If a block contains more than this number of lines the branch statement
+      # need to be separated by a whitespace
+      # Default: 2
+      branch-max-lines: 2
+
+      # If set to a non negative number, case blocks needs to end with a
+      # whitespace if exceeding this number
+      # Default: 0
+      case-max-lines: 0
+
+      # Preset with checks. Can be `all`, `none`, `default` or empty
+      # Default: ""
+      default: ~
+
+      # Enabled checks. Will be additive to any preset.
+      # Default: None
+      enable:
+        - append
+        - assign
+        - branch
+        - decl
+        - defer
+        - err
+        - expr
+        - for
+        - go
+        - if
+        - inc-dec
+        - label
+        - range
+        - return
+        - select
+        - send
+        - switch
+        - type-switch
+        - leading-whitespace
+        - trailing-whitespace
+
+      # Disable checks. Will be subtractive to any preset.
+      # Default: None
+      disable:
+        - assign-exclusive
+        - assign-expr
+
     # The custom section can be used to define linter plugins to be loaded at runtime.
     # See README documentation for more info.
     custom:

go.mod

@@ -26,6 +26,7 @@ require (
 	github.com/bkielbasa/cyclop v1.2.3
 	github.com/blizzy78/varnamelen v0.8.0
 	github.com/bombsimon/wsl/v4 v4.7.0
+	github.com/bombsimon/wsl/v5 v5.0.0-rc2
 	github.com/breml/bidichk v0.3.3
 	github.com/breml/errchkjson v0.4.1
 	github.com/butuzov/ireturn v0.4.0

go.sum

@@ -100,7 +100,7 @@ func toAsasalintSettings(old versionone.AsasalintSettings) versiontwo.AsasalintS
 }
 
 func toBiDiChkSettings(old versionone.BiDiChkSettings) versiontwo.BiDiChkSettings {
-	// The values are true be default, but the default are defined after the configuration loading.
+	// The values are true be default, but the defaults are defined after the configuration loading.
 	// So the serialization doesn't have good results, but it's complex to do better.
 	return versiontwo.BiDiChkSettings{
 		LeftToRightEmbedding:     old.LeftToRightEmbedding,
@@ -998,8 +998,8 @@ func toWrapcheckSettings(old versionone.WrapcheckSettings) versiontwo.WrapcheckS
 	}
 }
 
-func toWSLSettings(old versionone.WSLSettings) versiontwo.WSLSettings {
-	return versiontwo.WSLSettings{
+func toWSLSettings(old versionone.WSLSettings) versiontwo.WSLv4Settings {
+	return versiontwo.WSLv4Settings{
 		StrictAppend:                     old.StrictAppend,
 		AllowAssignAndCallCuddle:         old.AllowAssignAndCallCuddle,
 		AllowAssignAndAnythingCuddle:     old.AllowAssignAndAnythingCuddle,

pkg/commands/internal/migrate/migrate_linters_settings.go

@@ -184,7 +184,7 @@ var defaultLintersSettings = LintersSettings{
 		MaxDistance:   5,
 		MinNameLength: 3,
 	},
-	WSL: WSLSettings{
+	WSL: WSLv4Settings{
 		StrictAppend:                     true,
 		AllowAssignAndCallCuddle:         true,
 		AllowAssignAndAnythingCuddle:     false,
@@ -200,6 +200,15 @@ var defaultLintersSettings = LintersSettings{
 		ErrorVariableNames:               []string{"err"},
 		ForceExclusiveShortDeclarations:  false,
 	},
+	WSLv5: WSLv5Settings{
+		AllowFirstInBlock: true,
+		AllowWholeBlock:   false,
+		BranchMaxLines:    2,
+		CaseMaxLines:      0,
+		Default:           "",
+		Enable:            []string{},
+		Disable:           []string{},
+	},
 }
 
 type LintersSettings struct {
@@ -283,7 +292,8 @@ type LintersSettings struct {
 	Varnamelen               VarnamelenSettings               `mapstructure:"varnamelen"`
 	Whitespace               WhitespaceSettings               `mapstructure:"whitespace"`
 	Wrapcheck                WrapcheckSettings                `mapstructure:"wrapcheck"`
-	WSL                      WSLSettings                      `mapstructure:"wsl"`
+	WSL                      WSLv4Settings                    `mapstructure:"wsl"` // Deprecated: use WSLv5 instead.
+	WSLv5                    WSLv5Settings                    `mapstructure:"wsl_v5"`
 
 	Custom map[string]CustomLinterSettings `mapstructure:"custom"`
 }
@@ -992,7 +1002,8 @@ type WrapcheckSettings struct {
 	ReportInternalErrors   bool     `mapstructure:"report-internal-errors"`
 }
 
-type WSLSettings struct {
+// Deprecated: use WSLv5Settings instead.
+type WSLv4Settings struct {
 	StrictAppend                     bool     `mapstructure:"strict-append"`
 	AllowAssignAndCallCuddle         bool     `mapstructure:"allow-assign-and-call"`
 	AllowAssignAndAnythingCuddle     bool     `mapstructure:"allow-assign-and-anything"`
@@ -1009,6 +1020,16 @@ type WSLSettings struct {
 	ForceExclusiveShortDeclarations  bool     `mapstructure:"force-short-decl-cuddling"`
 }
 
+type WSLv5Settings struct {
+	AllowFirstInBlock bool     `mapstructure:"allow-first-in-block"`
+	AllowWholeBlock   bool     `mapstructure:"allow-whole-block"`
+	BranchMaxLines    int      `mapstructure:"branch-max-lines"`
+	CaseMaxLines      int      `mapstructure:"case-max-lines"`
+	Default           string   `mapstructure:"default"`
+	Enable            []string `mapstructure:"enable"`
+	Disable           []string `mapstructure:"disable"`
+}
+
 // CustomLinterSettings encapsulates the meta-data of a private linter.
 type CustomLinterSettings struct {
 	// Type plugin type.

pkg/commands/internal/migrate/versiontwo/linters_settings.go

@@ -1,17 +1,17 @@
 package wsl
 
 import (
-	"github.com/bombsimon/wsl/v4"
-
+	wslv4 "github.com/bombsimon/wsl/v4"
 	"github.com/golangci/golangci-lint/v2/pkg/config"
 	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
 )
 
-func New(settings *config.WSLSettings) *goanalysis.Linter {
-	var conf *wsl.Configuration
+// Deprecated: use NewV5 instead.
+func NewV4(settings *config.WSLv4Settings) *goanalysis.Linter {
+	var conf *wslv4.Configuration
 
 	if settings != nil {
-		conf = &wsl.Configuration{
+		conf = &wslv4.Configuration{
 			StrictAppend:                     settings.StrictAppend,
 			AllowAssignAndCallCuddle:         settings.AllowAssignAndCallCuddle,
 			AllowAssignAndAnythingCuddle:     settings.AllowAssignAndAnythingCuddle,
@@ -31,6 +31,6 @@ func New(settings *config.WSLSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.
-		NewLinterFromAnalyzer(wsl.NewAnalyzer(conf)).
+		NewLinterFromAnalyzer(wslv4.NewAnalyzer(conf)).
 		WithLoadMode(goanalysis.LoadModeSyntax)
 }

pkg/config/linters_settings.go

@@ -0,0 +1,34 @@
+package wsl
+
+import (
+	"github.com/bombsimon/wsl/v5"
+	"github.com/golangci/golangci-lint/v2/pkg/golinters/internal"
+
+	"github.com/golangci/golangci-lint/v2/pkg/config"
+	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
+)
+
+func NewV5(settings *config.WSLv5Settings) *goanalysis.Linter {
+	var conf *wsl.Configuration
+
+	if settings != nil {
+		checkSet, err := wsl.NewCheckSet(settings.Default, settings.Enable, settings.Disable)
+		if err != nil {
+			internal.LinterLogger.Fatalf("wsl: invalid check: %v", err)
+		}
+
+		conf = &wsl.Configuration{
+			IncludeGenerated:  true, // force to true because golangci-lint already has a way to filter generated files.
+			AllowFirstInBlock: settings.AllowFirstInBlock,
+			AllowWholeBlock:   settings.AllowWholeBlock,
+			BranchMaxLines:    settings.BranchMaxLines,
+			CaseMaxLines:      settings.CaseMaxLines,
+			Checks:            checkSet,
+		}
+	}
+
+	return goanalysis.
+		NewLinterFromAnalyzer(wsl.NewAnalyzer(conf)).
+		WithVersion(5).
+		WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/wsl/wsl.go

@@ -691,7 +691,13 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/tomarrell/wrapcheck"),
 
-		linter.NewConfig(wsl.New(&cfg.Linters.Settings.WSL)).
+		linter.NewConfig(wsl.NewV4(&cfg.Linters.Settings.WSL)).
+			DeprecatedWarning("new major version.", "v2.2.0", "wsl_v5").
+			WithSince("v1.20.0").
+			WithAutoFix().
+			WithURL("https://github.com/bombsimon/wsl"),
+
+		linter.NewConfig(wsl.NewV5(&cfg.Linters.Settings.WSLv5)).
 			WithSince("v1.20.0").
 			WithAutoFix().
 			WithURL("https://github.com/bombsimon/wsl"),