value

Documentation

Index

• Constants
• Variables
• type Name
• type Properties
  • func Get(c conf.Conf) (Properties, error)
• type Property
  • func (p Property) Validate(v string) string
• type Value
• type Values

Constants

const (
	ErrorNameLen    = "value name must be 3 - 20 characters long"
	ErrorNameChars  = "value name must be only latin lowercase characters or -_"
	ErrorRegexpEnds = "must contain start `^` and end `$` for full line validation"
	NameMinLen      = 3
	NameMaxLen      = 20

	ErrorValueEmpty = "regexp or allowed must be filled"
	ErrorValueBoth  = "regexp and allowed can't be filled together"

	Regexp          = "regexp"
	ValuesConfigKey = "commit.values"

	TitleValue   = "title"
	TypeValue    = "type"
	ContextValue = "context"
	IssueValue   = "issue"
)

Variables

var (
	NameRegex         = regexp.MustCompile("^[a-z-_]+$")
	DefaultProperties = Properties{
		TypeValue: {
			Allowed: map[string]struct{}{
				"fix":  {},
				"feat": {},
			},
		},
		ContextValue: {
			Regexp: regexp.MustCompile("^[a-z-_]+$"),
			MaxLen: 10,
		},
		TitleValue: {
			Regexp: regexp.MustCompile(`^[\w ]+$`),
			MaxLen: 50,
		},
		IssueValue: {
			Regexp: regexp.MustCompile(`^#\d+$`),
			MaxLen: 5,
		},
	}
)

Types

type Name

type Name string

type Properties

type Properties map[Name]Property

func Get

func Get(c conf.Conf) (Properties, error)

type Property

type Property struct {
	Regexp  *regexp.Regexp
	Allowed map[string]struct{}
	MaxLen  int
}

func (Property) Validate

func (p Property) Validate(v string) string

type Value

type Value string

type Values

type Values map[Name]Value