commit

package

v0.1.1 Latest Latest Go to latest Published: Sep 19, 2026 License: MIT Imports: 3 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 commit provides configuration types for the commit message portion of a git lint run.

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 groups together the configurable parts of a commit message inspected during a git lint run.

func NewConfig ¶

func NewConfig(opts ...Option) Config

NewConfig creates a new commit Config with the provided options applied in order.

func (Config) Message ¶

func (c Config) Message() message.Config

Message returns the commit message config.

func (Config) Scope ¶

func (c Config) Scope() scope.Config

Scope returns the commit message scope config.

func (Config) Types ¶

func (c Config) Types() types.Config

Types returns the commit types config.

type Option ¶

type Option func(*Config)

Option configures a commit Config instance.

func WithMessage ¶

func WithMessage(msg message.Config) Option

WithMessage sets the commit message config for the commit config.

func WithScope ¶

func WithScope(cfg scope.Config) Option

WithScope sets the commit message scope config for the commit config.

func WithTypes ¶

func WithTypes(cfg types.Config) Option

WithTypes sets the commit types config for the commit config.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
message Package message provides configuration types for the commit message portion of a git branch lint run, grouping the subject and body configurations and the functional options to build the message config.	Package message provides configuration types for the commit message portion of a git branch lint run, grouping the subject and body configurations and the functional options to build the message config.
body Package body provides the configuration of the commit message body, including its length interval and the functional options to build the config.	Package body provides the configuration of the commit message body, including its length interval and the functional options to build the config.
body/mandate Package mandate configures the set of commit types for which the commit message body is mandatory.	Package mandate configures the set of commit types for which the commit message body is mandatory.
subject Package subject provides the configuration of the commit message subject, including its description and task integration, and the functional options to build the config.	Package subject provides the configuration of the commit message subject, including its description and task integration, and the functional options to build the config.
subject/description Package description provides the configuration of the commit message subject description, including its length interval and the functional options to build the config.	Package description provides the configuration of the commit message subject description, including its length interval and the functional options to build the config.
scope Package scope provides the configuration of the commit message subject scope.	Package scope provides the configuration of the commit message subject scope.
types Package types provides the configuration of the commit types allowed during a git lint run.	Package types provides the configuration of the commit types allowed during a git lint run.

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