lint

Mar 6, 2022

Changes in this version

type Commit

+ Body func() string

+ Description func() string

+ Footer func() string

+ Header func() string

+ IsBreakingChange func() bool

+ Message func() string

+ Notes func() []Note

+ Scope func() string

+ Type func() string

type Config

+ MinVersion string

+ Settings map[string]RuleSetting

+ Severity SeverityConfig

+ func (c *Config) GetSeverity(ruleName string) Severity

+ type Issue struct

+ func NewIssue(desc string, infos ...string) *Issue

+ func (r *Issue) Description() string

+ func (r *Issue) Infos() []string

+ func (r *Issue) RuleName() string

+ func (r *Issue) Severity() Severity

type Linter

+ func (l *Linter) ParseAndLint(commitMsg string) (*Result, error)

+ type Note interface

+ Token func() string

+ Value func() string

+ type Parser interface

+ Parse func(msg string) (Commit, error)

type Result

+ func (r *Result) Issues() []*Issue

+ type RuleSetting struct

+ Argument interface{}

+ Flags map[string]interface{}

+ type SeverityConfig struct

+ Default Severity

+ Rules map[string]Severity

Sep 28, 2021

Changes in this version

+ type Commit = parser.Commit

+ func Parse(msg string) (*Commit, error)

type Linter

+ func New(conf *Config, rules []Rule) (*Linter, error)

+ type Severity string

+ func (s Severity) String() string

Sep 22, 2021

Changes in this version

type Rule

+ Apply func(arg interface{}, flags map[string]interface{}) error

type RuleConfig

+ Flags map[string]interface{}

Aug 29, 2021

Changes in this version

+ const SeverityError

+ const SeverityWarn

+ type Config struct

+ Formatter string

+ Rules map[string]RuleConfig

+ func (c *Config) GetRule(ruleName string) RuleConfig

+ type Formatter interface

+ Format func(res *Result) (string, error)

+ Name func() string

+ type Linter struct

+ func NewLinter(conf *Config, rules []Rule) (*Linter, error)

+ func (l *Linter) Lint(commitMsg string) (*Result, error)

+ func (l *Linter) LintCommit(msg *message.Commit) (*Result, error)

+ type Result struct

+ func (res *Result) Errors() []RuleResult

+ func (res *Result) HasErrors() bool

+ func (res *Result) HasWarns() bool

+ func (res *Result) Input() string

+ func (res *Result) IsOK() bool

+ func (res *Result) Warns() []RuleResult

+ type Rule interface

+ Name func() string

+ SetAndCheckArgument func(arg interface{}) error

+ Validate func(msg *message.Commit) (result string, isValid bool)

+ type RuleConfig struct

+ Argument interface{}

+ Enabled bool

+ Severity string

+ type RuleResult struct

+ Message string

+ Name string

+ Severity string