configuration

Documentation

Index

• Variables
• type GookmeConfiguration
  • func LoadConfiguration(directory string, hookType HookType) (*GookmeConfiguration, error)
• type GookmeGlobalConfiguration
  • func DefaultGlobalConfiguration() *GookmeGlobalConfiguration
  • func LoadGlobalConfiguration(directory string) (*GookmeGlobalConfiguration, error)
• type Hook
  • func LoadHooksConfiguration(directory string, hookType HookType) ([]Hook, error)
• type HookConfiguration
• type HookFixture
  • func NewHookFixture(path string) *HookFixture
  • func (hf *HookFixture) Copy() *HookFixture
  • func (hf *HookFixture) ToHook() Hook
  • func (hf *HookFixture) WithFiles(files ...string) *HookFixture
  • func (hf *HookFixture) WithStep(step ...*StepFixture) *HookFixture
• type HookType
• type OnModifiedFileBehaviour
• type Step
• type StepConfiguration
• type StepFixture
  • func NewStepFixture() *StepFixture
  • func (sf *StepFixture) Copy() *StepFixture
  • func (sf *StepFixture) ToStep() *Step
  • func (sf *StepFixture) WithFiles(files ...string) *StepFixture
  • func (sf *StepFixture) WithOnlyOn(onlyOn string) *StepFixture

Variables

var ALL_HOOKS = []HookType{
	PreCommitHookType,
	PrepareCommitHookType,
	CommitMsgHookType,
	PostCommitHookType,
	PostMergeHookType,
	PostRewriteHookType,
	PreRebaseHookType,
	PostCheckoutHookType,
	PrePushHookType,
}

var ALL_HOOKS_STRING = []string{
	string(PreCommitHookType),
	string(PrepareCommitHookType),
	string(CommitMsgHookType),
	string(PostCommitHookType),
	string(PostMergeHookType),
	string(PostRewriteHookType),
	string(PreRebaseHookType),
	string(PostCheckoutHookType),
	string(PrePushHookType),
}

Types

type GookmeConfiguration

type GookmeConfiguration struct {
	Global GookmeGlobalConfiguration
	Hooks  []Hook
}

func LoadConfiguration

func LoadConfiguration(directory string, hookType HookType) (*GookmeConfiguration, error)

type GookmeGlobalConfiguration

type GookmeGlobalConfiguration struct {
	// The behaviour to use when there are modified files at the end of the hook.
	OnModifiedFiles *OnModifiedFileBehaviour `json:"onModifiedFiles,omitempty"`
}

Global configuration for the Gookme tool. Behaviours defined here will be used for all hooks to run.

The Gookme global configuration is a JSON file named .gookme.json, located at the root of the repository.

func DefaultGlobalConfiguration

func DefaultGlobalConfiguration() *GookmeGlobalConfiguration

func LoadGlobalConfiguration

func LoadGlobalConfiguration(directory string) (*GookmeGlobalConfiguration, error)

type Hook

type Hook struct {
	Path  string
	Files []string
	Steps []Step
}

func LoadHooksConfiguration

func LoadHooksConfiguration(directory string, hookType HookType) ([]Hook, error)

type HookConfiguration

type HookConfiguration struct {
	Steps []StepConfiguration `json:"steps"`
}

Configuration for a hook.

The Gookme hook configuration is a JSON file named .{hookType}.json, located in a subfolder or at the root of the repository. The hookType is the type of Git hook to attach the configuration to, such as pre-commit, post-merge, etc.

type HookFixture

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

func NewHookFixture

func NewHookFixture(path string) *HookFixture

func (*HookFixture) Copy

func (hf *HookFixture) Copy() *HookFixture

func (*HookFixture) ToHook

func (hf *HookFixture) ToHook() Hook

func (*HookFixture) WithFiles

func (hf *HookFixture) WithFiles(files ...string) *HookFixture

func (*HookFixture) WithStep

func (hf *HookFixture) WithStep(step ...*StepFixture) *HookFixture

type HookType

type HookType string

const (
	PreCommitHookType     HookType = "pre-commit"
	PrepareCommitHookType HookType = "prepare-commit-msg"
	CommitMsgHookType     HookType = "commit-msg"
	PostCommitHookType    HookType = "post-commit"
	PostMergeHookType     HookType = "post-merge"
	PostRewriteHookType   HookType = "post-rewrite"
	PreRebaseHookType     HookType = "pre-rebase"
	PostCheckoutHookType  HookType = "post-checkout"
	PrePushHookType       HookType = "pre-push"
)

type OnModifiedFileBehaviour

type OnModifiedFileBehaviour string

const (
	AddAndCommit OnModifiedFileBehaviour = "addAndCommit"
	Abort        OnModifiedFileBehaviour = "abort"
)

type Step

type Step struct {
	ID                  string
	Name                string
	Command             string
	ExecutedCommand     string
	OnlyOn              *string
	Serial              bool
	From                *string
	PackageRelativePath string
	Files               []string
}

type StepConfiguration

type StepConfiguration struct {
	// The named of the step. Displayed in the UI and used in it to index steps and hooks
	Name string `json:"name"`

	// The command that will be invoked in `execSync`
	Command string `json:"command"`

	// A pattern string describing which changed files will trigger this step
	OnlyOn *string `json:"onlyOn,omitempty"`

	// Should this step be awaited before starting the next one
	Serial *bool `json:"serial,omitempty"`

	// Does this step extend a shared step
	From *string `json:"from,omitempty"`
}

Configuration for a single step in a hook.

type StepFixture

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

func NewStepFixture

func NewStepFixture() *StepFixture

func (*StepFixture) Copy

func (sf *StepFixture) Copy() *StepFixture

func (*StepFixture) ToStep

func (sf *StepFixture) ToStep() *Step

func (*StepFixture) WithFiles

func (sf *StepFixture) WithFiles(files ...string) *StepFixture

func (*StepFixture) WithOnlyOn

func (sf *StepFixture) WithOnlyOn(onlyOn string) *StepFixture