93 lines
2 KiB
Go
Vendored
93 lines
2 KiB
Go
Vendored
package rule
|
|
|
|
import (
|
|
"fmt"
|
|
"go/ast"
|
|
"regexp"
|
|
"strings"
|
|
|
|
"github.com/mgechev/revive/lint"
|
|
)
|
|
|
|
// ErrorfRule lints given else constructs.
|
|
type ErrorfRule struct{}
|
|
|
|
// Apply applies the rule to given file.
|
|
func (r *ErrorfRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
|
|
var failures []lint.Failure
|
|
|
|
fileAst := file.AST
|
|
walker := lintErrorf{
|
|
file: file,
|
|
fileAst: fileAst,
|
|
onFailure: func(failure lint.Failure) {
|
|
failures = append(failures, failure)
|
|
},
|
|
}
|
|
|
|
file.Pkg.TypeCheck()
|
|
ast.Walk(walker, fileAst)
|
|
|
|
return failures
|
|
}
|
|
|
|
// Name returns the rule name.
|
|
func (r *ErrorfRule) Name() string {
|
|
return "errorf"
|
|
}
|
|
|
|
type lintErrorf struct {
|
|
file *lint.File
|
|
fileAst *ast.File
|
|
onFailure func(lint.Failure)
|
|
}
|
|
|
|
func (w lintErrorf) Visit(n ast.Node) ast.Visitor {
|
|
ce, ok := n.(*ast.CallExpr)
|
|
if !ok || len(ce.Args) != 1 {
|
|
return w
|
|
}
|
|
isErrorsNew := isPkgDot(ce.Fun, "errors", "New")
|
|
var isTestingError bool
|
|
se, ok := ce.Fun.(*ast.SelectorExpr)
|
|
if ok && se.Sel.Name == "Error" {
|
|
if typ := w.file.Pkg.TypeOf(se.X); typ != nil {
|
|
isTestingError = typ.String() == "*testing.T"
|
|
}
|
|
}
|
|
if !isErrorsNew && !isTestingError {
|
|
return w
|
|
}
|
|
arg := ce.Args[0]
|
|
ce, ok = arg.(*ast.CallExpr)
|
|
if !ok || !isPkgDot(ce.Fun, "fmt", "Sprintf") {
|
|
return w
|
|
}
|
|
errorfPrefix := "fmt"
|
|
if isTestingError {
|
|
errorfPrefix = w.file.Render(se.X)
|
|
}
|
|
|
|
failure := lint.Failure{
|
|
Category: "errors",
|
|
Node: n,
|
|
Confidence: 1,
|
|
Failure: fmt.Sprintf("should replace %s(fmt.Sprintf(...)) with %s.Errorf(...)", w.file.Render(se), errorfPrefix),
|
|
}
|
|
|
|
m := srcLineWithMatch(w.file, ce, `^(.*)`+w.file.Render(se)+`\(fmt\.Sprintf\((.*)\)\)(.*)$`)
|
|
if m != nil {
|
|
failure.ReplacementLine = m[1] + errorfPrefix + ".Errorf(" + m[2] + ")" + m[3]
|
|
}
|
|
|
|
w.onFailure(failure)
|
|
|
|
return w
|
|
}
|
|
|
|
func srcLineWithMatch(file *lint.File, node ast.Node, pattern string) (m []string) {
|
|
line := srcLine(file.Content(), file.ToPosition(node.Pos()))
|
|
line = strings.TrimSuffix(line, "\n")
|
|
rx := regexp.MustCompile(pattern)
|
|
return rx.FindStringSubmatch(line)
|
|
}
|