convention

type BreakingChanges struct {
	Describe string
}

type Commit struct {
	// Commit as is
	RawHeader string

	Type  string
	Scope string

	BreakingChanges BreakingChanges

	IssueInfo IssueInfo
}

type CommitRenderTemplate struct {
	GitUrlRenderTemplate
	Hash string `handlebars:"hash"`
}

type CompareRenderTemplate struct {
	GitUrlRenderTemplate
	PreviousTag string `handlebars:"previousTag"`
	CurrentTag  string `handlebars:"currentTag"`
}

type ConventionalChangeLogSpec struct {

	// Types
	//
	Types []Types `json:"types,omitempty"`

	// TagPrefix
	//	default is v
	TagPrefix string `json:"tag-prefix,omitempty"`

	// HashLength
	//	default is 8
	HashLength uint `json:"hash-length,omitempty"`

	// IssuePrefixes
	// default is ["#"]
	IssuePrefixes []string `json:"issuePrefixes,omitempty"`

	// Header
	//	A string to be used as the main header of the CHANGELOG
	// default DefaultHeader
	Header string `json:"header,omitempty"`

	// CommitUrlFormat
	//	A URL representing a specific commit at a Hash
	// default DefaultCommitUrlFormat
	CommitUrlFormat string `json:"commitUrlFormat,omitempty"`

	// CompareUrlFormat
	//	A URL representing the comparison between two git shas
	// default DefaultCompareUrlFormat
	CompareUrlFormat string `json:"compareUrlFormat,omitempty"`

	// IssueUrlFormat
	//	A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc)
	// default DefaultIssueUrlFormat
	IssueUrlFormat string `json:"issueUrlFormat,omitempty"`

	// UserUrlFormat
	//	A URL representing a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.
	// default DefaultUserUrlFormat
	UserUrlFormat string `json:"userUrlFormat,omitempty"`

	// ReleaseCommitMessageFormat
	//	A string to be used to format the auto-generated release commit message
	// default DefaultReleaseCommitMessageFormat
	ReleaseCommitMessageFormat string `json:"releaseCommitMessageFormat,omitempty"`

	// CoverHttpHost
	// this will cover all http host
	CoverHttpHost string `json:"cover-http-host,omitempty"`

	// MonoRepoPkgPathList
	// monorepo package path list
	MonoRepoPkgPathList []string `json:"monorepo-pkg-path,omitempty"`
}

type GitRepositoryHttpInfo struct {
	// Scheme is the protocol scheme of the remote host. https or http.
	// do not use git+ssh, it will be some error
	Scheme string

	// Host is the hostname:port of the remote host.
	Host string

	// Owner is the owner of the repository.
	Owner string

	// Repository is the name of the repository.
	Repository string
}

type GitUrlRenderTemplate struct {
	Scheme     string `handlebars:"scheme"`
	Host       string `handlebars:"host"`
	Owner      string `handlebars:"owner"`
	Repository string `handlebars:"repository"`
}

type IssueInfo struct {
	IssueReference    string
	IssuePrefix       string
	IssueReferencesId uint64
}

type IssueRenderTemplate struct {
	GitUrlRenderTemplate
	Id string `handlebars:"id"`
}

type OptionFn func(*Commit) error

type ReleaseCommitMessageRenderTemplate struct {
	CurrentTag string `handlebars:"currentTag"`
}

type Types struct {

	// Type
	//
	Type string `json:"type"`

	// Section
	//
	Section string `json:"section,omitempty"`

	// Hidden
	//
	Hidden bool `json:"hidden"`

	// Sort
	Sort uint `json:"sort,omitempty"`
}