chlog

type Changelog struct {

	// LineParser can custom log line parser
	LineParser LineParser
	// ItemFilters The parsed log item filters
	ItemFilters []ItemFilter
	// Formatter The item formatter. format each item to string
	Formatter Formatter
	// contains filtered or unexported fields
}

type Config struct {
	// Title string for formatted text. eg: "## Change Log"
	Title string `json:"title" yaml:"title"`
	// RepoURL repo URL address
	RepoURL string `json:"repo_url" yaml:"repo_url"`
	// Style name. allow: simple, markdown, ghr
	Style string `json:"style" yaml:"style"`
	// LogFormat built-in log format string.
	//
	// use on the `git log --pretty="format:%H"`.
	//
	// see consts LogFmt*, eg: LogFmtHs
	LogFormat string `json:"log_format" yaml:"log_format"`
	// GroupPrefix string. eg: '### '
	GroupPrefix string `yaml:"group_prefix"`
	// GroupPrefix string.
	GroupSuffix string `yaml:"group_suffix"`
	// NoGroup Not output group name line.
	NoGroup bool `yaml:"no_group"`
	// RmRepeat remove repeated log by message
	RmRepeat bool `json:"rm_repeat" yaml:"rm_repeat"`
	// Verbose show more information
	Verbose bool `json:"verbose" yaml:"verbose"`
	// Names define group names and sort
	Names []string `json:"names" yaml:"names"`
	// Rules for match group
	Rules []Rule `json:"rules" yaml:"rules"`
	// Filters for filtering
	Filters []maputil.Data `json:"filters" yaml:"filters"`
}

type Formatter interface {
	// MatchGroup from log msg
	MatchGroup(msg string) (group string)
	// Format the log item to line
	Format(li *LogItem) (group, fmtLine string)
}

type GHReleaseFormatter struct {
	MarkdownFormatter
}

type GroupMatcher interface {
	// Match group from log msg(has been trimmed)
	Match(msg string) (group string)
}

type ItemFilter interface {
	// Handle filtering
	Handle(li *LogItem) bool
}

type ItemFilterFunc func(li *LogItem) bool

type LineParseFunc func(line string, c *Changelog) *LogItem

type LineParser interface {
	Parse(line string, c *Changelog) *LogItem
}

type LogItem struct {
	HashID    string // %H %h
	ParentID  string // %P %p
	Msg       string // %s
	Date      string // %ci
	Author    string // %an
	Committer string // %cn
}

type MarkdownFormatter struct {
	SimpleFormatter
	// RepoURL git repo remote URL address
	RepoURL string
}

type Rule struct {
	// Name for group
	Name string `json:"name" yaml:"name"`
	// StartWiths message start withs string.
	StartWiths []string `json:"start_withs" yaml:"start_withs"`
	// Contains message should contain there are strings.
	Contains []string `json:"contains" yaml:"contains"`
}

type RuleMatcher struct {
	// Names define group names and sort
	Names []string `json:"names" yaml:"names"`
	Rules []Rule   `json:"rules" yaml:"rules"`
}

type SimpleFormatter struct {
	// GroupMatch group match handler.
	GroupMatch GroupMatcher
}