model

Documentation

Index

• Variables
• type Commit
  • func (c Commit) IsValid() bool
  • func (c Commit) String() string
• type CommitType
  • func (c CommitType) String() string
• type ScopeItem
  • func (s ScopeItem) Description() string
  • func (s ScopeItem) FilterValue() string
  • func (s ScopeItem) Title() string

Variables

var (
	// Based on https://www.conventionalcommits.org/
	TypeConventionalCommit []CommitType = []CommitType{
		CommitTypeFeat,
		CommitTypeFix,
	}

	// Based on https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md
	TypeAngular []CommitType = []CommitType{
		CommitTypeBuild,
		CommitTypeCI,
		CommitTypeDocs,
		CommitTypeFeat,
		CommitTypeFix,
		CommitTypePerf,
		CommitTypeRefactor,
		CommitTypeStyle,
		CommitTypeTest,
	}
)

Types

type Commit

type Commit struct {
	Type             CommitType
	Scope            string
	Description      string
	IsBreakingChange bool
}

func (Commit) IsValid

func (c Commit) IsValid() bool

func (Commit) String

func (c Commit) String() string

type CommitType

type CommitType string

const (
	CommitTypeBuild    CommitType = "build"
	CommitTypeChore    CommitType = "chore"
	CommitTypeCI       CommitType = "ci"
	CommitTypeDocs     CommitType = "docs"
	CommitTypeFeat     CommitType = "feat"
	CommitTypeFix      CommitType = "fix"
	CommitTypePerf     CommitType = "perf"
	CommitTypeRefactor CommitType = "refactor"
	CommitTypeStyle    CommitType = "style"
	CommitTypeTest     CommitType = "test"
)

func (CommitType) String

func (c CommitType) String() string

type ScopeItem

type ScopeItem struct {
	ID   string
	Body string
}

func (ScopeItem) Description

func (s ScopeItem) Description() string

func (ScopeItem) FilterValue

func (s ScopeItem) FilterValue() string

func (ScopeItem) Title

func (s ScopeItem) Title() string