gorules

Documentation

Overview

Package gorules contains ruleguard linter rules.

Index

• func PreferXerrors(m dsl.Matcher)
• func UberStyleErrors(m dsl.Matcher)
• func UnnecessaryErrorFormat(m dsl.Matcher)
• func ZapPreferNoWith(m dsl.Matcher)

Functions

func PreferXerrors

func PreferXerrors(m dsl.Matcher)

PreferXerrors suggests replace expressions like

errors.As

to

xerrors.As

func UberStyleErrors

func UberStyleErrors(m dsl.Matcher)

UberStyleErrors detects error messages like

xerrors.Errorf("failed to do something: %w", err)

but you should avoid "failed to" and use

xerrors.Errorf("do something: %w", err)

according to https://github.com/uber-go/guide/blob/master/style.md#error-wrapping.

func UnnecessaryErrorFormat

func UnnecessaryErrorFormat(m dsl.Matcher)

UnnecessaryErrorFormat detects unnecessary error formatting like

xerrors.Errorf("error")

and suggests instead

xerrors.New("error")

func ZapPreferNoWith

func ZapPreferNoWith(m dsl.Matcher)

ZapPreferNoWith suggests replace expressions like

l.With(...).Debug("")

to

l.Debug("", ...).

where l is a *zap.Logger.