errcheck

Documentation

Overview

Package errcheck is the library used to implement the errcheck command-line tool.

Note: The API of this package has not been finalized and may change at any point.

Index

• Variables
• func CheckPackage(pkgPath string, ignore map[string]*regexp.Regexp, blank bool) error
• type UncheckedErrors
  • func (e UncheckedErrors) Error() string

Variables

var (
	// ErrNoGoFiles is returned when CheckPackage is run on a package with no Go source files
	ErrNoGoFiles = errors.New("package contains no go source files")
)

Functions

func CheckPackage

func CheckPackage(pkgPath string, ignore map[string]*regexp.Regexp, blank bool) error

CheckPackage checks a package at pkgPath for errors. ignore is a map of package names to regular expressions. Identifiers from a package are checked against its regular expressions and if any of the expressions match the call is not checked. If blank is true then assignments to the blank identifier are also considered to be ignored errors.

Types

type UncheckedErrors

type UncheckedErrors struct {
	// Errors is a list of all the unchecked errors in the package.
	// Printing an error reports its position within the file and the contents of the line.
	Errors []error
}

UncheckedErrors is returned from the CheckPackage function if the package contains any unchecked errors.

func (UncheckedErrors) Error

func (e UncheckedErrors) Error() string