feat: add recv linter

Author: ldez

.golangci.next.reference.yml

@@ -1540,6 +1540,14 @@ linters-settings:
     patterns:
       - ".*"
 
+  recv:
+    # Maximum length for a receiver name.
+    # Default: 3
+    max-name-length: 6
+    # Allow to use pointer receiver and non pointer receiver on the same struct.
+    # Default: true
+    type-consistency: false
+
   revive:
     # Maximum number of open files at the same time.
     # See https://github.com/mgechev/revive#command-line-flags
@@ -2689,6 +2697,7 @@ linters:
     - promlinter
     - protogetter
     - reassign
+    - recv
     - revive
     - rowserrcheck
     - sloglint
@@ -2804,6 +2813,7 @@ linters:
     - promlinter
     - protogetter
     - reassign
+    - recv
     - revive
     - rowserrcheck
     - sloglint

go.mod

@@ -67,6 +67,7 @@ require (
 	github.com/kyoh86/exportloopref v0.1.11
 	github.com/lasiar/canonicalheader v1.1.1
 	github.com/ldez/gomoddirectives v0.2.4
+	github.com/ldez/recv v0.1.1
 	github.com/ldez/tagliatelle v0.5.0
 	github.com/leonklingele/grouper v1.1.2
 	github.com/lufeee/execinquery v1.2.1

go.sum

@@ -388,6 +388,7 @@
             "promlinter",
             "protogetter",
             "reassign",
+            "recv",
             "revive",
             "rowserrcheck",
             "scopelint",
@@ -2283,6 +2284,22 @@
             }
           }
         },
+        "recv": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "max-name-length": {
+              "description": "Maximum length for a receiver name.",
+              "type": "integer",
+              "default": 3
+            },
+            "type-consistency": {
+              "description": "Allow to use pointer receiver and non pointer receiver on the same struct.",
+              "type": "boolean",
+              "default": true
+            }
+          }
+        },
         "nonamedreturns": {
           "type": "object",
           "additionalProperties": false,

jsonschema/golangci.next.jsonschema.json

@@ -137,6 +137,10 @@ var defaultLintersSettings = LintersSettings{
 		Ignore:    "",
 		Qualified: false,
 	},
+	Recv: RecvSettings{
+		MaxNameLength:   3,
+		TypeConsistency: true,
+	},
 	SlogLint: SlogLintSettings{
 		NoMixedArgs:    true,
 		KVOnly:         false,
@@ -257,6 +261,7 @@ type LintersSettings struct {
 	Promlinter      PromlinterSettings
 	ProtoGetter     ProtoGetterSettings
 	Reassign        ReassignSettings
+	Recv            RecvSettings
 	Revive          ReviveSettings
 	RowsErrCheck    RowsErrCheckSettings
 	SlogLint        SlogLintSettings
@@ -791,6 +796,11 @@ type ReassignSettings struct {
 	Patterns []string `mapstructure:"patterns"`
 }
 
+type RecvSettings struct {
+	MaxNameLength   int  `mapstructure:"max-name-length"`
+	TypeConsistency bool `mapstructure:"type-consistency"`
+}
+
 type ReviveSettings struct {
 	Go                    string `mapstructure:"-"`
 	MaxOpenFiles          int    `mapstructure:"max-open-files"`

pkg/config/linters_settings.go

@@ -0,0 +1,27 @@
+package recv
+
+import (
+	"github.com/ldez/recv"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/goanalysis"
+)
+
+func New(settings *config.RecvSettings) *goanalysis.Linter {
+	cfg := recv.Config{}
+
+	if settings != nil {
+		cfg.MaxNameLength = settings.MaxNameLength
+		cfg.TypeConsistency = settings.TypeConsistency
+	}
+
+	a := recv.New(cfg)
+
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/golinters/recv/recv.go

@@ -0,0 +1,11 @@
+package recv
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/recv/recv_integration_test.go

@@ -0,0 +1,22 @@
+//golangcitest:args -Erecv
+package testdata
+
+import "fmt"
+
+type Foo struct { // want `the methods of "Foo" use different receiver names: f, fo.`
+	Name string
+}
+
+func (f Foo) A()  {}
+func (fo Foo) B() {}
+
+type Bar struct{} // want `the methods of "Bar" use pointer receiver and non pointer receiver.`
+
+func (b Bar) A()  {}
+func (b *Bar) B() {}
+
+type Fuu struct{}
+
+func (faaa Fuu) A() { // want `the receiver name "faaa" is too long.`
+	fmt.Println("a")
+}

pkg/golinters/recv/testdata/recv.go

@@ -0,0 +1,23 @@
+//golangcitest:args -Erecv
+//golangcitest:config_path testdata/recv_disable_type_consistency.yml
+package testdata
+
+import "fmt"
+
+type Foo struct { // want `the methods of "Foo" use different receiver names: f, fo.`
+	Name string
+}
+
+func (f Foo) A()  {}
+func (fo Foo) B() {}
+
+type Bar struct{}
+
+func (b Bar) A()  {}
+func (b *Bar) B() {}
+
+type Fuu struct{}
+
+func (faaa Fuu) A() { // want `the receiver name "faaa" is too long.`
+	fmt.Println("a")
+}

pkg/golinters/recv/testdata/recv_disable_type_consistency.go

@@ -0,0 +1,3 @@
+linters-settings:
+  recv:
+    type-consistency: false