chore: migrate LLL

Author: ldez

pkg/golinters/lll/lll.go

@@ -4,46 +4,31 @@ import (
 	"bufio"
 	"errors"
 	"fmt"
-	"go/token"
+	"go/ast"
 	"os"
 	"strings"
-	"sync"
 	"unicode/utf8"
 
 	"golang.org/x/tools/go/analysis"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
-	"github.com/golangci/golangci-lint/pkg/golinters/internal"
-	"github.com/golangci/golangci-lint/pkg/lint/linter"
-	"github.com/golangci/golangci-lint/pkg/result"
 )
 
 const linterName = "lll"
 
 const goCommentDirectivePrefix = "//go:"
 
 func New(settings *config.LllSettings) *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) {
-			issues, err := runLll(pass, settings)
+			err := runLll(pass, settings)
 			if err != nil {
 				return nil, err
 			}
 
-			if len(issues) == 0 {
-				return nil, nil
-			}
-
-			mu.Lock()
-			resIssues = append(resIssues, issues...)
-			mu.Unlock()
-
 			return nil, nil
 		},
 	}
@@ -53,40 +38,35 @@ func New(settings *config.LllSettings) *goanalysis.Linter {
 		"Reports long lines",
 		[]*analysis.Analyzer{analyzer},
 		nil,
-	).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
-		return resIssues
-	}).WithLoadMode(goanalysis.LoadModeSyntax)
+	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
 
-func runLll(pass *analysis.Pass, settings *config.LllSettings) ([]goanalysis.Issue, error) {
-	fileNames := internal.GetFileNames(pass)
-
+func runLll(pass *analysis.Pass, settings *config.LllSettings) error {
 	spaces := strings.Repeat(" ", settings.TabWidth)
 
-	var issues []goanalysis.Issue
-	for _, f := range fileNames {
-		lintIssues, err := getLLLIssuesForFile(f, settings.LineLength, spaces)
+	for _, file := range pass.Files {
+		err := getLLLIssuesForFile(pass, file, settings.LineLength, spaces)
 		if err != nil {
-			return nil, err
-		}
-
-		for i := range lintIssues {
-			issues = append(issues, goanalysis.NewIssue(&lintIssues[i], pass))
+			return err
 		}
 	}
 
-	return issues, nil
+	return nil
 }
 
-func getLLLIssuesForFile(filename string, maxLineLen int, tabSpaces string) ([]result.Issue, error) {
-	var res []result.Issue
+func getLLLIssuesForFile(pass *analysis.Pass, file *ast.File, maxLineLen int, tabSpaces string) error {
+	position := goanalysis.GetFilePosition(pass, file)
+	nonAdjPosition := pass.Fset.PositionFor(file.Pos(), false)
 
-	f, err := os.Open(filename)
+	f, err := os.Open(position.Filename)
 	if err != nil {
-		return nil, fmt.Errorf("can't open file %s: %w", filename, err)
+		return fmt.Errorf("can't open file %s: %w", position.Filename, err)
 	}
+
 	defer f.Close()
 
+	ft := pass.Fset.File(file.Pos())
+
 	lineNumber := 0
 	multiImportEnabled := false
 
@@ -116,42 +96,34 @@ func getLLLIssuesForFile(filename string, maxLineLen int, tabSpaces string) ([]r
 
 		lineLen := utf8.RuneCountInString(line)
 		if lineLen > maxLineLen {
-			res = append(res, result.Issue{
-				Pos: token.Position{
-					Filename: filename,
-					Line:     lineNumber,
-				},
-				Text:       fmt.Sprintf("the line is %d characters long, which exceeds the maximum of %d characters.", lineLen, maxLineLen),
-				FromLinter: linterName,
+			pass.Report(analysis.Diagnostic{
+				Pos: ft.LineStart(goanalysis.AdjustPos(lineNumber, nonAdjPosition.Line, position.Line)),
+				Message: fmt.Sprintf("The line is %d characters long, which exceeds the maximum of %d characters.",
+					lineLen, maxLineLen),
 			})
 		}
 	}
 
 	if err := scanner.Err(); err != nil {
+		// scanner.Scan() might fail if the line is longer than bufio.MaxScanTokenSize
+		// In the case where the specified maxLineLen is smaller than bufio.MaxScanTokenSize
+		// we can return this line as a long line instead of returning an error.
+		// The reason for this change is that this case might happen with autogenerated files
+		// The go-bindata tool for instance might generate a file with a very long line.
+		// In this case, as it's an auto generated file, the warning returned by lll will
+		// be ignored.
+		// But if we return a linter error here, and this error happens for an autogenerated
+		// file the error will be discarded (fine), but all the subsequent errors for lll will
+		// be discarded for other files, and we'll miss legit error.
 		if errors.Is(err, bufio.ErrTooLong) && maxLineLen < bufio.MaxScanTokenSize {
-			// scanner.Scan() might fail if the line is longer than bufio.MaxScanTokenSize
-			// In the case where the specified maxLineLen is smaller than bufio.MaxScanTokenSize
-			// we can return this line as a long line instead of returning an error.
-			// The reason for this change is that this case might happen with autogenerated files
-			// The go-bindata tool for instance might generate a file with a very long line.
-			// In this case, as it's an auto generated file, the warning returned by lll will
-			// be ignored.
-			// But if we return a linter error here, and this error happens for an autogenerated
-			// file the error will be discarded (fine), but all the subsequent errors for lll will
-			// be discarded for other files, and we'll miss legit error.
-			res = append(res, result.Issue{
-				Pos: token.Position{
-					Filename: filename,
-					Line:     lineNumber,
-					Column:   1,
-				},
-				Text:       fmt.Sprintf("line is more than %d characters", bufio.MaxScanTokenSize),
-				FromLinter: linterName,
+			pass.Report(analysis.Diagnostic{
+				Pos:     ft.LineStart(goanalysis.AdjustPos(lineNumber, nonAdjPosition.Line, position.Line)),
+				Message: fmt.Sprintf("line is more than %d characters", bufio.MaxScanTokenSize),
 			})
 		} else {
-			return nil, fmt.Errorf("can't scan file %s: %w", filename, err)
+			return fmt.Errorf("can't scan file %s: %w", position.Filename, err)
 		}
 	}
 
-	return res, nil
+	return nil
 }

pkg/golinters/lll/testdata/lll.go

@@ -7,7 +7,8 @@ import (
 )
 
 func Lll() {
-	// In my experience, long lines are the lines with comments, not the code. So this is a long comment // want "line is 137 characters"
+	// want +1 "line is 141 characters"
+	// In my experience, long lines are the lines with comments, not the code. So this is a long comment, a very long comment, yes very long.
 }
 
 //go:generate mockgen -source lll.go -destination a_verylong_generate_mock_my_lll_interface.go --package testdata -self_package github.com/golangci/golangci-lint/test/testdata

pkg/golinters/lll/testdata/lll_max_scan_token_size.go

@@ -216,7 +216,7 @@ func TestLineDirective(t *testing.T) {
 			},
 			configPath: "testdata/linedirective/lll.yml",
 			targetPath: "linedirective",
-			expected:   "the line is 57 characters long, which exceeds the maximum of 50 characters. (lll)",
+			expected:   "The line is 57 characters long, which exceeds the maximum of 50 characters. (lll)",
 		},
 		{
 			desc: "misspell",