Skip to content
This repository has been archived by the owner on May 9, 2021. It is now read-only.

lint: avoid false positives with custom errors-package #360

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions lint.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"unicode"
"unicode/utf8"

"golang.org/x/tools/go/ast/astutil"
"golang.org/x/tools/go/gcexportdata"
)

Expand Down Expand Up @@ -1115,6 +1116,9 @@ func (f *file) lintErrorf() {
if !isErrorsNew && !isTestingError {
return true
}
if !f.imports("errors") {
return true
}
arg := ce.Args[0]
ce, ok = arg.(*ast.CallExpr)
if !ok || !isPkgDot(ce.Fun, "fmt", "Sprintf") {
Expand Down Expand Up @@ -1688,6 +1692,20 @@ func (f *file) srcLineWithMatch(node ast.Node, pattern string) (m []string) {
return rx.FindStringSubmatch(line)
}

// imports returns true if the current file imports the specified package path.
func (f *file) imports(importPath string) bool {
all := astutil.Imports(f.fset, f.f)
for _, p := range all {
for _, i := range p {
uq, err := strconv.Unquote(i.Path.Value)
if err == nil && importPath == uq {
return true
}
}
}
return false
}

// srcLine returns the complete line at p, including the terminating newline.
func srcLine(src []byte, p token.Position) string {
// Run to end of line in both directions if not at line start/end.
Expand Down
25 changes: 25 additions & 0 deletions testdata/errorf-custom.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Test for allowed errors.New(fmt.Sprintf()) when a custom errors package is imported.

// Package foo ...
package foo

import (
"fmt"

"github.com/pkg/errors"
)

func f(x int) error {
if x > 10 {
return errors.New(fmt.Sprintf("something %d", x)) // OK
}
if x > 5 {
return errors.New(g("blah")) // OK
}
if x > 4 {
return errors.New("something else") // OK
}
return nil
}

func g(s string) string { return "prefix: " + s }