githook

Documentation

Index

• Variables
• type CommandData
• type Githook
  • func New(options ...Option) *Githook
  • func (g *Githook) Install() error
  • func (g *Githook) Run() error
  • func (g *Githook) StartCommandSurvey() error
• type Option
  • func WithCommandData(cd *CommandData) Option
  • func WithGitDir(dir string) Option

Variables

var (
	// Hooks a list of all available git hooks
	Hooks = []string{
		"applypatch-msg",
		"commit-msg",
		"post-commit",
		"post-receive",
		"post-update",
		"pre-applypatch",
		"pre-commit",
		"prepare-commit-msg",
		"pre-rebase",
		"update",
	}
)

Types

type CommandData

type CommandData struct {
	Path  string
	Hooks []string
}

CommandData contains all command related data

type Githook

type Githook struct {
	Path        string
	GitDir      string
	CommandData *CommandData
}

Githook command to create git hooks

func New

func New(options ...Option) *Githook

New with the given options.

func (*Githook) Install

func (g *Githook) Install() error

Install will create hard links from local git_hooks to the corresponding git hooks

func (*Githook) Run

func (g *Githook) Run() error

Run the command

func (*Githook) StartCommandSurvey

func (g *Githook) StartCommandSurvey() error

StartCommandSurvey collect all required informations from user

type Option

type Option func(*Githook)

Option function.

func WithCommandData

func WithCommandData(cd *CommandData) Option

WithCommandData option.

func WithGitDir

func WithGitDir(dir string) Option

WithGitDir option.