description

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2026 License: MIT Imports: 1 Imported by: 0

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

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.

func (Config) Validate added in v0.1.2 

func (c Config) Validate() error

Validate checks the subject description length configuration for correctness.

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.