git

Documentation

Index

• Constants
• type Command
  • func New(opts ...Option) *Command
  • func (c *Command) Commit(val string) (string, error)
  • func (c *Command) DiffFiles() (string, error)
  • func (c *Command) GitDir() (string, error)
  • func (c *Command) InstallHook() error
  • func (c *Command) UninstallHook() error
• type Option
  • func WithDiffUnified(val int) Option
  • func WithEnableAmend(val bool) Option
  • func WithExcludeList(val []string) Option

Constants

const (
	HookPrepareCommitMessageTemplate = "prepare-commit-msg"
	CommitMessageTemplate            = "commit-msg.tmpl"
)

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Command

func (*Command) Commit

func (c *Command) Commit(val string) (string, error)

func (*Command) DiffFiles

func (c *Command) DiffFiles() (string, error)

Diff compares the differences between two sets of data. It returns a string representing the differences and an error. If there are no differences, it returns an empty string and an error.

func (*Command) GitDir

func (c *Command) GitDir() (string, error)

GitDir to show the (by default, absolute) path of the git directory of the working tree.

func (*Command) InstallHook

func (c *Command) InstallHook() error

func (*Command) UninstallHook

func (c *Command) UninstallHook() error

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is an interface that specifies instrumentation configuration options.

func WithDiffUnified

func WithDiffUnified(val int) Option

WithDiffUnified is a function that generate diffs with <n> lines of context instead of the usual three.

func WithEnableAmend

func WithEnableAmend(val bool) Option

WithEnableAmend returns an Option that sets the isAmend field of a config object to the given value.

func WithExcludeList

func WithExcludeList(val []string) Option

WithExcludeList returns an Option that sets the excludeList field of a config object to the given value.