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

Commit

Permalink
lint: avoid false positives with custom errors-package
Browse files Browse the repository at this point in the history
When using `errors.New(fmt.Sprintf(...))`,
lint will alert that you should use `fmt.Errorf(...)`.

Before this patch, this alert was also displayed
when using a custom errors-package.
There are valid use cases to use `errors.New(fmt.Sprintf(...))`
in a custom errors-package context.

This patch avoids the "false positive" alert
when a custom errors-package is imported in the current file.

Fixes #350

Change-Id: I7cc82a3435b184f8b4cad0752a75d44f33536dce
GitHub-Last-Rev: ad257d2
GitHub-Pull-Request: #360
Reviewed-on: https://go-review.googlesource.com/96091
Reviewed-by: Andrew Bonventre <andybons@golang.org>
  • Loading branch information
leonelquinteros authored and andybons committed Mar 7, 2018
1 parent fb4f8c1 commit c72d1a5
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
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 @@ -1126,6 +1127,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 @@ -1694,6 +1698,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 }

0 comments on commit c72d1a5

Please sign in to comment.