name

package

v0.1.0 Latest Latest Go to latest Published: Sep 2, 2026 License: MIT Imports: 5 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 name provides a linter for validating commit branch names.

Index ¶

type Name
- func NewName(name branch.Name, cfg name.Config) *Name
- func (n *Name) Issues() []issue.Issue

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Name ¶

type Name struct {
	// contains filtered or unexported fields
}

Name represents a linter to validate branch names.

func NewName ¶

func NewName(
	name branch.Name,
	cfg name.Config,
) *Name

NewName creates a new Name for validating the provided branch name using lint configuration definines the rules to validate the branch name.

func (*Name) Issues ¶

func (n *Name) Issues() []issue.Issue

Issues returns a slice of issues describing any validation problems with the branch name.

It checks whether the branch name matches the required regex pattern from the linter configuration. If the name does not match, a single issue is returned describing the mismatch.

Source Files ¶

View all Source files

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