Documentation
¶
Overview ¶
Package description provides a linter that validates the length of the commit message subject description against the configured interval.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Description ¶
type Description struct {
// contains filtered or unexported fields
}
Description represents a linter that validates the length of the commit message subject description against the configured interval.
func NewDescription ¶
func NewDescription( desc commit.Description, cfg config.Config, ) Description
NewDescription creates a new Description linter with the provided commit message subject description and lint configuration that defines the length interval used to validate the subject description.
func (Description) Issues ¶
func (d Description) Issues() []issue.Issue
Issues returns a slice of issues describing any validation problems with the commit message subject description.
It returns no issues when the configured length interval is empty. Otherwise it reports an issue when the number of Unicode characters (runes) in the subject description is not within the configured interval, using the level from the configuration.
Source Files