Prepare for whitespace linter using the analysis package

The `whitespace` linter is rewritten to use `annalysis.Analyzer`. This
PR will make use of the new code.

Author: bombsimon

pkg/golinters/whitespace.go

@@ -2,7 +2,6 @@ package golinters
 
 import (
 	"fmt"
-	"go/token"
 	"sync"
 
 	"github.com/ultraware/whitespace"
@@ -14,8 +13,6 @@ import (
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
-const whitespaceName = "whitespace"
-
 //nolint:dupl
 func NewWhitespace(settings *config.WhitespaceSettings) *goanalysis.Linter {
 	var mu sync.Mutex
@@ -24,27 +21,58 @@ func NewWhitespace(settings *config.WhitespaceSettings) *goanalysis.Linter {
 	var wsSettings whitespace.Settings
 	if settings != nil {
 		wsSettings = whitespace.Settings{
+			Mode:      whitespace.RunningModeGolangCI,
 			MultiIf:   settings.MultiIf,
 			MultiFunc: settings.MultiFunc,
 		}
 	}
 
-	analyzer := &analysis.Analyzer{
-		Name: whitespaceName,
-		Doc:  goanalysis.TheOnlyanalyzerDoc,
-		Run:  goanalysis.DummyRun,
-	}
+	whitespaceAnalyzer := whitespace.NewAnalyzer(&wsSettings)
 
 	return goanalysis.NewLinter(
-		whitespaceName,
-		"Tool for detection of leading and trailing whitespace",
-		[]*analysis.Analyzer{analyzer},
+		whitespaceAnalyzer.Name,
+		whitespaceAnalyzer.Doc,
+		[]*analysis.Analyzer{whitespaceAnalyzer},
 		nil,
 	).WithContextSetter(func(lintCtx *linter.Context) {
-		analyzer.Run = func(pass *analysis.Pass) (any, error) {
-			issues, err := runWhitespace(lintCtx, pass, wsSettings)
-			if err != nil {
-				return nil, err
+		whitespaceAnalyzer.Run = func(pass *analysis.Pass) (any, error) {
+			whitespaceIssues := whitespace.Run(pass, &wsSettings)
+			issues := make([]goanalysis.Issue, len(whitespaceIssues))
+
+			for i, issue := range whitespaceIssues {
+				report := &result.Issue{
+					FromLinter: whitespaceAnalyzer.Name,
+					Pos:        pass.Fset.PositionFor(issue.Diagnostic, false),
+					Text:       issue.Message,
+				}
+
+				switch issue.MessageType {
+				case whitespace.MessageTypeRemove:
+					report.LineRange = &result.Range{
+						From: issue.LineNumber,
+						To:   issue.LineNumber,
+					}
+
+					report.Replacement = &result.Replacement{
+						NeedOnlyDelete: true,
+					}
+
+				case whitespace.MessageTypeAdd:
+					position := pass.Fset.PositionFor(issue.Diagnostic, false)
+					bracketLine, err := lintCtx.LineCache.GetLine(position.Filename, position.Line)
+					if err != nil {
+						return nil, fmt.Errorf("failed to get line %s:%d: %w", position.Filename, position.Line, err)
+					}
+
+					report.Replacement = &result.Replacement{
+						NewLines: []string{bracketLine + "\n"},
+					}
+
+				default:
+					return nil, fmt.Errorf("unknown message type: %v", issue.MessageType)
+				}
+
+				issues[i] = goanalysis.NewIssue(report, pass)
 			}
 
 			if len(issues) == 0 {
@@ -61,48 +89,3 @@ func NewWhitespace(settings *config.WhitespaceSettings) *goanalysis.Linter {
 		return resIssues
 	}).WithLoadMode(goanalysis.LoadModeSyntax)
 }
-
-func runWhitespace(lintCtx *linter.Context, pass *analysis.Pass, wsSettings whitespace.Settings) ([]goanalysis.Issue, error) {
-	var messages []whitespace.Message
-	for _, file := range pass.Files {
-		messages = append(messages, whitespace.Run(file, pass.Fset, wsSettings)...)
-	}
-
-	if len(messages) == 0 {
-		return nil, nil
-	}
-
-	issues := make([]goanalysis.Issue, len(messages))
-	for k, i := range messages {
-		issue := result.Issue{
-			Pos: token.Position{
-				Filename: i.Pos.Filename,
-				Line:     i.Pos.Line,
-			},
-			LineRange:   &result.Range{From: i.Pos.Line, To: i.Pos.Line},
-			Text:        i.Message,
-			FromLinter:  whitespaceName,
-			Replacement: &result.Replacement{},
-		}
-
-		bracketLine, err := lintCtx.LineCache.GetLine(issue.Pos.Filename, issue.Pos.Line)
-		if err != nil {
-			return nil, fmt.Errorf("failed to get line %s:%d: %w", issue.Pos.Filename, issue.Pos.Line, err)
-		}
-
-		switch i.Type {
-		case whitespace.MessageTypeLeading:
-			issue.LineRange.To++ // cover two lines by the issue: opening bracket "{" (issue.Pos.Line) and following empty line
-		case whitespace.MessageTypeTrailing:
-			issue.LineRange.From-- // cover two lines by the issue: closing bracket "}" (issue.Pos.Line) and preceding empty line
-			issue.Pos.Line--       // set in sync with LineRange.From to not break fixer and other code features
-		case whitespace.MessageTypeAddAfter:
-			bracketLine += "\n"
-		}
-		issue.Replacement.NewLines = []string{bracketLine}
-
-		issues[k] = goanalysis.NewIssue(&issue, pass)
-	}
-
-	return issues, nil
-}

test/testdata/fix/in/whitespace.go

@@ -5,6 +5,7 @@ package p
 
 import "fmt"
 
+//line yaccpar:1
 func oneLeadingNewline() {
 
 	fmt.Println("Hello world")

test/testdata/fix/out/whitespace.go

@@ -5,6 +5,7 @@ package p
 
 import "fmt"
 
+//line yaccpar:1
 func oneLeadingNewline() {
 	fmt.Println("Hello world")
 }