linter

Documentation

Index

• type LintError
• type Linter
  • func New(cfg *config.Config) *Linter
  • func (l *Linter) LintCommitMessage(message string) error
  • func (l *Linter) LintCommitMessageFile(filepath string) error
  • func (l *Linter) LintCommits(commitRange string) error

Types

type LintError

type LintError struct {
	CommitHash string
	Message    string
	FixSteps   string
}

type Linter

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

func New

func New(cfg *config.Config) *Linter

func (*Linter) LintCommitMessage

func (l *Linter) LintCommitMessage(message string) error

LintCommitMessage lints a single commit message from a string

func (*Linter) LintCommitMessageFile

func (l *Linter) LintCommitMessageFile(filepath string) error

LintCommitMessageFile lints a commit message from a file path

func (*Linter) LintCommits

func (l *Linter) LintCommits(commitRange string) error

LintCommits lints the commit messages in the given range and returns an error if any commit fails the linting rules. to use in cli, run `git-commit-linter --config=config.yaml --check="HEAD~5..HEAD"` (checks last 5 commits)