rule

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 21, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package rule contains lint rules

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BodyMaxLenRule 

type BodyMaxLenRule struct{ CheckLen int }

BodyMaxLenRule to validate max length of body

func (*BodyMaxLenRule) Apply added in v0.4.0 

func (r *BodyMaxLenRule) Apply(s lint.RuleSetting) error

func (*BodyMaxLenRule) Name 

func (r *BodyMaxLenRule) Name() string

func (*BodyMaxLenRule) Validate 

func (r *BodyMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type BodyMaxLineLenRule 

type BodyMaxLineLenRule struct{ CheckLen int }

BodyMaxLineLenRule to validate max line length of body

func (*BodyMaxLineLenRule) Apply added in v0.4.0 

func (r *BodyMaxLineLenRule) Apply(s lint.RuleSetting) error

func (*BodyMaxLineLenRule) Name 

func (r *BodyMaxLineLenRule) Name() string

func (*BodyMaxLineLenRule) Validate 

func (r *BodyMaxLineLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type BodyMinLenRule 

type BodyMinLenRule struct{ CheckLen int }

BodyMinLenRule to validate min length of body

func (*BodyMinLenRule) Apply added in v0.4.0 

func (r *BodyMinLenRule) Apply(s lint.RuleSetting) error

func (*BodyMinLenRule) Name 

func (r *BodyMinLenRule) Name() string

func (*BodyMinLenRule) Validate 

func (r *BodyMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type DescriptionMaxLenRule 

type DescriptionMaxLenRule struct{ CheckLen int }

DescriptionMaxLenRule to validate max length of description

func (*DescriptionMaxLenRule) Apply added in v0.4.0 

func (r *DescriptionMaxLenRule) Apply(s lint.RuleSetting) error

func (*DescriptionMaxLenRule) Name 

func (r *DescriptionMaxLenRule) Name() string

func (*DescriptionMaxLenRule) Validate 

func (r *DescriptionMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type DescriptionMinLenRule 

type DescriptionMinLenRule struct{ CheckLen int }

DescriptionMinLenRule to validate min length of description

func (*DescriptionMinLenRule) Apply added in v0.4.0 

func (r *DescriptionMinLenRule) Apply(s lint.RuleSetting) error

func (*DescriptionMinLenRule) Name 

func (r *DescriptionMinLenRule) Name() string

func (*DescriptionMinLenRule) Validate 

func (r *DescriptionMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type FooterEnumRule added in v0.8.0 

type FooterEnumRule struct {
	Tokens []string
}

FooterEnumRule to validate footer tokens

func (*FooterEnumRule) Apply added in v0.8.0 

func (r *FooterEnumRule) Apply(setting lint.RuleSetting) error

Apply sets the needed argument for the rule

func (*FooterEnumRule) Name added in v0.8.0 

func (r *FooterEnumRule) Name() string

Name return name of the rule

func (*FooterEnumRule) Validate added in v0.8.0 

func (r *FooterEnumRule) Validate(msg lint.Commit) (*lint.Issue, bool)

Validate validates FooterEnumRule

type FooterMaxLenRule 

type FooterMaxLenRule struct{ CheckLen int }

FooterMaxLenRule to validate max length of footer

func (*FooterMaxLenRule) Apply added in v0.4.0 

func (r *FooterMaxLenRule) Apply(s lint.RuleSetting) error

func (*FooterMaxLenRule) Name 

func (r *FooterMaxLenRule) Name() string

func (*FooterMaxLenRule) Validate 

func (r *FooterMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type FooterMaxLineLenRule 

type FooterMaxLineLenRule struct{ CheckLen int }

FooterMaxLineLenRule to validate max line length of footer

func (*FooterMaxLineLenRule) Apply added in v0.4.0 

func (r *FooterMaxLineLenRule) Apply(s lint.RuleSetting) error

func (*FooterMaxLineLenRule) Name 

func (r *FooterMaxLineLenRule) Name() string

func (*FooterMaxLineLenRule) Validate 

func (r *FooterMaxLineLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type FooterMinLenRule 

type FooterMinLenRule struct{ CheckLen int }

FooterMinLenRule to validate min length of footer

func (*FooterMinLenRule) Apply added in v0.4.0 

func (r *FooterMinLenRule) Apply(s lint.RuleSetting) error

func (*FooterMinLenRule) Name 

func (r *FooterMinLenRule) Name() string

func (*FooterMinLenRule) Validate 

func (r *FooterMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type FooterTypeEnumParam added in v0.9.0 

type FooterTypeEnumParam struct {
	Token  string
	Types  []string
	Values []string
}

FooterTypeEnumParam represent a single footer type param

type FooterTypeEnumRule added in v0.9.0 

type FooterTypeEnumRule struct {
	Params []*FooterTypeEnumParam
}

FooterTypeEnumRule to validate footer tokens

func (*FooterTypeEnumRule) Apply added in v0.9.0 

func (r *FooterTypeEnumRule) Apply(setting lint.RuleSetting) error

Apply sets the needed argument for the rule

func (*FooterTypeEnumRule) Name added in v0.9.0 

func (r *FooterTypeEnumRule) Name() string

Name return name of the rule

func (*FooterTypeEnumRule) Validate added in v0.9.0 

func (r *FooterTypeEnumRule) Validate(msg lint.Commit) (*lint.Issue, bool)

Validate validates FooterTypeEnumRule

type HeadMaxLenRule 

type HeadMaxLenRule struct{ CheckLen int }

HeadMaxLenRule to validate max length of header

func (*HeadMaxLenRule) Apply added in v0.4.0 

func (r *HeadMaxLenRule) Apply(s lint.RuleSetting) error

func (*HeadMaxLenRule) Name 

func (r *HeadMaxLenRule) Name() string

func (*HeadMaxLenRule) Validate 

func (r *HeadMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type HeadMinLenRule 

type HeadMinLenRule struct{ CheckLen int }

HeadMinLenRule to validate min length of header

func (*HeadMinLenRule) Apply added in v0.4.0 

func (r *HeadMinLenRule) Apply(s lint.RuleSetting) error

func (*HeadMinLenRule) Name 

func (r *HeadMinLenRule) Name() string

func (*HeadMinLenRule) Validate 

func (r *HeadMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type ScopeCharsetRule 

type ScopeCharsetRule struct{ Charset string }

ScopeCharsetRule to validate charset of scope

func (*ScopeCharsetRule) Apply added in v0.4.0 

func (r *ScopeCharsetRule) Apply(s lint.RuleSetting) error

func (*ScopeCharsetRule) Name 

func (r *ScopeCharsetRule) Name() string

func (*ScopeCharsetRule) Validate 

func (r *ScopeCharsetRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type ScopeEnumRule 

type ScopeEnumRule struct {
	Scopes []string

	AllowEmpty bool
}

ScopeEnumRule to validate scope against a list of allowed values

func (*ScopeEnumRule) Apply added in v0.4.0 

func (r *ScopeEnumRule) Apply(setting lint.RuleSetting) error

Apply sets the needed argument for the rule

func (*ScopeEnumRule) Name 

func (r *ScopeEnumRule) Name() string

Name return name of the rule

func (*ScopeEnumRule) Validate 

func (r *ScopeEnumRule) Validate(msg lint.Commit) (*lint.Issue, bool)

Validate validates ScopeEnumRule

type ScopeMaxLenRule 

type ScopeMaxLenRule struct{ CheckLen int }

ScopeMaxLenRule to validate max length of scope

func (*ScopeMaxLenRule) Apply added in v0.4.0 

func (r *ScopeMaxLenRule) Apply(s lint.RuleSetting) error

func (*ScopeMaxLenRule) Name 

func (r *ScopeMaxLenRule) Name() string

func (*ScopeMaxLenRule) Validate 

func (r *ScopeMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type ScopeMinLenRule 

type ScopeMinLenRule struct{ CheckLen int }

ScopeMinLenRule to validate min length of scope

func (*ScopeMinLenRule) Apply added in v0.4.0 

func (r *ScopeMinLenRule) Apply(s lint.RuleSetting) error

func (*ScopeMinLenRule) Name 

func (r *ScopeMinLenRule) Name() string

func (*ScopeMinLenRule) Validate 

func (r *ScopeMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type TypeCharsetRule 

type TypeCharsetRule struct{ Charset string }

TypeCharsetRule to validate charset of type

func (*TypeCharsetRule) Apply added in v0.4.0 

func (r *TypeCharsetRule) Apply(s lint.RuleSetting) error

func (*TypeCharsetRule) Name 

func (r *TypeCharsetRule) Name() string

func (*TypeCharsetRule) Validate 

func (r *TypeCharsetRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type TypeEnumRule 

type TypeEnumRule struct {
	Types []string
}

TypeEnumRule to validate types

func (*TypeEnumRule) Apply added in v0.4.0 

func (r *TypeEnumRule) Apply(setting lint.RuleSetting) error

Apply sets the needed argument for the rule

func (*TypeEnumRule) Name 

func (r *TypeEnumRule) Name() string

Name return name of the rule

func (*TypeEnumRule) Validate 

func (r *TypeEnumRule) Validate(msg lint.Commit) (*lint.Issue, bool)

Validate validates TypeEnumRule

type TypeMaxLenRule 

type TypeMaxLenRule struct{ CheckLen int }

TypeMaxLenRule to validate max length of type

func (*TypeMaxLenRule) Apply added in v0.4.0 

func (r *TypeMaxLenRule) Apply(s lint.RuleSetting) error

func (*TypeMaxLenRule) Name 

func (r *TypeMaxLenRule) Name() string

func (*TypeMaxLenRule) Validate 

func (r *TypeMaxLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

type TypeMinLenRule 

type TypeMinLenRule struct{ CheckLen int }

TypeMinLenRule to validate min length of type

func (*TypeMinLenRule) Apply added in v0.4.0 

func (r *TypeMinLenRule) Apply(s lint.RuleSetting) error

func (*TypeMinLenRule) Name 

func (r *TypeMinLenRule) Name() string

func (*TypeMinLenRule) Validate 

func (r *TypeMinLenRule) Validate(msg lint.Commit) (*lint.Issue, bool)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.