commit

Documentation

Index

• Constants
• Variables
• func EmojiConfigToEmojiProfile(e config.EmojiSet) emoji.Profile
• func EmojiSummaryToSubject(emoji, summary string) string
• func FileCreate() func(string) (io.WriteCloser, error)
• func FileExists(file string) bool
• 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 TrimComments(str string) string
• 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 Configer
• type Creator
• type Emojier
• type File
• type FileOptions
• type Mode
• type Opener
• type Options
• type Placeholders
• type ReadFiler
• type Repoer
• type Request
• type Saver
• type Snapshotter
• type State

Constants

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

Variables

var PlaceholderHelp string

var PlaceholderMessage string

Functions

func EmojiConfigToEmojiProfile

func EmojiConfigToEmojiProfile(e config.EmojiSet) emoji.Profile

func EmojiSummaryToSubject

func EmojiSummaryToSubject(emoji, summary string) string

func FileCreate

func FileCreate() func(string) (io.WriteCloser, error)

func FileExists

func FileExists(file string) bool

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 TrimComments

func TrimComments(str string) string

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
	Emojier     Emojier
	Configer    Configer
	Snapshotter Snapshotter
	Opener      Opener
	ReadFiler   ReadFiler
	Repoer      Repoer
	Creator     Creator
	Saver       Saver
}

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 Configer

type Configer interface {
	Load(io.Reader) (config.Config, error)
	Save(io.WriteCloser, config.Config) error
}

type Creator

type Creator func(string) (io.WriteCloser, error)

type Emojier

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

type File

type File struct {
	Amend   bool
	Message string
}

type FileOptions

type FileOptions struct {
	MessageFile string
	Source      string
	SHA         string
}

type Mode

type Mode int

const (
	ModeUnset Mode = iota
	ModeCommit
	ModeEditor
	ModeHook
)

type Opener

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

type Options

type Options struct {
	ConfigFile   string
	SnapshotFile string
	DryRun       bool
	Amend        bool
	Mode         Mode
	File         FileOptions
}

type Placeholders

type Placeholders struct {
	Hash    string
	Summary string
	Body    string
	Help    string
}

type ReadFiler

type ReadFiler func(string) ([]byte, error)

type Repoer

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

type Request

type Request struct {
	Apply       bool
	Emoji       string
	Summary     string
	Body        string
	RawBody     string
	Footer      string
	Author      repository.User
	Amend       bool
	DryRun      bool
	File        bool
	MessageFile string
	Config      config.Config
}

type Saver

type Saver func(io.WriteCloser, snapshot.Snapshot) error

type Snapshotter

type Snapshotter interface {
	Load(io.Reader) (snapshot.Snapshot, error)
	Save(io.WriteCloser, snapshot.Snapshot) error
}

type State

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