wraperr

README

wraperr

Check that error return value are wrapped

Install

go get -u github.com/srvc/wraperr/cmd/wraperr

Usage

To check all packages beneath the current directory:

wraperr ./...

Inspired

• errcheck

Documentation

Index

• Variables
• type Checker
  • func NewChecker(fset *token.FileSet, info *types.Info, f *ast.FuncDecl) Checker
• type ReportFunc

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "wraperr",
	Doc:      "Check that error return value are wrapped",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      runAnalyze,
}

var (
	// WrapperFuncList contains "path/to/pkg.Funcname" strings that adds a context to errors.
	WrapperFuncList = []string{

		"errors.New",
		"fmt.Errorf",

		"github.com/pkg/errors.Errorf",
		"github.com/pkg/errors.New",
		"github.com/pkg/errors.WithMessage",
		"github.com/pkg/errors.WithStack",
		"github.com/pkg/errors.Wrap",
		"github.com/pkg/errors.Wrapf",

		"github.com/srvc/fail.Errorf",
		"github.com/srvc/fail.New",
		"github.com/srvc/fail.Wrap",
	}
)

Types

type Checker

type Checker interface {
	Check(ReportFunc)
}

func NewChecker

func NewChecker(
	fset *token.FileSet,
	info *types.Info,
	f *ast.FuncDecl,
) Checker

type ReportFunc

type ReportFunc func(assignedAt, returnedAt token.Pos)