chlog

Jun 19, 2023

Changes in this version

type Changelog

+ func (c *Changelog) LogIsEmpty() bool

May 17, 2022

Changes in this version

+ const FilterKeyword

+ const FilterKeywords

+ const FilterMsgLen

+ const FilterWordsLen

+ const FormatterGhRelease

+ const FormatterMarkdown

+ const FormatterSimple

+ const LogFmtHs

+ const LogFmtHsa

+ const LogFmtHsc

+ const LogFmtHsd

+ const LogFmtHsd1

+ const Sep

+ var BuiltInParser = LineParseFunc(func(line string, c *Changelog) *LogItem { ... })

+ var DefaultGroup = "Other"

+ var DefaultMatcher = NewDefaultMatcher()

+ var ErrEmptyLogText = errors.New("empty git log text for parse")

+ type Changelog struct

+ Formatter Formatter

+ ItemFilters []ItemFilter

+ LineParser LineParser

+ func New() *Changelog

+ func NewWithConfig(cfg *Config) *Changelog

+ func NewWithGitLog(gitLogOut string) *Changelog

+ func (c *Changelog) Changelog() string

+ func (c *Changelog) Config() *Config

+ func (c *Changelog) FetchGitLog(sha1, sha2 string, moreArgs ...string) *Changelog

+ func (c *Changelog) Generate() (err error)

+ func (c *Changelog) LogCount() int

+ func (c *Changelog) Parse() (err error)

+ func (c *Changelog) SetLogText(gitLogOut string)

+ func (c *Changelog) String() string

+ func (c *Changelog) WithConfig(cfg *Config) *Changelog

+ func (c *Changelog) WithConfigFn(fn func(cfg *Config)) *Changelog

+ func (c *Changelog) WithFn(fn func(c *Changelog)) *Changelog

+ func (c *Changelog) WriteTo(w io.Writer) (int64, error)

+ type Config struct

+ Filters []maputil.Data

+ GroupPrefix string

+ GroupSuffix string

+ LogFormat string

+ Names []string

+ NoGroup bool

+ RepoURL string

+ RmRepeat bool

+ Rules []Rule

+ Style string

+ Title string

+ Verbose bool

+ func NewDefaultConfig() *Config

+ func (c *Config) Create() *Changelog

+ func (c *Config) CreateFilters() []ItemFilter

+ func (c *Config) CreateFormatter() Formatter

+ type Formatter interface

+ Format func(li *LogItem) (group, fmtLine string)

+ MatchGroup func(msg string) (group string)

+ type GHReleaseFormatter struct

+ func (f *GHReleaseFormatter) Format(li *LogItem) (group, fmtLine string)

+ type GroupMatcher interface

+ Match func(msg string) (group string)

+ type ItemFilter interface

+ Handle func(li *LogItem) bool

+ type ItemFilterFunc func(li *LogItem) bool

+ func KeywordFilter(kw string, exclude bool) ItemFilterFunc

+ func KeywordsFilter(kws []string, exclude bool) ItemFilterFunc

+ func MsgLenFilter(minLen int) ItemFilterFunc

+ func WordsLenFilter(minLen int) ItemFilterFunc

+ func (f ItemFilterFunc) Handle(li *LogItem) bool

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

+ func (f LineParseFunc) Parse(line string, c *Changelog) *LogItem

+ type LineParser interface

+ Parse func(line string, c *Changelog) *LogItem

+ type LogItem struct

+ Author string

+ Committer string

+ Date string

+ HashID string

+ Msg string

+ ParentID string

+ func (l *LogItem) AbbrevID() string

+ func (l *LogItem) Username() string

+ type MarkdownFormatter struct

+ RepoURL string

+ func (f *MarkdownFormatter) Format(li *LogItem) (group, fmtLine string)

+ type Rule struct

+ Contains []string

+ Name string

+ StartWiths []string

+ type RuleMatcher struct

+ Names []string

+ Rules []Rule

+ func NewDefaultMatcher() *RuleMatcher

+ func (m RuleMatcher) Match(msg string) string

+ type SimpleFormatter struct

+ GroupMatch GroupMatcher

+ func (f *SimpleFormatter) Format(li *LogItem) (group, fmtLine string)

+ func (f *SimpleFormatter) MatchGroup(msg string) (group string)