snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

tools/mattermost-govet/inconsistentReceiverName/inconsistentReceiverName.go

@@ -0,0 +1,99 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package inconsistentReceiverName
+
+import (
+	"go/ast"
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+)
+
+var (
+	Analyzer = &analysis.Analyzer{
+		Name: "inconsistentReceiverName",
+		Doc:  "check for inconsistent receiver names in the methods of a struct",
+		Run:  run,
+	}
+	ignoreFilesPattern string
+)
+
+type firstReceiverName = struct {
+	Name string
+	Node ast.Node
+}
+
+func init() {
+	Analyzer.Flags.StringVar(&ignoreFilesPattern, "ignore", "", "Comma separated list of files to ignore")
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	var ignoreFiles []string
+	if ignoreFilesPattern != "" {
+		ignoreFiles = strings.Split(ignoreFilesPattern, ",")
+	}
+
+	firstReceiverNameForType := make(map[string]firstReceiverName)
+	for _, file := range pass.Files {
+		ast.Inspect(file, func(node ast.Node) bool {
+			if node != nil {
+				f := pass.Fset.File(node.Pos())
+				if isIgnore(f.Name(), ignoreFiles) {
+					return false
+				}
+			}
+
+			switch funDecl := node.(type) {
+			case *ast.FuncDecl:
+				if funDecl.Recv != nil && len(funDecl.Recv.List) > 0 && len(funDecl.Recv.List[0].Names) > 0 {
+					field := funDecl.Recv.List[0]
+					expr := field.Type
+					starExpr, ok := field.Type.(*ast.StarExpr)
+					if ok {
+						expr = starExpr.X
+					}
+
+					typeIdent, ok := expr.(*ast.Ident)
+					if !ok {
+						return false
+					}
+
+					currentReceiverName := field.Names[0].Name
+					firstReceiver, ok := firstReceiverNameForType[typeIdent.Name]
+					if !ok {
+						firstReceiverNameForType[typeIdent.Name] = firstReceiverName{
+							Name: currentReceiverName,
+							Node: node,
+						}
+						return true
+					}
+
+					if firstReceiver.Name != currentReceiverName {
+						otherReceiverName := firstReceiver.Name
+						otherReceiverPosition := pass.Fset.Position(firstReceiver.Node.Pos())
+						pass.Reportf(
+							node.Pos(),
+							"Different receiver name used for the struct \"%s\" in different methods: using \"%s\" here but was named as \"%s\" before at %s",
+							typeIdent.Name,
+							currentReceiverName,
+							otherReceiverName,
+							otherReceiverPosition.String(),
+						)
+					}
+				}
+			}
+			return true
+		})
+	}
+	return nil, nil
+}
+
+func isIgnore(file string, ignoreFiles []string) bool {
+	for _, f := range ignoreFiles {
+		if strings.HasSuffix(file, f) {
+			return true
+		}
+	}
+	return false
+}

tools/mattermost-govet/inconsistentReceiverName/inconsistentReceiverName_test.go

@@ -0,0 +1,15 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package inconsistentReceiverName
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func TestAll(t *testing.T) {
+	testdata := analysistest.TestData()
+	analysistest.Run(t, testdata, Analyzer, "a")
+}

tools/mattermost-govet/inconsistentReceiverName/testdata/src/a/a.go

@@ -0,0 +1,69 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package a
+
+// Valid: consistent receiver names
+type ValidServer struct {
+	name string
+}
+
+func (s *ValidServer) Start() {
+}
+
+func (s *ValidServer) Stop() {
+}
+
+func (s *ValidServer) GetName() string {
+	return s.name
+}
+
+// Invalid: inconsistent receiver names
+type InvalidServer struct {
+	name string
+}
+
+func (s *InvalidServer) Start() {
+}
+
+func (srv *InvalidServer) Stop() { // want "Different receiver name used for the struct \"InvalidServer\" in different methods"
+}
+
+func (server *InvalidServer) GetName() string { // want "Different receiver name used for the struct \"InvalidServer\" in different methods"
+	return server.name
+}
+
+// Valid: different structs can use different receiver names
+type Client struct{}
+
+func (c *Client) Connect() {
+}
+
+func (c *Client) Disconnect() {
+}
+
+// Invalid: more than two different receiver names
+type Database struct{}
+
+func (d *Database) Open() {
+}
+
+func (db *Database) Close() { // want "Different receiver name used for the struct \"Database\" in different methods"
+}
+
+func (database *Database) Query() { // want "Different receiver name used for the struct \"Database\" in different methods"
+}
+
+// Valid: non-pointer receivers
+type Counter struct {
+	count int
+}
+
+func (c Counter) Increment() Counter {
+	c.count++
+	return c
+}
+
+func (c Counter) Get() int {
+	return c.count
+}