feat: improve formatter messages (#5243)

Author: ldez

pkg/golinters/gci/internal/analyzer.go

@@ -108,7 +108,7 @@ func runAnalysis(pass *analysis.Pass) (any, error) {
 
 		pass.Report(analysis.Diagnostic{
 			Pos:            fix.TextEdits[0].Pos,
-			Message:        "Invalid import order",
+			Message:        "File is not properly formatted",
 			SuggestedFixes: []analysis.SuggestedFix{*fix},
 		})
 	}

pkg/golinters/gci/testdata/gci.go

@@ -2,7 +2,7 @@
 //golangcitest:config_path testdata/gci.yml
 package testdata
 
-// want +1 "Invalid import order"
+// want +1 "File is not properly formatted"
 import (
 	"golang.org/x/tools/go/analysis"
 	"github.com/golangci/golangci-lint/pkg/config"

pkg/golinters/gci/testdata/gci_cgo.go

@@ -16,7 +16,7 @@ package testdata
 */
 import "C"
 
-// want +1 "Invalid import order"
+// want +1 "File is not properly formatted"
 import (
 	"golang.org/x/tools/go/analysis"
 	"github.com/golangci/golangci-lint/pkg/config"

pkg/golinters/gofmt/gofmt.go

@@ -56,23 +56,11 @@ func runGofmt(lintCtx *linter.Context, pass *analysis.Pass, settings *config.GoF
 			continue
 		}
 
-		err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx, getIssuedTextGoFmt)
+		err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx)
 		if err != nil {
 			return fmt.Errorf("can't extract issues from gofmt diff output %q: %w", string(diff), err)
 		}
 	}
 
 	return nil
 }
-
-func getIssuedTextGoFmt(settings *config.LintersSettings) string {
-	text := "File is not `gofmt`-ed"
-	if settings.Gofmt.Simplify {
-		text += " with `-s`"
-	}
-	for _, rule := range settings.Gofmt.RewriteRules {
-		text += fmt.Sprintf(" `-r '%s -> %s'`", rule.Pattern, rule.Replacement)
-	}
-
-	return text
-}

pkg/golinters/gofmt/testdata/gofmt.go

@@ -5,5 +5,5 @@ import "fmt"
 
 func GofmtNotSimplified() {
 	var x []string
-	fmt.Print(x[1:len(x)]) // want "File is not `gofmt`-ed with `-s`"
+	fmt.Print(x[1:len(x)]) // want "File is not properly formatted"
 }

pkg/golinters/gofmt/testdata/gofmt_cgo.go

@@ -24,5 +24,5 @@ func _() {
 
 func GofmtNotSimplified() {
 	var x []string
-	fmt.Print(x[1:len(x)]) // want "File is not `gofmt`-ed with `-s`"
+	fmt.Print(x[1:len(x)]) // want "File is not properly formatted"
 }

pkg/golinters/gofmt/testdata/gofmt_no_simplify.go

@@ -9,5 +9,5 @@ func GofmtNotSimplifiedOk() {
 	fmt.Print(x[1:len(x)])
 }
 
-func GofmtBadFormat(){  // want "^File is not `gofmt`-ed"
+func GofmtBadFormat(){  // want "File is not properly formatted"
 }

pkg/golinters/gofmt/testdata/gofmt_rewrite_rules.go

@@ -11,7 +11,7 @@ func GofmtRewriteRule() {
 	vals = append(vals, 2)
 	vals = append(vals, 3)
 
-	slice := vals[1:len(vals)] // want "^File is not `gofmt`-ed"
+	slice := vals[1:len(vals)] // want "File is not properly formatted"
 
 	fmt.Println(slice)
 }

pkg/golinters/gofumpt/gofumpt.go

@@ -83,7 +83,7 @@ func runGofumpt(lintCtx *linter.Context, pass *analysis.Pass, diff differ, optio
 
 			diff := out.String()
 
-			err = internal.ExtractDiagnosticFromPatch(pass, file, diff, lintCtx, getIssuedTextGoFumpt)
+			err = internal.ExtractDiagnosticFromPatch(pass, file, diff, lintCtx)
 			if err != nil {
 				return fmt.Errorf("can't extract issues from gofumpt diff output %q: %w", diff, err)
 			}
@@ -101,13 +101,3 @@ func getLangVersion(settings *config.GofumptSettings) string {
 
 	return "go" + strings.TrimPrefix(settings.LangVersion, "go")
 }
-
-func getIssuedTextGoFumpt(settings *config.LintersSettings) string {
-	text := "File is not `gofumpt`-ed"
-
-	if settings.Gofumpt.ExtraRules {
-		text += " with `-extra`"
-	}
-
-	return text
-}

pkg/golinters/gofumpt/testdata/gofumpt.go

@@ -4,5 +4,5 @@ package testdata
 import "fmt"
 
 func GofumptNewLine() {
-	fmt.Println( "foo" ) // want "File is not `gofumpt`-ed"
+	fmt.Println( "foo" ) // want "File is not properly formatted"
 }