9181ca7175
1. Log all warnings, don't hide none of them 2. Write fatal messages (stop analysis) with error log level 3. Remove ugly timestamp counter from logrus output 4. Print nested module prefix in log 5. Make logger abstraction: no global logging anymore 6. Refactor config reading to config.FileReader struct to avoid passing logger into every function 7. Replace exit codes hardcoding with constants in exitcodes package 8. Fail test if any warning was logged 9. Fix calculation of relative path if we analyze parent dir ../ 10. Move Runner initialization from Executor to NewRunner func 11. Log every AST parsing error 12. Properly print used config file path in verbose mode 13. Print package files if only 1 package is analyzedin verbose mode, print not compiling packages in verbose mode 14. Forbid usage of github.com/sirupsen/logrus by DepGuard linter 15. Add default ignore pattern to folint: "comment on exported const"
132 lines
3.0 KiB
Go
132 lines
3.0 KiB
Go
package golinters
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"go/token"
|
|
|
|
gofmtAPI "github.com/golangci/gofmt/gofmt"
|
|
goimportsAPI "github.com/golangci/gofmt/goimports"
|
|
"github.com/golangci/golangci-lint/pkg/lint/linter"
|
|
"github.com/golangci/golangci-lint/pkg/logutils"
|
|
"github.com/golangci/golangci-lint/pkg/result"
|
|
"sourcegraph.com/sourcegraph/go-diff/diff"
|
|
)
|
|
|
|
type Gofmt struct {
|
|
UseGoimports bool
|
|
}
|
|
|
|
func (g Gofmt) Name() string {
|
|
if g.UseGoimports {
|
|
return "goimports"
|
|
}
|
|
|
|
return "gofmt"
|
|
}
|
|
|
|
func (g Gofmt) Desc() string {
|
|
if g.UseGoimports {
|
|
return "Goimports does everything that gofmt does. Additionally it checks unused imports"
|
|
}
|
|
|
|
return "Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification"
|
|
}
|
|
|
|
func getFirstDeletedAndAddedLineNumberInHunk(h *diff.Hunk) (int, int, error) {
|
|
lines := bytes.Split(h.Body, []byte{'\n'})
|
|
lineNumber := int(h.OrigStartLine - 1)
|
|
firstAddedLineNumber := -1
|
|
for _, line := range lines {
|
|
lineNumber++
|
|
|
|
if len(line) == 0 {
|
|
continue
|
|
}
|
|
if line[0] == '+' && firstAddedLineNumber == -1 {
|
|
firstAddedLineNumber = lineNumber
|
|
}
|
|
if line[0] == '-' {
|
|
return lineNumber, firstAddedLineNumber, nil
|
|
}
|
|
}
|
|
|
|
return 0, firstAddedLineNumber, fmt.Errorf("didn't find deletion line in hunk %s", string(h.Body))
|
|
}
|
|
|
|
func (g Gofmt) extractIssuesFromPatch(patch string, log logutils.Log) ([]result.Issue, error) {
|
|
diffs, err := diff.ParseMultiFileDiff([]byte(patch))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("can't parse patch: %s", err)
|
|
}
|
|
|
|
if len(diffs) == 0 {
|
|
return nil, fmt.Errorf("got no diffs from patch parser: %v", diffs)
|
|
}
|
|
|
|
issues := []result.Issue{}
|
|
for _, d := range diffs {
|
|
if len(d.Hunks) == 0 {
|
|
log.Warnf("Got no hunks in diff %+v", d)
|
|
continue
|
|
}
|
|
|
|
for _, hunk := range d.Hunks {
|
|
deletedLine, addedLine, err := getFirstDeletedAndAddedLineNumberInHunk(hunk)
|
|
if err != nil {
|
|
if addedLine > 1 {
|
|
deletedLine = addedLine - 1 // use previous line, TODO: use both prev and next lines
|
|
} else {
|
|
deletedLine = 1
|
|
}
|
|
}
|
|
|
|
text := "File is not gofmt-ed with -s"
|
|
if g.UseGoimports {
|
|
text = "File is not goimports-ed"
|
|
}
|
|
i := result.Issue{
|
|
FromLinter: g.Name(),
|
|
Pos: token.Position{
|
|
Filename: d.NewName,
|
|
Line: deletedLine,
|
|
},
|
|
Text: text,
|
|
}
|
|
issues = append(issues, i)
|
|
}
|
|
}
|
|
|
|
return issues, nil
|
|
}
|
|
|
|
func (g Gofmt) Run(ctx context.Context, lintCtx *linter.Context) ([]result.Issue, error) {
|
|
var issues []result.Issue
|
|
|
|
for _, f := range lintCtx.PkgProgram.Files(lintCtx.Cfg.Run.AnalyzeTests) {
|
|
var diff []byte
|
|
var err error
|
|
if g.UseGoimports {
|
|
diff, err = goimportsAPI.Run(f)
|
|
} else {
|
|
diff, err = gofmtAPI.Run(f, lintCtx.Settings().Gofmt.Simplify)
|
|
}
|
|
if err != nil { // TODO: skip
|
|
return nil, err
|
|
}
|
|
if diff == nil {
|
|
continue
|
|
}
|
|
|
|
is, err := g.extractIssuesFromPatch(string(diff), lintCtx.Log)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("can't extract issues from gofmt diff output %q: %s", string(diff), err)
|
|
}
|
|
|
|
issues = append(issues, is...)
|
|
}
|
|
|
|
return issues, nil
|
|
}
|