feat: add support for SuggestedFixes

pkg/goanalysis/issue.go

@@ -26,7 +26,7 @@ type EncodingIssue struct {
 	Severity             string
 	Pos                  token.Position
 	LineRange            *result.Range
-	Replacement          *result.Replacement
+	SuggestedFixes       []analysis.SuggestedFix
 	ExpectNoLint         bool
 	ExpectedNoLintLinter string
 }

pkg/goanalysis/runner.go

@@ -42,6 +42,7 @@ type Diagnostic struct {
 	Analyzer *analysis.Analyzer
 	Position token.Position
 	Pkg      *packages.Package
+	File     *token.File
 }
 
 type runner struct {
@@ -312,17 +313,20 @@ func extractDiagnostics(roots []*action) (retDiags []Diagnostic, retErrors []err
 				// We don't display a.Name/f.Category
 				// as most users don't care.
 
-				posn := act.Package.Fset.Position(diag.Pos)
-				k := key{posn, act.Analyzer, diag.Message}
+				position := GetFilePositionFor(act.Package.Fset, diag.Pos)
+				file := act.Package.Fset.File(diag.Pos)
+
+				k := key{Position: position, Analyzer: act.Analyzer, message: diag.Message}
 				if seen[k] {
 					continue // duplicate
 				}
 				seen[k] = true
 
 				retDiag := Diagnostic{
+					File:       file,
 					Diagnostic: diag,
 					Analyzer:   act.Analyzer,
-					Position:   posn,
+					Position:   position,
 					Pkg:        act.Package,
 				}
 				retDiags = append(retDiags, retDiag)

pkg/goanalysis/runners.go

@@ -2,6 +2,7 @@ package goanalysis
 
 import (
 	"fmt"
+	"go/token"
 
 	"golang.org/x/tools/go/analysis"
 	"golang.org/x/tools/go/packages"
@@ -81,6 +82,7 @@ func runAnalyzers(cfg runAnalyzersConfig, lintCtx *linter.Context) ([]result.Iss
 
 func buildIssues(diags []Diagnostic, linterNameBuilder func(diag *Diagnostic) string) []result.Issue {
 	var issues []result.Issue
+
 	for i := range diags {
 		diag := &diags[i]
 		linterName := linterNameBuilder(diag)
@@ -92,11 +94,34 @@ func buildIssues(diags []Diagnostic, linterNameBuilder func(diag *Diagnostic) st
 			text = fmt.Sprintf("%s: %s", diag.Analyzer.Name, diag.Message)
 		}
 
+		var suggestedFixes []analysis.SuggestedFix
+
+		for _, sf := range diag.SuggestedFixes {
+			nsf := analysis.SuggestedFix{Message: sf.Message}
+
+			for _, edit := range sf.TextEdits {
+				end := edit.End
+
+				if !end.IsValid() {
+					end = edit.Pos
+				}
+
+				nsf.TextEdits = append(nsf.TextEdits, analysis.TextEdit{
+					Pos:     token.Pos(diag.File.Offset(edit.Pos)),
+					End:     token.Pos(diag.File.Offset(end)),
+					NewText: edit.NewText,
+				})
+			}
+
+			suggestedFixes = append(suggestedFixes, nsf)
+		}
+
 		issues = append(issues, result.Issue{
-			FromLinter: linterName,
-			Text:       text,
-			Pos:        diag.Position,
-			Pkg:        diag.Pkg,
+			FromLinter:     linterName,
+			Text:           text,
+			Pos:            diag.Position,
+			Pkg:            diag.Pkg,
+			SuggestedFixes: suggestedFixes,
 		})
 
 		if len(diag.Related) > 0 {

pkg/goanalysis/runners_cache.go

@@ -48,7 +48,7 @@ func saveIssuesToCache(allPkgs []*packages.Package, pkgsFromCache map[*packages.
 						Severity:             i.Severity,
 						Pos:                  i.Pos,
 						LineRange:            i.LineRange,
-						Replacement:          i.Replacement,
+						SuggestedFixes:       i.SuggestedFixes,
 						ExpectNoLint:         i.ExpectNoLint,
 						ExpectedNoLintLinter: i.ExpectedNoLintLinter,
 					})
@@ -123,7 +123,7 @@ func loadIssuesFromCache(pkgs []*packages.Package, lintCtx *linter.Context,
 						Severity:             issue.Severity,
 						Pos:                  issue.Pos,
 						LineRange:            issue.LineRange,
-						Replacement:          issue.Replacement,
+						SuggestedFixes:       issue.SuggestedFixes,
 						Pkg:                  pkg,
 						ExpectNoLint:         issue.ExpectNoLint,
 						ExpectedNoLintLinter: issue.ExpectedNoLintLinter,

pkg/printers/json_test.go

@@ -49,7 +49,7 @@ func TestJSON_Print(t *testing.T) {
 	err := printer.Print(issues)
 	require.NoError(t, err)
 
-	expected := `{"Issues":[{"FromLinter":"linter-a","Text":"some issue","Severity":"warning","SourceLines":null,"Replacement":null,"Pos":{"Filename":"path/to/filea.go","Offset":2,"Line":10,"Column":4},"ExpectNoLint":false,"ExpectedNoLintLinter":""},{"FromLinter":"linter-b","Text":"another issue","Severity":"error","SourceLines":["func foo() {","\tfmt.Println(\"bar\")","}"],"Replacement":null,"Pos":{"Filename":"path/to/fileb.go","Offset":5,"Line":300,"Column":9},"ExpectNoLint":false,"ExpectedNoLintLinter":""}],"Report":null}
+	expected := `{"Issues":[{"FromLinter":"linter-a","Text":"some issue","Severity":"warning","SourceLines":null,"Pos":{"Filename":"path/to/filea.go","Offset":2,"Line":10,"Column":4},"ExpectNoLint":false,"ExpectedNoLintLinter":""},{"FromLinter":"linter-b","Text":"another issue","Severity":"error","SourceLines":["func foo() {","\tfmt.Println(\"bar\")","}"],"Pos":{"Filename":"path/to/fileb.go","Offset":5,"Line":300,"Column":9},"ExpectNoLint":false,"ExpectedNoLintLinter":""}],"Report":null}
 `
 
 	assert.Equal(t, expected, buf.String())

pkg/printers/testdata/in-issues.json

@@ -6,7 +6,6 @@
       "SourceLines": [
         "func init() {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/experimental/myplugin/myplugin.go",
         "Offset": 162,
@@ -23,7 +22,6 @@
       "SourceLines": [
         "func (b *PluginBuilder) loadConfig(cfg *config.Config, name string, settings config.CustomLinterSettings) (*linter.Config, error) {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/lint/lintersdb/builder_plugin.go",
         "Offset": 1480,
@@ -40,15 +38,18 @@
       "SourceLines": [
         ""
       ],
-      "Replacement": {
-        "NeedOnlyDelete": false,
-        "NewLines": [
-          "",
-          "\t\"github.com/stretchr/testify/require\"",
-          ""
-        ],
-        "Inline": null
-      },
+      "SuggestedFixes": [
+        {
+          "Message": "",
+          "TextEdits": [
+            {
+              "Pos": 13,
+              "End": 32,
+              "NewText": null
+            }
+          ]
+        }
+      ],
       "Pos": {
         "Filename": "pkg/printers/printer_test.go",
         "Offset": 0,
@@ -65,7 +66,6 @@
       "SourceLines": [
         "type Issues struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/issues.go",
         "Offset": 3338,
@@ -82,7 +82,6 @@
       "SourceLines": [
         "type LintersSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 4576,
@@ -99,7 +98,6 @@
       "SourceLines": [
         "type ExhaustiveSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 10829,
@@ -116,7 +114,6 @@
       "SourceLines": [
         "type GoConstSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 14399,
@@ -133,7 +130,6 @@
       "SourceLines": [
         "type GoCriticSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 14934,
@@ -150,7 +146,6 @@
       "SourceLines": [
         "type GosmopolitanSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 18601,
@@ -167,7 +162,6 @@
       "SourceLines": [
         "type GovetSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 18867,
@@ -184,7 +178,6 @@
       "SourceLines": [
         "type NoLintLintSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 22337,
@@ -201,7 +194,6 @@
       "SourceLines": [
         "type ReviveSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 24019,
@@ -218,7 +210,6 @@
       "SourceLines": [
         "type SlogLintSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 24648,
@@ -235,7 +226,6 @@
       "SourceLines": [
         "type TagAlignSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 25936,
@@ -252,7 +242,6 @@
       "SourceLines": [
         "type VarnamelenSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 28758,
@@ -269,7 +258,6 @@
       "SourceLines": [
         "type WSLSettings struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/linters_settings.go",
         "Offset": 29898,
@@ -286,7 +274,6 @@
       "SourceLines": [
         "type Run struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/config/run.go",
         "Offset": 112,
@@ -303,7 +290,6 @@
       "SourceLines": [
         "type Config struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/lint/linter/config.go",
         "Offset": 1329,
@@ -320,7 +306,6 @@
       "SourceLines": [
         "\tfor _, tc := range []struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/golinters/govet_test.go",
         "Offset": 1804,
@@ -337,7 +322,6 @@
       "SourceLines": [
         "type Diff struct {"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/result/processors/diff.go",
         "Offset": 233,
@@ -354,7 +338,6 @@
       "SourceLines": [
         "\t\t\tRun: func(pass *analysis.Pass) (any, error) {"
       ],
-      "Replacement": null,
       "LineRange": {
         "From": 49,
         "To": 49
@@ -375,7 +358,6 @@
       "SourceLines": [
         "const defaultFileMode = 0644"
       ],
-      "Replacement": null,
       "Pos": {
         "Filename": "pkg/commands/run.go",
         "Offset": 1209,

pkg/result/issue.go

@@ -5,25 +5,14 @@ import (
 	"fmt"
 	"go/token"
 
+	"golang.org/x/tools/go/analysis"
 	"golang.org/x/tools/go/packages"
 )
 
 type Range struct {
 	From, To int
 }
 
-type Replacement struct {
-	NeedOnlyDelete bool     // need to delete all lines of the issue without replacement with new lines
-	NewLines       []string // if NeedDelete is false it's the replacement lines
-	Inline         *InlineFix
-}
-
-type InlineFix struct {
-	StartCol  int // zero-based
-	Length    int // length of chunk to be replaced
-	NewString string
-}
-
 type Issue struct {
 	FromLinter string
 	Text       string
@@ -33,19 +22,19 @@ type Issue struct {
 	// Source lines of a code with the issue to show
 	SourceLines []string
 
-	// If we know how to fix the issue we can provide replacement lines
-	Replacement *Replacement
-
 	// Pkg is needed for proper caching of linting results
 	Pkg *packages.Package `json:"-"`
 
-	LineRange *Range `json:",omitempty"`
-
 	Pos token.Position
 
+	LineRange *Range `json:",omitempty"`
+
 	// HunkPos is used only when golangci-lint is run over a diff
 	HunkPos int `json:",omitempty"`
 
+	// If we know how to fix the issue we can provide replacement lines
+	SuggestedFixes []analysis.SuggestedFix `json:",omitempty"`
+
 	// If we are expecting a nolint (because this is from nolintlint), record the expected linter
 	ExpectNoLint         bool
 	ExpectedNoLintLinter string