registry

package

v0.12.0 Latest Latest Go to latest Published: Feb 22, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/conventionalcommit/commitlint

Links

Open Source Insights

Documentation ¶

Overview ¶

Package registry holds the global registry of rules and formatters. External packages can call RegisterRule and RegisterFormatter to extend commitlint with custom rules or formatters before building a linter.

Index ¶

func Formatters() []lint.Formatter
func GetFormatter(name string) (lint.Formatter, bool)
func GetRule(name string) (lint.Rule, bool)
func RegisterFormatter(format lint.Formatter) error
func RegisterRule(r lint.Rule) error
func Rules() []lint.Rule

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Formatters ¶

func Formatters() []lint.Formatter

Formatters returns all registered formatters.

func GetFormatter ¶

func GetFormatter(name string) (lint.Formatter, bool)

GetFormatter returns the Formatter registered under name, and whether it was found.

func GetRule ¶

func GetRule(name string) (lint.Rule, bool)

GetRule returns the Rule registered under name, and whether it was found.

func RegisterFormatter ¶

func RegisterFormatter(format lint.Formatter) error

RegisterFormatter registers a custom formatter. Returns an error if a formatter with the same name is already registered.

func RegisterRule ¶

func RegisterRule(r lint.Rule) error

RegisterRule registers a custom rule. Returns an error if a rule with the same name is already registered.

func Rules ¶

func Rules() []lint.Rule

Rules returns all registered rules.

Types ¶

This section is empty.

Source Files ¶

View all Source files

registry.go

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