Printing out SuggestedFixes

Author: Sergey Vilgelm

pkg/golinters/goanalysis/linter.go

@@ -144,6 +144,91 @@ func (lnt *Linter) configure() error {
 	return nil
 }
 
+func parseError(srcErr packages.Error) (*result.Issue, error) {
+	pos, err := libpackages.ParseErrorPosition(srcErr.Pos)
+	if err != nil {
+		return nil, err
+	}
+
+	return &result.Issue{
+		Pos:        *pos,
+		Text:       srcErr.Msg,
+		FromLinter: "typecheck",
+	}, nil
+}
+
+func buildIssuesFromErrorsForTypecheckMode(errs []error, lintCtx *linter.Context) ([]result.Issue, error) {
+	var issues []result.Issue
+	uniqReportedIssues := map[string]bool{}
+	for _, err := range errs {
+		itErr, ok := errors.Cause(err).(*IllTypedError)
+		if !ok {
+			return nil, err
+		}
+		for _, err := range libpackages.ExtractErrors(itErr.Pkg) {
+			i, perr := parseError(err)
+			if perr != nil { // failed to parse
+				if uniqReportedIssues[err.Msg] {
+					continue
+				}
+				uniqReportedIssues[err.Msg] = true
+				lintCtx.Log.Errorf("typechecking error: %s", err.Msg)
+			} else {
+				i.Pkg = itErr.Pkg // to save to cache later
+				issues = append(issues, *i)
+			}
+		}
+	}
+	return issues, nil
+}
+
+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)
+
+		var text string
+		if diag.Analyzer.Name == linterName {
+			text = diag.Message
+		} else {
+			text = fmt.Sprintf("%s: %s", diag.Analyzer.Name, diag.Message)
+		}
+
+		var suggestedFixes string
+		if len(diag.SuggestedFixes) > 0 {
+			elems := []string{}
+			for _, fix := range diag.SuggestedFixes {
+				elems = append(elems, fix.Message)
+				for _, text := range fix.TextEdits {
+					elems = append(elems, string(text.NewText))
+				}
+			}
+			suggestedFixes = strings.Join(elems, "\n")
+		}
+
+		issues = append(issues, result.Issue{
+			FromLinter:     linterName,
+			Text:           text,
+			SuggestedFixes: suggestedFixes,
+			Pos:            diag.Position,
+			Pkg:            diag.Pkg,
+		})
+
+		if len(diag.Related) > 0 {
+			for _, info := range diag.Related {
+				issues = append(issues, result.Issue{
+					FromLinter: linterName,
+					Text:       fmt.Sprintf("%s(related information): %s", diag.Analyzer.Name, info.Message),
+					Pos:        diag.Pkg.Fset.Position(info.Pos),
+					Pkg:        diag.Pkg,
+				})
+			}
+		}
+	}
+	return issues
+}
+
 func (lnt *Linter) preRun(lintCtx *linter.Context) error {
 	if err := analysis.Validate(lnt.analyzers); err != nil {
 		return errors.Wrap(err, "failed to validate analyzers")

pkg/printers/text.go

@@ -47,6 +47,7 @@ func (p *Text) Print(ctx context.Context, issues []result.Issue) error {
 
 		p.printSourceCode(&issues[i])
 		p.printUnderLinePointer(&issues[i])
+		p.printSuggestedFixes(&issues[i])
 	}
 
 	return nil
@@ -64,6 +65,13 @@ func (p Text) printIssue(i *result.Issue) {
 	fmt.Fprintf(logutils.StdOut, "%s: %s\n", pos, text)
 }
 
+func (p Text) printSuggestedFixes(i *result.Issue) {
+	suggestedFixes := strings.TrimSpace(i.SuggestedFixes)
+	if suggestedFixes != "" {
+		fmt.Fprintln(logutils.StdOut, suggestedFixes)
+	}
+}
+
 func (p Text) printSourceCode(i *result.Issue) {
 	for _, line := range i.SourceLines {
 		fmt.Fprintln(logutils.StdOut, line)

pkg/result/issue.go

@@ -25,8 +25,9 @@ type InlineFix struct {
 }
 
 type Issue struct {
-	FromLinter string
-	Text       string
+	FromLinter     string
+	Text           string
+	SuggestedFixes string
 
 	Severity string