rules

package
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package rules wires all lint rules and helpers into a single registry.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry holds all registered rules.

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new rule registry with all built-in rules registered.

func (*Registry) ActiveRules

func (r *Registry) ActiveRules(ruleFilters, disabled []string) []api.Rule

ActiveRules returns the rules that should be checked based on the provided rule filters.

func (*Registry) All

func (r *Registry) All() []api.Rule

All returns all registered rules.

func (*Registry) Get

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

Get retrieves a rule by name. nolint: ireturn

func (*Registry) Register

func (r *Registry) Register(rule api.Rule)

Register adds a rule to the registry.

func (*Registry) ValidateFilters

func (r *Registry) ValidateFilters(filters []string) error

ValidateFilters returns an error when a rule filter is not a known rule or category.

Directories

Path Synopsis
Package api exposes shared types and helpers used by the rules packages.
Package api exposes shared types and helpers used by the rules packages.
Package codequality contains rules for code quality and organization.
Package codequality contains rules for code quality and organization.
Package collections contains rules for collection usage patterns.
Package collections contains rules for collection usage patterns.
logging
fields
Package loggingfields contains rules that validate logger field usage.
Package loggingfields contains rules that validate logger field usage.
formatting
Package loggingformatting contains rules for log formatting, preferring dedicated helpers over fmt.
Package loggingformatting contains rules for log formatting, preferring dedicated helpers over fmt.
message
Package loggingmessage contains rules that inspect log message content and nil checks.
Package loggingmessage contains rules that inspect log message content and nil checks.
performance
Package loggingperformance contains rules that flag inefficient logging patterns.
Package loggingperformance contains rules that flag inefficient logging patterns.
Package testing provides linting rules for test code patterns.
Package testing provides linting rules for test code patterns.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL