Skip to content

Commit f996a66

Browse files
ldezldez
authored
feat: improve formatter messages (#5243)
1 parent c16fb19 commit f996a66

18 files changed

+22
-58
lines changed

‎pkg/golinters/gci/internal/analyzer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ func runAnalysis(pass *analysis.Pass) (any, error) {
108108

109109
pass.Report(analysis.Diagnostic{
110110
Pos: fix.TextEdits[0].Pos,
111-
Message: "Invalid import order",
111+
Message: "File is not properly formatted",
112112
SuggestedFixes: []analysis.SuggestedFix{*fix},
113113
})
114114
}

‎pkg/golinters/gci/testdata/gci.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//golangcitest:config_path testdata/gci.yml
33
package testdata
44

5-
// want +1 "Invalid import order"
5+
// want +1 "File is not properly formatted"
66
import (
77
"golang.org/x/tools/go/analysis"
88
"github.com/golangci/golangci-lint/pkg/config"

‎pkg/golinters/gci/testdata/gci_cgo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ package testdata
1616
*/
1717
import "C"
1818

19-
// want +1 "Invalid import order"
19+
// want +1 "File is not properly formatted"
2020
import (
2121
"golang.org/x/tools/go/analysis"
2222
"github.com/golangci/golangci-lint/pkg/config"

‎pkg/golinters/gofmt/gofmt.go

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,11 @@ func runGofmt(lintCtx *linter.Context, pass *analysis.Pass, settings *config.GoF
5656
continue
5757
}
5858

59-
err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx, getIssuedTextGoFmt)
59+
err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx)
6060
if err != nil {
6161
return fmt.Errorf("can't extract issues from gofmt diff output %q: %w", string(diff), err)
6262
}
6363
}
6464

6565
return nil
6666
}
67-
68-
func getIssuedTextGoFmt(settings *config.LintersSettings) string {
69-
text := "File is not `gofmt`-ed"
70-
if settings.Gofmt.Simplify {
71-
text += " with `-s`"
72-
}
73-
for _, rule := range settings.Gofmt.RewriteRules {
74-
text += fmt.Sprintf(" `-r '%s -> %s'`", rule.Pattern, rule.Replacement)
75-
}
76-
77-
return text
78-
}

‎pkg/golinters/gofmt/testdata/gofmt.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ import "fmt"
55

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

