Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rules

package

Go to main page

Versions in this module

v1

v1.4.2

Aug 11, 2026

Changes in this version

+ func HonorsSuppression(r Rule) bool

+ func ResetState(list []Rule)

+ type GoProjectRule interface

+ AnalyzeGoProject func(ctx *core.GoProjectContext) ([]*core.Violation, error)

+ RequiresSSA func() bool

+ type StatefulRule interface

+ ResetState func()

+ type SuppressionExempt interface

+ SuppressionExempt func() bool

v1.4.1

Jan 8, 2026

v1.4.0

Jan 8, 2026

v1.3.0

Jan 8, 2026

v1.2.0

Jan 8, 2026

Changes in this version

+ func Categories() []string

+ func ConfigureAll(cfg *core.Config) error

+ func Count() int

+ func Register(rule Rule) error

+ type BaseRule struct

+ func NewBaseRule(name, category, description string, severity core.Severity) *BaseRule

+ func (r *BaseRule) Category() string

+ func (r *BaseRule) Configure(settings map[string]any) error

+ func (r *BaseRule) CreateViolation(file string, line int, message string) *core.Violation

+ func (r *BaseRule) DefaultSeverity() core.Severity

+ func (r *BaseRule) Description() string

+ func (r *BaseRule) GetBoolSetting(key string, defaultVal bool) bool

+ func (r *BaseRule) GetFloat64Setting(key string, defaultVal float64) float64

+ func (r *BaseRule) GetIntSetting(key string, defaultVal int) int

+ func (r *BaseRule) GetSetting(key string) (any, bool)

+ func (r *BaseRule) GetStringSetting(key, defaultVal string) string

+ func (r *BaseRule) Name() string

+ type Fix struct

+ EndColumn int

+ EndLine int

+ File string

+ NewText string

+ OldText string

+ StartColumn int

+ StartLine int

+ type Fixer interface

+ Fix func(ctx *core.FileContext, violation *core.Violation) (*Fix, error)

+ type Registry struct

+ func GlobalRegistry() *Registry

+ func NewRegistry() *Registry

+ func (r *Registry) All() []Rule

+ func (r *Registry) Categories() []string

+ func (r *Registry) ConfigureAll(cfg *core.Config) error

+ func (r *Registry) Count() int

+ func (r *Registry) CountByCategory() map[string]int

+ func (r *Registry) Get(name string) (Rule, bool)

+ func (r *Registry) GetByCategory(category string) []Rule

+ func (r *Registry) GetEnabled(cfg *core.Config) []Rule

+ func (r *Registry) Register(rule Rule) error

+ type Rule interface

+ AnalyzeFile func(ctx *core.FileContext) []*core.Violation

+ Category func() string

+ Configure func(settings map[string]any) error

+ DefaultSeverity func() core.Severity

+ Description func() string

+ Name func() string

+ func All() []Rule

+ func Get(name string) (Rule, bool)

+ func GetByCategory(category string) []Rule

+ func GetEnabled(cfg *core.Config) []Rule

+ type RuleInfo struct

+ Category string

+ Description string

+ HasAutoFix bool

+ Name string

+ Severity core.Severity

+ func GetRuleInfo(r Rule) RuleInfo