ctxfirst

README

yze-go-ctxfirst

A yze analyzer (category patterns) enforcing the gomatic Go idiom that a context.Context parameter is always the first parameter. The convention is a contract on any signature taking a context.Context, so it is checked on function and method declarations, interface method signatures, function literals, and function-typed definitions alike.

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

Built on the go-yze framework.

Documentation

Overview

Package ctxfirst provides a go/analysis analyzer enforcing the gomatic Go idiom that a context.Context parameter is always the first parameter.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "ctxfirst",
	Doc:      "reports context.Context parameters that are not the first parameter",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports context.Context parameters that are not first.

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

Registration declares this analyzer to the yze framework.