‎pkg/golinters/gofmt/testdata/gofmt_cgo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ func _() {
2424

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

‎pkg/golinters/gofmt/testdata/gofmt_no_simplify.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ func GofmtNotSimplifiedOk() {
99
fmt.Print(x[1:len(x)])
1010
}
1111

12-
func GofmtBadFormat(){ // want "^File is not `gofmt`-ed"
12+
func GofmtBadFormat(){ // want "File is not properly formatted"
1313
}

‎pkg/golinters/gofmt/testdata/gofmt_rewrite_rules.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ func GofmtRewriteRule() {
1111
vals = append(vals, 2)
1212
vals = append(vals, 3)
1313

14-
slice := vals[1:len(vals)] // want "^File is not `gofmt`-ed"
14+
slice := vals[1:len(vals)] // want "File is not properly formatted"
1515

1616
fmt.Println(slice)
1717
}

‎pkg/golinters/gofumpt/gofumpt.go

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func runGofumpt(lintCtx *linter.Context, pass *analysis.Pass, diff differ, optio
8383

8484
diff := out.String()
8585

86-
err = internal.ExtractDiagnosticFromPatch(pass, file, diff, lintCtx, getIssuedTextGoFumpt)
86+
err = internal.ExtractDiagnosticFromPatch(pass, file, diff, lintCtx)
8787
if err != nil {
8888
return fmt.Errorf("can't extract issues from gofumpt diff output %q: %w", diff, err)
8989
}
@@ -101,13 +101,3 @@ func getLangVersion(settings *config.GofumptSettings) string {
101101

102102
return "go" + strings.TrimPrefix(settings.LangVersion, "go")
103103
}
104-
105-
func getIssuedTextGoFumpt(settings *config.LintersSettings) string {
106-
text := "File is not `gofumpt`-ed"
107-
108-
if settings.Gofumpt.ExtraRules {
109-
text += " with `-extra`"
110-
}
111-
112-
return text
113-
}

‎pkg/golinters/gofumpt/testdata/gofumpt.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ package testdata
44
import "fmt"
55

66
func GofumptNewLine() {
7-
fmt.Println( "foo" ) // want "File is not `gofumpt`-ed"
7+
fmt.Println( "foo" ) // want "File is not properly formatted"
88
}

‎pkg/golinters/gofumpt/testdata/gofumpt_cgo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ func _() {
2323
}
2424

2525
func GofumptNewLine() {
26-
fmt.Println( "foo" ) // want "File is not `gofumpt`-ed"
26+
fmt.Println( "foo" ) // want "File is not properly formatted"
2727
}

‎pkg/golinters/gofumpt/testdata/gofumpt_with_extra.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ package testdata
44

55
import "fmt"
66

7-
func GofmtNotExtra(bar string, baz string) { // want "File is not `gofumpt`-ed with `-extra`"
7+
func GofmtNotExtra(bar string, baz string) { // want "File is not properly formatted"
88
fmt.Print("foo")
99
}

‎pkg/golinters/goimports/goimports.go

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,21 +54,11 @@ func runGoImports(lintCtx *linter.Context, pass *analysis.Pass) error {
5454
continue
5555
}
5656

57-
err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx, getIssuedTextGoImports)
57+
err = internal.ExtractDiagnosticFromPatch(pass, file, string(diff), lintCtx)
5858
if err != nil {
5959
return fmt.Errorf("can't extract issues from gofmt diff output %q: %w", string(diff), err)
6060
}
6161
}
6262

6363
return nil
6464
}
65-
66-
func getIssuedTextGoImports(settings *config.LintersSettings) string {
67-
text := "File is not `goimports`-ed"
68-
69-
if settings.Goimports.LocalPrefixes != "" {
70-
text += " with -local " + settings.Goimports.LocalPrefixes
71-
}
72-
73-
return text
74-
}

‎pkg/golinters/goimports/testdata/goimports.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
package testdata
33

44
import (
5-
"fmt" // want "File is not `goimports`-ed"
5+
"fmt" // want "File is not properly formatted"
66
"github.com/golangci/golangci-lint/pkg/config"
77
)
88

‎pkg/golinters/goimports/testdata/goimports_cgo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import "C"
1313

1414
import (
1515
"fmt"
16-
"unsafe" // want "File is not `goimports`-ed"
16+
"unsafe" // want "File is not properly formatted"
1717
"github.com/golangci/golangci-lint/pkg/config"
1818
)
1919

‎pkg/golinters/goimports/testdata/goimports_local.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package testdata
55
import (
66
"fmt"
77

8-
"github.com/golangci/golangci-lint/pkg/config" // want "File is not `goimports`-ed with -local github.com/golangci/golangci-lint"
8+
"github.com/golangci/golangci-lint/pkg/config" // want "File is not properly formatted"
99
"golang.org/x/tools/go/analysis"
1010
)
1111

‎pkg/golinters/internal/diff.go

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111
diffpkg "github.com/sourcegraph/go-diff/diff"
1212
"golang.org/x/tools/go/analysis"
1313

14-
"github.com/golangci/golangci-lint/pkg/config"
1514
"github.com/golangci/golangci-lint/pkg/goanalysis"
1615
"github.com/golangci/golangci-lint/pkg/lint/linter"
1716
"github.com/golangci/golangci-lint/pkg/logutils"
@@ -30,8 +29,6 @@ const (
3029
diffLineDeleted diffLineType = "deleted"
3130
)
3231

33-
type fmtTextFormatter func(settings *config.LintersSettings) string
34-
3532
type diffLine struct {
3633
originalNumber int // 1-based original line number
3734
typ diffLineType
@@ -219,7 +216,6 @@ func ExtractDiagnosticFromPatch(
219216
file *ast.File,
220217
patch string,
221218
lintCtx *linter.Context,
222-
formatter fmtTextFormatter,
223219
) error {
224220
diffs, err := diffpkg.ParseMultiFileDiff([]byte(patch))
225221
if err != nil {
@@ -246,23 +242,23 @@ func ExtractDiagnosticFromPatch(
246242
changes := p.parse(hunk)
247243

248244
for _, change := range changes {
249-
pass.Report(toDiagnostic(ft, change, formatter(lintCtx.Settings()), adjLine))
245+
pass.Report(toDiagnostic(ft, change, adjLine))
250246
}
251247
}
252248
}
253249

254250
return nil
255251
}
256252

257-
func toDiagnostic(ft *token.File, change Change, message string, adjLine int) analysis.Diagnostic {
253+
func toDiagnostic(ft *token.File, change Change, adjLine int) analysis.Diagnostic {
258254
start := ft.LineStart(change.From + adjLine)
259255

260256
end := goanalysis.EndOfLinePos(ft, change.To+adjLine)
261257

262258
return analysis.Diagnostic{
263259
Pos: start,
264260
End: end,
265-
Message: message, // TODO(ldez) change message formatter to have a better message.
261+
Message: "File is not properly formatted",
266262
SuggestedFixes: []analysis.SuggestedFix{{
267263
TextEdits: []analysis.TextEdit{{
268264
Pos: start,

‎test/run_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ func TestCgoWithIssues(t *testing.T) {
133133
desc: "gofmt",
134134
args: []string{"--no-config", "--disable-all", "-Egofmt"},
135135
dir: "cgo_with_issues",
136-
expected: "File is not `gofmt`-ed with `-s` (gofmt)",
136+
expected: "File is not properly formatted (gofmt)",
137137
},
138138
{
139139
desc: "revive",
@@ -186,7 +186,7 @@ func TestLineDirective(t *testing.T) {
186186
"--disable-all",
187187
},
188188
targetPath: "linedirective",
189-
expected: "File is not `gofmt`-ed with `-s` (gofmt)",
189+
expected: "File is not properly formatted (gofmt)",
190190
},
191191
{
192192
desc: "goimports",
@@ -195,7 +195,7 @@ func TestLineDirective(t *testing.T) {
195195
"--disable-all",
196196
},
197197
targetPath: "linedirective",
198-
expected: "File is not `goimports`-ed (goimports)",
198+
expected: "File is not properly formatted (goimports)",
199199
},
200200
{
201201
desc: "gomodguard",

0 commit comments

Comments
 (0)