commit

Documentation

Index

• type Commit
  • func New(opts Options) (*Commit, error)
  • func (c *Commit) Apply() error
  • func (c *Commit) EmojiSummaryToSubject() string
  • func (c *Commit) UserToAuthor() string
• type Config
  • func (c *Config) MessageToBody() string
  • func (c *Config) MessageToEmoji() emoji.NullEmoji
  • func (c *Config) MessageToSummary() string
• type Options
• type Placeholders

Types

type Commit

type Commit struct {
	Config  Config
	Emoji   string
	Summary string
	Body    string
	Footer  string
	Author  repository.User
	Options Options
	Applier func(c repository.Commit, opts ...repository.CommitOptions) error
	// contains filtered or unexported fields
}

func New

func New(opts Options) (*Commit, error)

func (*Commit) Apply

func (c *Commit) Apply() error

func (*Commit) EmojiSummaryToSubject

func (c *Commit) EmojiSummaryToSubject() string

func (*Commit) UserToAuthor

func (c *Commit) UserToAuthor() string

type Config

type Config struct {
	Placeholders Placeholders
	Repository   repository.Description
	Emojis       []emoji.Emoji
	Emoji        emoji.NullEmoji
	Summary      string
	Body         string
	Amend        bool
}

func (*Config) MessageToBody

func (c *Config) MessageToBody() string

func (*Config) MessageToEmoji

func (c *Config) MessageToEmoji() emoji.NullEmoji

func (*Config) MessageToSummary

func (c *Config) MessageToSummary() string

type Options

type Options struct {
	Apply bool
	Amend bool
}

type Placeholders

type Placeholders struct {
	Hash    string
	Summary string
	Body    string
}