katas

package

v0.1.62 Latest Latest Go to latest Published: Nov 29, 2025 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

View Source

var DefaultKatasRegistry = NewKatasRegistry()

DefaultKatasRegistry is the default registry.

View Source

var Registry = DefaultKatasRegistry

Registry is the global registry.

func RegisterKata(nodeType ast.Node, kata Kata)

RegisterKata registers a new Kata with the default registry.

type Kata struct {
	ID          string
	Title       string
	Description string
	Severity    Severity
	Check       func(node ast.Node) []Violation
}

Kata represents a single linting rule.

type KatasRegistry struct {
	KatasByType map[string][]Kata
	KatasByID   map[string]Kata
}

KatasRegistry is a registry for all available Katas.

func NewKatasRegistry() *KatasRegistry

NewKatasRegistry creates a new KatasRegistry.

func (kr *KatasRegistry) Check(node ast.Node, disabledKatas []string) []Violation

func (kr *KatasRegistry) GetKata(id string) (Kata, bool)

GetKata returns a Kata by its ID.

func (kr *KatasRegistry) KatasByNodeType() map[string][]Kata

KatasByNodeType returns all registered Katas grouped by node type.

func (kr *KatasRegistry) RegisterKata(nodeType ast.Node, kata Kata)

RegisterKata registers a new Kata.

type Severity string

Severity defines the severity of a violation.

const (
	Error   Severity = "Error"
	Warning Severity = "Warning"
	Info    Severity = "Info"
)

type Violation struct {
	KataID  string
	Message string
	Line    int
	Column  int
	Level   Severity
}

Violation represents a found violation in the code.