commit

Documentation

Index

• Constants
• Variables
• func EmojiConfigToEmojiProfile(e config.EmojiSet) emoji.Profile
• func EmojiSummaryToSubject(emoji, summary string) string
• func FileOpen() func(string) (io.Reader, error)
• func MessageToBody(msg string) string
• func MessageToEmoji(set *emoji.Set, msg string) emoji.NullEmoji
• func MessageToSummary(msg string) string
• func SortUsersByDefault(us ...repository.User) []repository.User
• func UserToAuthor(user repository.User) string
• type Applier
• type Commit
  • func New() Commit
  • func (c *Commit) Apply(req *Request) error
  • func (c *Commit) Configure(opts Options) (*State, error)
• type Config
• type Emojier
• type Loader
• type Opener
• type Options
• type Placeholders
• type Repoer
• type Request
• type State

Constants

const (
	PlaceholderHash    string = "1234567890abcdef1234567890abcdef1234567890"
	PlaceholderSummary string = "Capitalized, short (50 chars or less) summary"
)

Variables

var PlaceholderMessage string

Functions

func EmojiConfigToEmojiProfile

func EmojiConfigToEmojiProfile(e config.EmojiSet) emoji.Profile

func EmojiSummaryToSubject

func EmojiSummaryToSubject(emoji, summary string) string

func FileOpen

func FileOpen() func(string) (io.Reader, error)

func MessageToBody

func MessageToBody(msg string) string

func MessageToEmoji

func MessageToEmoji(set *emoji.Set, msg string) emoji.NullEmoji

func MessageToSummary

func MessageToSummary(msg string) string

func SortUsersByDefault

func SortUsersByDefault(us ...repository.User) []repository.User

func UserToAuthor

func UserToAuthor(user repository.User) string

Types

type Applier

type Applier func(repository.Commit, ...func(c *repository.Commit)) error

type Commit

type Commit struct {
	Options Options
	Applier Applier
	Emojier Emojier
	Loader  Loader
	Opener  Opener
	Repoer  Repoer
}

func New

func New() Commit

func (*Commit) Apply

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

func (*Commit) Configure

func (c *Commit) Configure(opts Options) (*State, error)

type Config

type Config struct {
	View    config.View
	Commit  config.Commit
	Authors []repository.User
}

type Emojier

type Emojier func(...func(*emoji.Set)) *emoji.Set

type Loader

type Loader func(io.Reader) (config.Config, error)

type Opener

type Opener func(string) (io.Reader, error)

type Options

type Options struct {
	ConfigFile string
	DryRun     bool
	Amend      bool
}

type Placeholders

type Placeholders struct {
	Hash    string
	Summary string
	Body    string
}

type Repoer

type Repoer interface {
	Open() error
	Describe() (repository.Description, error)
}

type Request

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

type State

type State struct {
	Placeholders Placeholders
	Repository   repository.Description
	Emojis       *emoji.Set
	Theme        theme.Theme
	Config       config.Config
	Options      Options
}