errlast

README

docs

Documentation

Overview

Package errlast provides a go/analysis analyzer enforcing the gomatic Go idiom that error is always the last return value.

The analyzer checks only results typed as the builtin error interface type, including aliases of it (e.g. type E = error). Concrete error-implementing types (func f() (*MyErr, int)) and error-constrained type parameters (func f[E error]() (E, int)) are deliberately out of scope: returning a concrete error type is its own smell, not this analyzer's rule.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "errlast",
	Doc:      "reports error return values that are not last",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports error results that are not the last return value.

var Registration = goyze.Registration{
	Name:       "errlast",
	Categories: []goyze.Category{"errors"},
	URL:        "https://docs.gomatic.dev/yze/errlast",
	Analyzer:   Analyzer,
}

Registration declares this analyzer to the yze framework.