errlast

README

yze-go-errlast

A yze analyzer (category errors) enforcing the gomatic Go idiom that error is always the last return value. The convention is a contract on any signature returning an error, so it is checked on function and method declarations, interface method signatures, function literals, and function-typed definitions alike.

• Rule: yze/errlast
• Library: exports Analyzer and Registration for the yze aggregator and stickler runner.
• Binary: cmd/yze-go-errlast runs it standalone (text/-json, and as a go vet -vettool).

Built on the go-yze framework.

Documentation

Overview

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

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.