message

package

v0.1.1 Latest Latest Go to latest Published: Sep 19, 2026 License: MIT Imports: 2 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 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.

Index ¶

type Config
- func NewConfig(opts ...Option) Config
- func (c Config) Body() body.Config
- func (c Config) Subject() subject.Config
type Option
- func WithBody(b body.Config) Option
- func WithSubject(subj subject.Config) 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 groups together the configurable parts of a commit message inspected during a git branch lint run.

func NewConfig ¶

func NewConfig(opts ...Option) Config

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

func (Config) Body ¶

func (c Config) Body() body.Config

Body returns the body config.

func (Config) Subject ¶

func (c Config) Subject() subject.Config

Subject returns the subject config.

type Option ¶

type Option func(*Config)

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

func WithBody ¶

func WithBody(b body.Config) Option

WithBody sets the body config for the message config.

func WithSubject ¶

func WithSubject(subj subject.Config) Option

WithSubject sets the subject config for the message config.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
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.
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.
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.

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