Merge pull request #35 from Mavrickk3/master

Add flag to skip test files

cmd/nakedret/main.go

@@ -9,7 +9,8 @@ import (
 )
 
 const (
-	DefaultLines = 5
+	DefaultLines         = 5
+	DefaultSkipTestFiles = false
 )
 
 func init() {
@@ -18,6 +19,6 @@ func init() {
 }
 
 func main() {
-	analyzer := nakedret.NakedReturnAnalyzer(DefaultLines)
+	analyzer := nakedret.NakedReturnAnalyzer(DefaultLines, DefaultSkipTestFiles)
 	singlechecker.Main(analyzer)
 }

nakedret.go

@@ -22,10 +22,11 @@ import (
 
 const pwd = "./"
 
-func NakedReturnAnalyzer(defaultLines uint) *analysis.Analyzer {
+func NakedReturnAnalyzer(defaultLines uint, skipTestFiles bool) *analysis.Analyzer {
 	nakedRet := &NakedReturnRunner{}
 	flags := flag.NewFlagSet("nakedret", flag.ExitOnError)
 	flags.UintVar(&nakedRet.MaxLength, "l", defaultLines, "maximum number of lines for a naked return function")
+	flags.BoolVar(&nakedRet.SkipTestFiles, "skip-test-files", skipTestFiles, "set to true to skip test files")
 	var analyzer = &analysis.Analyzer{
 		Name:     "nakedret",
 		Doc:      "Checks that functions with naked returns are not longer than a maximum size (can be zero).",
@@ -37,7 +38,8 @@ func NakedReturnAnalyzer(defaultLines uint) *analysis.Analyzer {
 }
 
 type NakedReturnRunner struct {
-	MaxLength uint
+	MaxLength     uint
+	SkipTestFiles bool
 }
 
 func (n *NakedReturnRunner) run(pass *analysis.Pass) (any, error) {
@@ -49,18 +51,20 @@ func (n *NakedReturnRunner) run(pass *analysis.Pass) (any, error) {
 		(*ast.ReturnStmt)(nil),
 	}
 	retVis := &returnsVisitor{
-		pass:      pass,
-		f:         pass.Fset,
-		maxLength: n.MaxLength,
+		pass:          pass,
+		f:             pass.Fset,
+		maxLength:     n.MaxLength,
+		skipTestFiles: n.SkipTestFiles,
 	}
 	inspector.Nodes(nodeFilter, retVis.NodesVisit)
 	return nil, nil
 }
 
 type returnsVisitor struct {
-	pass      *analysis.Pass
-	f         *token.FileSet
-	maxLength uint
+	pass          *analysis.Pass
+	f             *token.FileSet
+	maxLength     uint
+	skipTestFiles bool
 
 	// functions contains funcInfo for each nested function definition encountered while visiting the AST.
 	functions []funcInfo
@@ -74,7 +78,7 @@ type funcInfo struct {
 	reportNaked bool
 }
 
-func checkNakedReturns(args []string, maxLength *uint, setExitStatus bool) error {
+func checkNakedReturns(args []string, maxLength *uint, skipTestFiles bool, setExitStatus bool) error {
 
 	fset := token.NewFileSet()
 
@@ -87,7 +91,7 @@ func checkNakedReturns(args []string, maxLength *uint, setExitStatus bool) error
 		return errors.New("max length nil")
 	}
 
-	analyzer := NakedReturnAnalyzer(*maxLength)
+	analyzer := NakedReturnAnalyzer(*maxLength, skipTestFiles)
 	pass := &analysis.Pass{
 		Analyzer: analyzer,
 		Fset:     fset,
@@ -292,6 +296,9 @@ func (v *returnsVisitor) NodesVisit(node ast.Node, push bool) bool {
 	if push && funcType != nil {
 		// Push function info to track returns for this function
 		file := v.f.File(node.Pos())
+		if v.skipTestFiles && strings.HasSuffix(file.Name(), "_test.go") {
+			return false
+		}
 		length := file.Position(node.End()).Line - file.Position(node.Pos()).Line
 		if length == 0 {
 			// consider functions that finish on the same line as they start as single line functions, not zero lines!

nakedret_test.go

@@ -12,8 +12,9 @@ import (
 )
 
 type testParams struct {
-	filename  string
-	maxLength uint
+	filename      string
+	maxLength     uint
+	skipTestFiles bool
 }
 
 var testcases = []struct {
@@ -58,9 +59,22 @@ var testcases = []struct {
 			filename:  "testdata/src/x/nested.go",
 			maxLength: 0,
 		}},
+	{"failing on test files",
+		"testdata/src/x/example_test.go:11: naked return in func `SomeTestHelperFunction` with 3 lines of code\n",
+		testParams{
+			filename:  "testdata/src/x/example_test.go",
+			maxLength: 0,
+		}},
+	{"skipping test files",
+		"",
+		testParams{
+			filename:      "testdata/src/x/example_test.go",
+			maxLength:     0,
+			skipTestFiles: true,
+		}},
 }
 
-func runNakedret(t *testing.T, filename string, maxLength uint, expected string) {
+func runNakedret(t *testing.T, filename string, maxLength uint, skipTestFiles bool, expected string) {
 	t.Helper()
 	defer func() {
 		// Reset logging
@@ -71,7 +85,7 @@ func runNakedret(t *testing.T, filename string, maxLength uint, expected string)
 	log.SetOutput(&logBuf)
 	log.SetFlags(0)
 
-	if err := checkNakedReturns([]string{filename}, &maxLength, false); err != nil {
+	if err := checkNakedReturns([]string{filename}, &maxLength, skipTestFiles, false); err != nil {
 		t.Fatal(err)
 	}
 	actual := logBuf.String()
@@ -83,7 +97,7 @@ func runNakedret(t *testing.T, filename string, maxLength uint, expected string)
 func TestCheckNakedReturns(t *testing.T) {
 	for _, tt := range testcases {
 		t.Run(tt.name, func(t *testing.T) {
-			runNakedret(t, tt.params.filename, tt.params.maxLength, tt.expected)
+			runNakedret(t, tt.params.filename, tt.params.maxLength, tt.params.skipTestFiles, tt.expected)
 		})
 	}
 }
@@ -95,7 +109,7 @@ func TestAll(t *testing.T) {
 	}
 
 	testdata := filepath.Join(wd, "testdata")
-	analysistest.Run(t, testdata, NakedReturnAnalyzer(0), "x")
+	analysistest.Run(t, testdata, NakedReturnAnalyzer(0, true), "x")
 }
 
 func TestAllFixes(t *testing.T) {
@@ -105,5 +119,5 @@ func TestAllFixes(t *testing.T) {
 	}
 
 	testdata := filepath.Join(wd, "testdata")
-	analysistest.RunWithSuggestedFixes(t, testdata, NakedReturnAnalyzer(0), "x")
+	analysistest.RunWithSuggestedFixes(t, testdata, NakedReturnAnalyzer(0, true), "x")
 }

testdata/src/x/example_test.go

@@ -0,0 +1,12 @@
+package x
+
+import "testing"
+
+func TestCheckNakedReturns(t *testing.T) {
+	SomeTestHelperFunction()
+}
+
+func SomeTestHelperFunction() (res string) {
+	res = "res"
+	return
+}