lint

type Commit = parser.Commit

type Config struct {
	// Formatter of the lint result
	Formatter string `yaml:"formatter"`

	// Rules is rule name to rule config map
	Rules map[string]RuleConfig `yaml:"rules"`
}

type Formatter interface {
	// Name is a unique identifier for formatter
	Name() string

	// Format formats the linter result
	Format(result *Result) (string, error)
}

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

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

type Rule interface {
	// Name returns name of the rule, it should be a unique identifier
	Name() string

	// Apply calls with arguments and flags for the rule from config file
	// if flags or arguments are invalid or not expected return an error
	// Apply is called before Validate
	Apply(arg interface{}, flags map[string]interface{}) error

	// Validate validates the rule for given message
	// if given message is valid, return true and result string is ignored
	// if invalid, return a error result with false
	Validate(msg *Commit) (result string, isValid bool)
}

type RuleConfig struct {
	Enabled bool `yaml:"enabled"`

	Severity Severity `yaml:"severity"`

	Argument interface{} `yaml:"argument"`

	// Flags are optional key value pairs
	Flags map[string]interface{} `yaml:"flags"`
}

type RuleResult struct {
	Name     string
	Severity Severity
	Message  string
}

type Severity string