add config support + add skip protoc-gen-grpc-gateway generated files

Author: ghostiam

cmd/protogetter/main.go

@@ -7,5 +7,9 @@ import (
 )
 
 func main() {
-	singlechecker.Main(protogetter.NewAnalyzer())
+	cfg := &protogetter.Config{
+		Mode: protogetter.StandaloneMode,
+	}
+
+	singlechecker.Main(protogetter.NewAnalyzer(cfg))
 }

protogetter.go

@@ -22,18 +22,32 @@ const (
 
 const msgFormat = "avoid direct access to proto field %s, use %s instead"
 
-func NewAnalyzer() *analysis.Analyzer {
+func NewAnalyzer(cfg *Config) *analysis.Analyzer {
 	return &analysis.Analyzer{
 		Name: "protogetter",
 		Doc:  "Reports direct reads from proto message fields when getters should be used",
 		Run: func(pass *analysis.Pass) (any, error) {
-			Run(pass, StandaloneMode)
+			Run(pass, cfg)
 			return nil, nil
 		},
 	}
 }
 
-func Run(pass *analysis.Pass, mode Mode) []Issue {
+type Config struct {
+	Mode            Mode
+	SkipGeneratedBy []string
+}
+
+func Run(pass *analysis.Pass, cfg *Config) []Issue {
+	// Always skip files generated by protoc-gen-go and protoc-gen-grpc-gateway.
+	skipGeneratedBy := []string{"protoc-gen-go", "protoc-gen-grpc-gateway"}
+	for _, s := range cfg.SkipGeneratedBy {
+		if strings.TrimSpace(s) == "" {
+			continue
+		}
+		skipGeneratedBy = append(skipGeneratedBy, s)
+	}
+
 	nodeTypes := []ast.Node{
 		(*ast.AssignStmt)(nil),
 		(*ast.CallExpr)(nil),
@@ -45,7 +59,7 @@ func Run(pass *analysis.Pass, mode Mode) []Issue {
 	// Skip protoc-generated files.
 	var files []*ast.File
 	for _, f := range pass.Files {
-		if !isProtocGeneratedFile(f) {
+		if !skipGeneratedFile(f, skipGeneratedBy) {
 			files = append(files, f)
 
 			// ast.Print(pass.Fset, f)
@@ -63,7 +77,7 @@ func Run(pass *analysis.Pass, mode Mode) []Issue {
 			return
 		}
 
-		switch mode {
+		switch cfg.Mode {
 		case StandaloneMode:
 			pass.Report(report.ToDiagReport())
 		case GolangciLintMode:
@@ -168,8 +182,18 @@ func (r *Report) ToIssue(fset *token.FileSet) Issue {
 	}
 }
 
-func isProtocGeneratedFile(f *ast.File) bool {
-	return len(f.Comments) > 0 && strings.HasPrefix(f.Comments[0].Text(), "Code generated by protoc-gen-go")
+func skipGeneratedFile(f *ast.File, prefixes []string) bool {
+	if len(f.Comments) == 0 {
+		return false
+	}
+
+	for _, prefix := range prefixes {
+		if strings.HasPrefix(f.Comments[0].Text(), "Code generated by "+prefix) {
+			return true
+		}
+	}
+
+	return false
 }
 
 func formatNode(node ast.Node) string {

protogetter_test.go

@@ -9,8 +9,10 @@ import (
 )
 
 func Test(t *testing.T) {
+	cfg := &protogetter.Config{}
+
 	testdata := analysistest.TestData()
-	analysistest.RunWithSuggestedFixes(t, testdata, protogetter.NewAnalyzer())
+	analysistest.RunWithSuggestedFixes(t, testdata, protogetter.NewAnalyzer(cfg))
 
-	analysistest.Run(t, testdata, protogetter.NewAnalyzer(), "./proto/...")
+	analysistest.Run(t, testdata, protogetter.NewAnalyzer(cfg), "./proto/...")
 }