commitmessage

Documentation

Index

• type CommitMessage
  • func New(log Logger, commitType CommitType) *CommitMessage
  • func (f *CommitMessage) IsValidMessage(message string) bool
  • func (f *CommitMessage) PrettifyCommitMessage(commitMessage string) (string, error)
• type CommitType
• type Logger

Types

type CommitMessage

type CommitMessage struct {
	// contains filtered or unexported fields
}

func New

func New(log Logger, commitType CommitType) *CommitMessage

func (*CommitMessage) IsValidMessage

func (f *CommitMessage) IsValidMessage(message string) bool

func (*CommitMessage) PrettifyCommitMessage

func (f *CommitMessage) PrettifyCommitMessage(commitMessage string) (string, error)

prettifyCommitMessage aims to keep a short message based on the commit message, removing extra information such as commit type. Args:

commitMessage (string): Full commit message.

Returns:

string: Returns a commit message with limmited number of characters.
err: Error whenever unexpected issues happen.

type CommitType

type CommitType interface {
	GetAll() []string
	GetMajorUpgrade() []string
	GetMinorUpgrade() []string
	GetPatchUpgrade() []string
	GetSkipVersioning() []string
	GetCommitChangeType(commitMessage string) (string, error)
	IndexNotFound(index int) bool
}

type Logger

type Logger interface {
	Info(s string, args ...interface{})
	Error(s string, args ...interface{})
	Warn(s string, args ...interface{})
}