commit

package

v0.1.0 Latest Latest Go to latest Published: Sep 2, 2026 License: MIT Imports: 6 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 the transport structures used to unmarshal the commit configuration from config files.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Commit ¶

type Commit struct {
	// Msg stores the transport representation of the commit message config.
	Msg message.Message `yaml:"message,omitempty"`

	// Scope stores the transport representation of the commit scope config.
	Scope value.Pattern `yaml:"scope,omitempty"`

	// Types stores the transport representation of the accepted commit types.
	Types value.Strings `yaml:"types,omitempty"`
}

Commit is the transport representation of the commit config.

Commit groups the commit message, scope, and accepted commit types and converts them into the domain commit.Config consumed by the linter.

func (Commit) Config ¶

func (c Commit) Config() commit.Config

Config converts the transport representation into the domain commit.Config, wiring the commit message, scope, and types representations into it.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
message Package message provides the transport structures used to unmarshal the commit message configuration from config files.	Package message provides the transport structures used to unmarshal the commit message configuration from config files.
body Package body provides the transport structures used to unmarshal the commit message body configuration from config files.	Package body provides the transport structures used to unmarshal the commit message body configuration from config files.
body/mandate Package mandate provides the transport structures used to unmarshal the commit message body mandate configuration from config files, describing the commit types for which the commit message body is mandatory.	Package mandate provides the transport structures used to unmarshal the commit message body mandate configuration from config files, describing the commit types for which the commit message body is mandatory.
subject Package subject provides the transport structures used to unmarshal the commit message subject configuration from config files.	Package subject provides the transport structures used to unmarshal the commit message subject configuration from config files.
subject/description Package description provides the transport structures used to unmarshal the commit message subject description configuration from config files.	Package description provides the transport structures used to unmarshal the commit message subject description configuration from config files.

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