Update WSL to v1.2.1 (#794)

* Update WSL to v1.2.1

* Add new tests for fixed false positives, don't derive defaults from WSL

Author: bombsimon

.golangci.example.yml

@@ -211,6 +211,15 @@ linters-settings:
   whitespace:
     multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
     multi-func: false # Enforces newlines (or comments) after every multi-line function signature
+  wsl:
+    # If true append is only allowed to be cuddled if appending value is
+    # matching variables, fields or types on line above. Default is true.
+    strict-append: true
+    # Allow calls and assignments to be cuddled as long as the lines have any
+    # matching variables, fields or types. Default is true.
+    allow-assign-and-call: true
+    # Allow multiline assignments to be cuddled. Default is true.
+    allow-multiline-assign: true
 
 linters:
   enable:

README.md

@@ -804,6 +804,15 @@ linters-settings:
   whitespace:
     multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
     multi-func: false # Enforces newlines (or comments) after every multi-line function signature
+  wsl:
+    # If true append is only allowed to be cuddled if appending value is
+    # matching variables, fields or types on line above. Default is true.
+    strict-append: true
+    # Allow calls and assignments to be cuddled as long as the lines have any
+    # matching variables, fields or types. Default is true.
+    allow-assign-and-call: true
+    # Allow multiline assignments to be cuddled. Default is true.
+    allow-multiline-assign: true
 
 linters:
   enable:

go.mod

@@ -4,7 +4,7 @@ go 1.12
 
 require (
 	github.com/OpenPeeDeeP/depguard v1.0.1
-	github.com/bombsimon/wsl v1.0.1
+	github.com/bombsimon/wsl v1.2.1
 	github.com/fatih/color v1.7.0
 	github.com/go-critic/go-critic v0.3.5-0.20190904082202-d79a9f0c64db
 	github.com/go-lintpack/lintpack v0.5.2

go.sum

@@ -11,8 +11,8 @@ github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRF
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
-github.com/bombsimon/wsl v1.0.1 h1:GkrpOj7ajds8re6EJXN+k6UtatYSktupigQ2ZfOUIOU=
-github.com/bombsimon/wsl v1.0.1/go.mod h1:DSRwCD8c7NecM11/LnZcTS8nS8OND5ybj04DWM4l8mc=
+github.com/bombsimon/wsl v1.2.1 h1:DcLf3V66dJi4a+KHt+F1FdOeBZ05adHqTMYFvjgv06k=
+github.com/bombsimon/wsl v1.2.1/go.mod h1:43lEF/i0kpXbLCeDXL9LMT8c92HyBywXb0AsgMHYngM=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk=

pkg/config/config.go

@@ -176,6 +176,7 @@ type LintersSettings struct {
 		MultiFunc bool `mapstructure:"multi-func"`
 	}
 
+	WSL      WSLSettings
 	Lll      LllSettings
 	Unparam  UnparamSettings
 	Nakedret NakedretSettings
@@ -249,6 +250,12 @@ type GocognitSettings struct {
 	MinComplexity int `mapstructure:"min-complexity"`
 }
 
+type WSLSettings struct {
+	StrictAppend               bool `mapstructure:"strict-append"`
+	AllowAssignAndCallCuddle   bool `mapstructure:"allow-assign-and-call"`
+	AllowMultiLineAssignCuddle bool `mapstructure:"allow-multiline-assign"`
+}
+
 var defaultLintersSettings = LintersSettings{
 	Lll: LllSettings{
 		LineLength: 120,
@@ -277,6 +284,11 @@ var defaultLintersSettings = LintersSettings{
 	Gocognit: GocognitSettings{
 		MinComplexity: 30,
 	},
+	WSL: WSLSettings{
+		StrictAppend:               true,
+		AllowAssignAndCallCuddle:   true,
+		AllowMultiLineAssignCuddle: true,
+	},
 }
 
 type Linters struct {

pkg/golinters/wsl.go

@@ -33,13 +33,25 @@ func NewWSL() *goanalysis.Linter {
 		nil,
 	).WithContextSetter(func(lintCtx *linter.Context) {
 		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
-			files := []string{}
+			var (
+				files        = []string{}
+				linterCfg    = lintCtx.Cfg.LintersSettings.WSL
+				processorCfg = wsl.Configuration{
+					StrictAppend:               linterCfg.StrictAppend,
+					AllowAssignAndCallCuddle:   linterCfg.AllowAssignAndCallCuddle,
+					AllowMultiLineAssignCuddle: linterCfg.AllowMultiLineAssignCuddle,
+					AllowCuddleWithCalls:       []string{"Lock", "RLock"},
+					AllowCuddleWithRHS:         []string{"Unlock", "RUnlock"},
+				}
+			)
 
 			for _, file := range pass.Files {
 				files = append(files, pass.Fset.Position(file.Pos()).Filename)
 			}
 
-			wslErrors, _ := wsl.ProcessFiles(files)
+			wslErrors, _ := wsl.NewProcessorWithConfig(processorCfg).
+				ProcessFiles(files)
+
 			if len(wslErrors) == 0 {
 				return nil, nil
 			}

test/testdata/wsl.go

@@ -52,6 +52,26 @@ func main() {
 	_, cf2 := context.WithCancel(context.Background())
 	defer cf1() // ERROR "only one cuddle assignment allowed before defer statement"
 	defer cf2()
+
+	err := multiline(
+		"spanning",
+		"multiple",
+	)
+	if err != nil {
+		panic(err)
+	}
+
+	notErr := multiline(
+		"spanning",
+		"multiple",
+	)
+	if err != nil { // ERROR "if statements should only be cuddled with assignments used in the if statement itself"
+		panic(notErr)
+	}
+}
+
+func multiline(s ...string) error {
+	return nil
 }
 
 func f1() int {
@@ -78,3 +98,5 @@ func f3() int {
 
 	return sum + notSum
 }
+
+func onelineShouldNotError() error { return nil }