commitparser

Documentation

Index

• Constants
• Variables
• type CommitMessage
  • func Parse(message string) (CommitMessage, error)
• type ParseError
  • func (err ParseError) Error() string
  • func (err ParseError) Unwrap() error

Constants

const (
	TrailerKeyBreakingChangePrefix = "BREAKING"
	TrailerKeyBreakingChange       = TrailerKeyBreakingChangePrefix + " CHANGE"
	TrailerKeyBreakingChangeAlt    = TrailerKeyBreakingChangePrefix + "-" + TrailerKeyBreakingChange
)

Variables

var (
	ErrInvalidType              = errors.New("invalid commit type")
	ErrInvalidScope             = errors.New("invalid commit scope")
	ErrInvalidSubject           = errors.New("invalid commit subject")
	ErrInvalidMessage           = errors.New("invalid commit message")
	ErrInvalidTrailer           = errors.New("invalid trailer in commit message")
	ErrUnsupportedSpecialCommit = errors.New("unsupported special commit, please report this error if you think it should be supported")
)

Types

type CommitMessage

type CommitMessage struct {
	Type     string
	Scope    string
	Subject  string
	Body     string
	Trailers map[string][]string
	Breaking bool
	Revert   bool
	Merge    bool
}

func Parse

func Parse(message string) (CommitMessage, error)

type ParseError

type ParseError struct {
	Pos int
	// contains filtered or unexported fields
}

func (ParseError) Error

func (err ParseError) Error() string

func (ParseError) Unwrap

func (err ParseError) Unwrap() error