feat(linters): add new linter gobreakselectinfor

Author: rnben

.golangci.next.reference.yml

@@ -2620,6 +2620,7 @@ linters:
     - funlen
     - gci
     - ginkgolinter
+    - gobreakselectinfor
     - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits
@@ -2735,6 +2736,7 @@ linters:
     - funlen
     - gci
     - ginkgolinter
+    - gobreakselectinfor
     - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits

jsonschema/golangci.next.jsonschema.json

@@ -324,6 +324,7 @@
             "funlen",
             "gci",
             "ginkgolinter",
+            "gobreakselectinfor",
             "gocheckcompilerdirectives",
             "gochecknoglobals",
             "gochecknoinits",

pkg/golinters/gobreakselectinfor/gobreakselectinfor.go

@@ -0,0 +1,92 @@
+package gobreakselectinfor
+
+import (
+	"go/ast"
+	"go/token"
+	"sync"
+
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/goanalysis"
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+const linterName = "gobreakselectinfor"
+
+func New() *goanalysis.Linter {
+	var mu sync.Mutex
+	var resIssues []goanalysis.Issue
+
+	analyzer := &analysis.Analyzer{
+		Name: linterName,
+		Doc:  goanalysis.TheOnlyanalyzerDoc,
+		Run: func(pass *analysis.Pass) (any, error) {
+			fileIssues := run(pass)
+			res := make([]goanalysis.Issue, 0, len(fileIssues))
+			for i := range fileIssues {
+				res = append(res, goanalysis.NewIssue(&fileIssues[i], pass))
+			}
+			if len(res) == 0 {
+				return nil, nil
+			}
+
+			mu.Lock()
+			resIssues = append(resIssues, res...)
+			mu.Unlock()
+
+			return nil, nil
+		},
+	}
+
+	return goanalysis.NewLinter(
+		linterName,
+		"Checks that break statement inside select statement inside for loop",
+		[]*analysis.Analyzer{analyzer},
+		nil,
+	).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
+		return resIssues
+	}).WithLoadMode(goanalysis.LoadModeSyntax)
+}
+
+func run(pass *analysis.Pass) []result.Issue {
+	var res []result.Issue
+
+	inspect := func(node ast.Node) bool {
+		funcDecl, ok := node.(*ast.FuncDecl)
+		if !ok {
+			return true
+		}
+
+		ast.Inspect(funcDecl.Body, func(stmt ast.Node) bool {
+			if forStmt, ok := stmt.(*ast.ForStmt); ok {
+				ast.Inspect(forStmt.Body, func(stmt ast.Node) bool {
+					if selStmt, ok := stmt.(*ast.SelectStmt); ok {
+						ast.Inspect(selStmt.Body, func(stmt ast.Node) bool {
+							if brkStmt, ok := stmt.(*ast.BranchStmt); ok && brkStmt.Tok == token.BREAK {
+								pass.Reportf(stmt.Pos(), "break statement inside select statement inside for loop")
+								res = append(res, result.Issue{
+									Pos:        pass.Fset.Position(stmt.Pos()),
+									Text:       "break statement inside select statement inside for loop",
+									FromLinter: linterName,
+								})
+								return true
+							}
+							return true
+						})
+					}
+					return true
+				})
+			}
+			return true
+		})
+
+		return true
+	}
+
+	for _, f := range pass.Files {
+		ast.Inspect(f, inspect)
+	}
+
+	return res
+}

pkg/golinters/gobreakselectinfor/gobreakselectinfor_test.go

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

pkg/golinters/gobreakselectinfor/testdata/gobreakselectinfor.go

@@ -0,0 +1,12 @@
+//golangcitest:args -Egobreakselectinfor
+package testdata
+
+func bad() {
+	var ch chan string
+	for {
+		select {
+		case <-ch:
+			break // want "break statement inside select statement inside for loop"
+		}
+	}
+}

pkg/lint/lintersdb/builder_linter.go

@@ -33,6 +33,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/funlen"
 	"github.com/golangci/golangci-lint/pkg/golinters/gci"
 	"github.com/golangci/golangci-lint/pkg/golinters/ginkgolinter"
+	"github.com/golangci/golangci-lint/pkg/golinters/gobreakselectinfor"
 	"github.com/golangci/golangci-lint/pkg/golinters/gocheckcompilerdirectives"
 	"github.com/golangci/golangci-lint/pkg/golinters/gochecknoglobals"
 	"github.com/golangci/golangci-lint/pkg/golinters/gochecknoinits"
@@ -318,6 +319,12 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithPresets(linter.PresetStyle).
 			WithURL("https://github.com/nunnatsa/ginkgolinter"),
 
+		linter.NewConfig(gobreakselectinfor.New()).
+			WithSince("1.61.0").
+			WithPresets(linter.PresetStyle).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/rnben/go-break-select-in-for"),
+
 		linter.NewConfig(gocheckcompilerdirectives.New()).
 			WithSince("v1.51.0").
 			WithPresets(linter.PresetBugs).