feat: option to exclude specific methods (#11)

Author: ldez

analyzer.go

@@ -10,21 +10,25 @@ import (
 
 // NewAnalyzer returns a new analyzer to check for receiver type consistency.
 func NewAnalyzer(s Settings) *analysis.Analyzer {
-	// Default excludes for Marshal/Encode methods https://github.com/raeperd/recvcheck/issues/7
-	excludedMethods := map[string]struct{}{
-		"MarshalText":   {},
-		"MarshalJSON":   {},
-		"MarshalYAML":   {},
-		"MarshalXML":    {},
-		"MarshalBinary": {},
-		"GobEncode":     {},
+	a := &analyzer{
+		excluded: map[string]struct{}{},
 	}
 
-	if s.DisableBuiltin {
-		excludedMethods = map[string]struct{}{}
+	if !s.DisableBuiltin {
+		// Default excludes for Marshal/Encode methods https://github.com/raeperd/recvcheck/issues/7
+		a.excluded = map[string]struct{}{
+			"*.MarshalText":   {},
+			"*.MarshalJSON":   {},
+			"*.MarshalYAML":   {},
+			"*.MarshalXML":    {},
+			"*.MarshalBinary": {},
+			"*.GobEncode":     {},
+		}
 	}
 
-	a := &analyzer{excludedMethods: excludedMethods}
+	for _, exclusion := range s.Exclusions {
+		a.excluded[exclusion] = struct{}{}
+	}
 
 	return &analysis.Analyzer{
 		Name:     "recvcheck",
@@ -45,10 +49,14 @@ type Settings struct {
 	//   - "MarshalBinary"
 	//   - "GobEncode"
 	DisableBuiltin bool
+
+	// Exclusions format is `struct_name.method_name` (ex: `Foo.MethodName`).
+	// A wildcard `*` can use as a struct name (ex: `*.MethodName`).
+	Exclusions []string
 }
 
 type analyzer struct {
-	excludedMethods map[string]struct{}
+	excluded map[string]struct{}
 }
 
 func (r *analyzer) run(pass *analysis.Pass) (any, error) {
@@ -61,21 +69,12 @@ func (r *analyzer) run(pass *analysis.Pass) (any, error) {
 			return
 		}
 
-		if r.isExcluded(funcDecl) {
+		recv, isStar := recvTypeIdent(funcDecl.Recv.List[0].Type)
+		if recv == nil {
 			return
 		}
 
-		var recv *ast.Ident
-		var isStar bool
-		switch recvType := funcDecl.Recv.List[0].Type.(type) {
-		case *ast.StarExpr:
-			isStar = true
-			if recv, ok = recvType.X.(*ast.Ident); !ok {
-				return
-			}
-		case *ast.Ident:
-			recv = recvType
-		default:
+		if r.isExcluded(recv, funcDecl) {
 			return
 		}
 
@@ -101,16 +100,36 @@ func (r *analyzer) run(pass *analysis.Pass) (any, error) {
 	return nil, nil
 }
 
-func (r *analyzer) isExcluded(f *ast.FuncDecl) bool {
+func (r *analyzer) isExcluded(recv *ast.Ident, f *ast.FuncDecl) bool {
 	if f.Name == nil || f.Name.Name == "" {
 		return true
 	}
 
-	_, found := r.excludedMethods[f.Name.Name]
+	_, found := r.excluded[recv.Name+"."+f.Name.Name]
+	if found {
+		return true
+	}
+
+	_, found = r.excluded["*."+f.Name.Name]
+
 	return found
 }
 
 type structType struct {
 	starUsed bool
 	typeUsed bool
 }
+
+func recvTypeIdent(r ast.Expr) (*ast.Ident, bool) {
+	switch n := r.(type) {
+	case *ast.StarExpr:
+		if i, ok := n.X.(*ast.Ident); ok {
+			return i, true
+		}
+
+	case *ast.Ident:
+		return n, false
+	}
+
+	return nil, false
+}

analyzer_test.go

@@ -17,13 +17,21 @@ func TestAnalyzer(t *testing.T) {
 			settings: recvcheck.Settings{},
 		},
 		{
-			desc:     "excluded",
+			desc:     "builtinmethods",
 			settings: recvcheck.Settings{},
 		},
 		{
 			desc:     "disablebuiltin",
 			settings: recvcheck.Settings{DisableBuiltin: true},
 		},
+		{
+			desc:     "exclusions",
+			settings: recvcheck.Settings{Exclusions: []string{"SQL.Value"}},
+		},
+		{
+			desc:     "exclusionswildcard",
+			settings: recvcheck.Settings{Exclusions: []string{"*.Value"}},
+		},
 	}
 
 	for _, test := range testCases {

testdata/src/excluded/binary.go testdata/src/builtinmethods/binary.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 type Binary struct{}
 

testdata/src/excluded/gob.go testdata/src/builtinmethods/gob.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 type Gob struct{}
 

testdata/src/excluded/json.go testdata/src/builtinmethods/json.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 type JSON struct{}
 

testdata/src/excluded/text.go testdata/src/builtinmethods/text.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 type Text struct{}
 

testdata/src/excluded/xml.go testdata/src/builtinmethods/xml.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 import "encoding/xml"
 

testdata/src/excluded/yaml.go testdata/src/builtinmethods/yaml.go

@@ -1,4 +1,4 @@
-package excluded
+package builtinmethods
 
 type Node struct{}
 

testdata/src/exclusions/exclusions.go

@@ -0,0 +1,13 @@
+package exclusions
+
+import "database/sql/driver"
+
+type SQL struct{}
+
+func (s SQL) Value() (driver.Value, error) {
+	panic("not implemented")
+}
+
+func (s *SQL) Scan(src any) error {
+	panic("not implemented")
+}

testdata/src/exclusionswildcard/exclusionswildcard.go

@@ -0,0 +1,13 @@
+package exclusions
+
+import "database/sql/driver"
+
+type SQL struct{}
+
+func (s SQL) Value() (driver.Value, error) {
+	panic("not implemented")
+}
+
+func (s *SQL) Scan(src any) error {
+	panic("not implemented")
+}