rules

Documentation

Index

• type Action
• type ActionContext
• type Alias
  • func (a Alias) Apply(actx *ActionContext) error
  • func (a Alias) Pprint()
• type Delete
  • func (d Delete) Apply(actx *ActionContext) error
  • func (d Delete) Pprint()
• type Export
  • func (e Export) Apply(actx *ActionContext) error
  • func (e Export) Pprint()
• type Migrate
  • func (m Migrate) Apply(actx *ActionContext) error
  • func (m Migrate) Pprint()
• type MissingRulesFile
  • func (e *MissingRulesFile) Error() string
• type Rule
  • func MatchRule(dotfile *dotfile.Dotfile) *Rule
  • func (r Rule) Apply(actx *ActionContext)
  • func (r Rule) Pprint()
• type RulesConfig
  • func LoadRulesConfig(filepath string) (RulesConfig, error)

Types

type Action

type Action interface {
	Apply(*ActionContext) error
	Pprint()
}

type ActionContext

type ActionContext struct {
	KeyValueStore *shell.KeyValueStore
}

type Alias

type Alias struct {
	Alias   string
	Command string
}

func (Alias) Apply

func (a Alias) Apply(actx *ActionContext) error

TODO: remove code duplication with export.go

func (Alias) Pprint

func (a Alias) Pprint()

type Delete

type Delete struct {
	Path string
}

func (Delete) Apply

func (d Delete) Apply(actx *ActionContext) error

func (Delete) Pprint

func (d Delete) Pprint()

type Export

type Export struct {
	Key   string
	Value string
}

func (Export) Apply

func (e Export) Apply(actx *ActionContext) error

func (Export) Pprint

func (e Export) Pprint()

type Migrate

type Migrate struct {
	Source  string
	Dest    string
	Symlink bool
}

func (Migrate) Apply

func (m Migrate) Apply(actx *ActionContext) error

func (Migrate) Pprint

func (m Migrate) Pprint()

type MissingRulesFile

type MissingRulesFile struct{}

func (*MissingRulesFile) Error

func (e *MissingRulesFile) Error() string

type Rule

type Rule struct {
	Name        string
	Description string
	Dotfile     *dotfile.Dotfile
	Ignore      bool
	Actions     []Action
	Notes       []string
}

func MatchRule

func MatchRule(dotfile *dotfile.Dotfile) *Rule

func (Rule) Apply

func (r Rule) Apply(actx *ActionContext)

TODO: return the error

func (Rule) Pprint

func (r Rule) Pprint()

type RulesConfig

type RulesConfig struct {
	Version int
	Rules   []Rule
}

func LoadRulesConfig

func LoadRulesConfig(filepath string) (RulesConfig, error)

TODO: return a pointer to RulesConfig