rule

Documentation

Index

• type Rule
  • func (r Rule) Admit(d os.DirEntry, relPath string) bool

Types

type Rule

type Rule struct {
	// Mode is a behaviour backed by a function from the `mode` package
	Mode string `yaml:"mode"`
	// Prefix is a literal path prefix to be matched against the passed file path
	Prefix string `yaml:"prefix"`
	// NameEx is a regex to be matched against the passed file base name
	NameEx string `yaml:"name"`
	// Negate reverses the rule match effect
	Negate bool `yaml:"negate"`

	// ModeFn is an `mode` package function to invoke on passed file / dir entry
	ModeFn func(os.DirEntry) bool
}

Rule is a single configuration rule entity (a list of rules is contained by a config.Config)

func (Rule) Admit

func (r Rule) Admit(d os.DirEntry, relPath string) bool

Admit is a local "decider" function that includes/excludes the path given [on the single rule level]