recv

README

Recv

A linter that handles methods receivers.

Examples

package a

type Foo struct { // want `the methods of "Foo" use different receiver names: f, fo.`
	Name string
}

func (f Foo) A()  {}
func (fo Foo) B() {}

type Bar struct{} // want `the methods of "Bar" use pointer receiver and non pointer receiver.`

func (b Bar) A()  {}
func (b *Bar) B() {}

type Fuu struct{}

func (faaa Fuu) A() {} // want `the receiver name "faaa" is too long.`

References

• https://go.dev/wiki/CodeReviewComments#receiver-names

  • Be consistent, too: if you call the receiver “c” in one method, don’t call it “cl” in another.

  • The name of a method’s receiver should be a reflection of its identity; often a one or two letter abbreviation of its type suffices (such as “c” or “cl” for “Client”).

• https://go.dev/wiki/CodeReviewComments#receiver-type

  • Don’t mix receiver types. Choose either pointers or struct types for all available methods.

• https://google.github.io/styleguide/go/decisions.html#receiver-names

  • Receiver variable names must be:

    • Short (usually one or two letters in length)
    • Applied consistently to every receiver for that type

Documentation

Index

• func New(config Config) *analysis.Analyzer
• type Config

Functions

func New

func New(config Config) *analysis.Analyzer

New creates an analyzer.

Types

type Config

type Config struct {
	// MaxNameLength maximum length for a receiver name.
	MaxNameLength int
	// TypeConsistency allows to use pointer receiver and non-pointer receiver on the same struct.
	TypeConsistency bool
}

Config the recv configuration.