commit

Documentation

Index

• Variables
• type Commit
  • func (c *Commit) Generate(raw string) (string, error)
  • func (c *Commit) ParseMessage(message string) (Commit, error)
  • func (c *Commit) Validate() error

Variables

var (
	// ErrEmptyCommitMessage is returned when the commit message is empty
	ErrEmptyCommitMessage error = errors.New("error: empty commit message")
)

Types

type Commit

type Commit struct {
	// Define commit type, like chore, fix, etc
	Type string `yaml:",omitempty"`
	// Define commit type scope
	Scope string `yaml:",omitempty"`
	// Define commit footer
	Footers string `yaml:",omitempty"`
	// Define commit title
	Title string `yaml:",omitempty"`
	// Define commit body
	Body string `yaml:",omitempty"`
	// Display updatecli credits inside commit message body
	HideCredit bool `yaml:",omitempty"`
}

Commit contains conventional commit information More information on what is conventional commits -> https://www.conventionalcommits.org/en/v1.0.0/#summary

func (*Commit) Generate

func (c *Commit) Generate(raw string) (string, error)

Generate generates the conventional commit

func (*Commit) ParseMessage

func (c *Commit) ParseMessage(message string) (Commit, error)

ParseMessage parses a message then return the commit message title and its body. The message title can't be longer than 72 characters

func (*Commit) Validate

func (c *Commit) Validate() error

Validate validates "conventional commit" default parameters.