commit

Documentation

Index

• func EmojiSummaryToSubject(emoji, summary string) string
• func MessageToBody(msg string) string
• func MessageToEmoji(msg string) emoji.NullEmoji
• func MessageToSummary(msg string) string
• func UserToAuthor(user repository.User) string
• type Commit
  • func New(opts Options) (*Commit, error)
  • func (c *Commit) Apply(req *Request) error
• type Config
• type Options
• type Placeholders
• type Request

Functions

func EmojiSummaryToSubject

func EmojiSummaryToSubject(emoji, summary string) string

func MessageToBody

func MessageToBody(msg string) string

func MessageToEmoji

func MessageToEmoji(msg string) emoji.NullEmoji

func MessageToSummary

func MessageToSummary(msg string) string

func UserToAuthor

func UserToAuthor(user repository.User) string

Types

type Commit

type Commit struct {
	Config  Config
	Options Options
	Applier func(c repository.Commit, opts ...repository.CommitOptions) error
}

func New

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

func (*Commit) Apply

func (c *Commit) Apply(req *Request) error

type Config

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

type Options

type Options struct {
	DryRun bool
	Amend  bool
}

type Placeholders

type Placeholders struct {
	Hash    string
	Summary string
	Body    string
}

type Request

type Request struct {
	Emoji   string
	Summary string
	Body    string
	Footer  string
	Author  repository.User
}