convention

Documentation

Index

• Constants
• Variables
• type Commit
  • func NewCommit(c git.Commit) (Commit, error)
  • func NewCommitWithOptions(opts ...OptionFn) (result Commit, err error)
  • func (c *Commit) String() string
• type OptionFn
  • func AddAuthorDate(gitCommit git.Commit) OptionFn
  • func GetRawHeader(gitCommit git.Commit) OptionFn
  • func GetTypeAndScope(gitCommit git.Commit) OptionFn

Constants

const (
	FixType      = "fix"
	FeatType     = "feat"
	BuildType    = "build"
	ChoreType    = "chore"
	CIType       = "ci"
	DocsType     = "docs"
	StyleType    = "style"
	RefactorType = "refactor"
	PerfType     = "perf"
	TestType     = "test"
	MiscType     = "misc"
)

Variables

var (
	ErrEmptyCommit = errors.New("empty commit")
)

Types

type Commit

type Commit struct {
	// Commit as is
	RawHeader string

	Type  string
	Scope string
}

Commit represens conventional commit

func NewCommit

func NewCommit(c git.Commit) (Commit, error)

NewCommit return conventional commit from git commit

func NewCommitWithOptions

func NewCommitWithOptions(opts ...OptionFn) (result Commit, err error)

NewCommitWithOptions return conventional commit with custom option

func (*Commit) String

func (c *Commit) String() string

type OptionFn

type OptionFn func(*Commit) error

func AddAuthorDate

func AddAuthorDate(gitCommit git.Commit) OptionFn

func GetRawHeader

func GetRawHeader(gitCommit git.Commit) OptionFn

func GetTypeAndScope

func GetTypeAndScope(gitCommit git.Commit) OptionFn