hook

Documentation

Index

• Constants
• Variables
• func Locate(run Runner) (string, error)
• type Action
• type Creator
• type Deleter
• type Hook
  • func New() Hook
  • func (h *Hook) Do(opts Options) error
  • func (h *Hook) Install() error
  • func (h *Hook) Uninstall() error
• type Locater
• type Opener
• type Options
• type Runner
• type Stater

Constants

const (
	Marker = "Code generated by Committed. DO NOT EDIT."
)

Variables

var (
	ErrAction    = errors.New("invalid hook action")
	ErrUnmanaged = errors.New("hook file unmanaged")
)

var ErrLocation = errors.New("no hook location found")

var GitHook = "hooks/prepare-commit-msg"

var PrepareGitMessage string

Functions

func Locate

func Locate(run Runner) (string, error)

Types

type Action

type Action int

const (
	ActionUnset Action = iota
	ActionInstall
	ActionUninstall
	ActionCommit
)

type Creator

type Creator func(name string, flag int, perm os.FileMode) (*os.File, error)

type Deleter

type Deleter func(string) error

type Hook

type Hook struct {
	Creator Creator
	Locater Locater
	Deleter Deleter
	Opener  Opener
	Runner  Runner
	Stater  Stater

	Location  string
	Directory string
	// contains filtered or unexported fields
}

func New

func New() Hook

func (*Hook) Do

func (h *Hook) Do(opts Options) error

func (*Hook) Install

func (h *Hook) Install() error

func (*Hook) Uninstall

func (h *Hook) Uninstall() error

type Locater

type Locater func(run Runner) (string, error)

type Opener

type Opener func(string) (*os.File, error)

type Options

type Options struct {
	Install   bool
	Uninstall bool
	Commit    bool
}

type Runner

type Runner func(io.Writer, string, []string) error

type Stater

type Stater func(string) (os.FileInfo, error)