rule

Documentation

Overview

Package rule names the rules of molint.

A rule's name is shared by its flag, its diagnostics, and the directives that silence it, so it is spelled once, here.

Index

• Variables
• func Known(s string) bool
• func OnByDefault(n Name) bool
• type Name

Variables

var All = []Name{ReturnNil, ReturnBool, ReturnError, FieldNilStore, FieldNilCompare, WrapNil, ResultZero, UnwrapNil, UnwrapDiscard}

All lists every rule, in the order the documentation gives them.

Functions

func Known

func Known(s string) bool

Known reports whether s names a rule.

func OnByDefault

func OnByDefault(n Name) bool

OnByDefault reports whether a rule is on when no flag says otherwise. return-error is for those who want mo.Result everywhere, so it is off. field-nil-compare also reports a field set on first use and a check made just in case, so it is off. field-nil-store is on: a nil written into a field always says the field is absent there.

Types

type Name

type Name string

Name is the name of a rule.

const (
	// ReturnNil reports a nil pointer result.
	ReturnNil Name = "return-nil"
	// ReturnBool reports a signature that ends in a bool after other results.
	ReturnBool Name = "return-bool"
	// ReturnError reports a signature that ends in an error after other
	// results.
	ReturnError Name = "return-error"
	// FieldNilStore reports nil stored into a pointer field.
	FieldNilStore Name = "field-nil-store"
	// FieldNilCompare reports a pointer field compared with nil.
	FieldNilCompare Name = "field-nil-compare"
	// WrapNil reports nil given to mo.Some, mo.Ok or mo.Err.
	WrapNil Name = "wrap-nil"
	// ResultZero reports a use of a zero mo.Result.
	ResultZero Name = "result-zero"
	// UnwrapNil reports OrEmpty, or OrElse with nil, on an Option or a Result
	// of a pointer.
	UnwrapNil Name = "unwrap-nil"
	// UnwrapDiscard reports Get with its second result discarded.
	UnwrapDiscard Name = "unwrap-discard"
)