gorules

Documentation

Overview

Package gorules contains ruleguard linter rules.

Index

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

Functions

func UberStyleErrors

func UberStyleErrors(m dsl.Matcher)

UberStyleErrors detects error messages like

errors.Wrap(err, "failed to do something")

but you should avoid "failed to" and use

errors.Wrap(err, "do something")

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

errors.New("error")

and suggests instead

errors.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.