matchers

Documentation

Index

• func Create(features Features, matchers Config) *[]Matcher
• func Filter(matchers *[]Matcher, commits *[]object.Commit) *[]map[string]interface{}
• func GetTypes() []string
• type Config
• type Features
• type Matcher

Functions

func Create

func Create(features Features, matchers Config) *[]Matcher

Create builds matchers from a config

func Filter

func Filter(matchers *[]Matcher, commits *[]object.Commit) *[]map[string]interface{}

Filter filters commits that don't fit any matchers

func GetTypes

func GetTypes() []string

GetTypes returns all defined matchers types

Types

type Config

type Config struct {
	MESSAGE   *regexp.Regexp
	COMMITTER *regexp.Regexp
	AUTHOR    *regexp.Regexp
	TYPE      string
}

Config centralizes config needed for each matcher

type Features

type Features struct {
	ENABLED   bool
	MESSAGE   bool
	COMMITTER bool
	AUTHOR    bool
	TYPE      bool
}

Features gives which matchers are enabled

type Matcher

type Matcher interface {
	Match(*object.Commit) bool
}

Matcher describes a way of applying a matcher against a commit