description

package

v0.1.1 Latest Latest Go to latest Published: Sep 19, 2026 License: MIT Imports: 1 Imported by: 0

Details

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

Repository

github.com/gitamix/lint

Links

Open Source Insights

Documentation ¶

Overview ¶

Package description provides the configuration of the commit message subject description, including its length interval and the functional options to build the config.

Index ¶

type Config
- func NewConfig(opts ...Option) Config
- func (c Config) Length() value.Range
type Option
- func WithLength(length value.Range) Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

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

Config represents the configuration of the commit message subject description.

func NewConfig ¶

func NewConfig(opts ...Option) Config

NewConfig creates a new description config with the provided functional options.

func (Config) Length ¶

func (c Config) Length() value.Range

Length returns the allowed length interval of the subject description text, excluding the task identifier, type, and scope.

type Option ¶

type Option func(*Config)

Option is a functional option that modifies the description config on its creation.

func WithLength ¶

func WithLength(length value.Range) Option

WithLength sets the allowed length interval for the description config.

Source Files ¶

View all Source files

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