conventionalcommit

Documentation

Index

• Variables
• type CommitMsg
  • func ParseCommitMsg(commitMsg string) (*CommitMsg, error)
  • func (v CommitMsg) MarshalText() ([]byte, error)
  • func (v CommitMsg) String() string
  • func (v *CommitMsg) UnmarshalText(data []byte) error

Variables

var (
	TypesRegex  = regexp.MustCompile(`^(feat|fix|build|chore|ci|docs|perf|refactor|revert|style|test)$`)
	HeaderRegex = regexp.MustCompile(`^(?P<type>\w+)(\((?P<scope>[\w/.-]+)\))?(?P<breaking>!)?:( +)?(?P<header>.+)`)
)

var Types = map[string]string{
	"feat":     "Features",
	"fix":      "Bug Fixes",
	"build":    "",
	"chore":    "",
	"ci":       "",
	"docs":     "",
	"perf":     "",
	"refactor": "",
	"revert":   "",
	"style":    "",
	"test":     "",
}

Types

type CommitMsg

type CommitMsg struct {
	Type           string
	BreakingChange bool
	Scope          string
	Header         string
	Body           string
}

func ParseCommitMsg

func ParseCommitMsg(commitMsg string) (*CommitMsg, error)

func (CommitMsg) MarshalText

func (v CommitMsg) MarshalText() ([]byte, error)

func (CommitMsg) String

func (v CommitMsg) String() string

func (*CommitMsg) UnmarshalText

func (v *CommitMsg) UnmarshalText(data []byte) error