config

Documentation

Index

• type Config
  • func DefaultConfig() Config
  • func NewConfig(path string) (cfg Config, err error)
  • func (cfg Config) Admit(d os.DirEntry, relPath string) bool
  • func (cfg Config) WithNameEx(nameEx string) Config

Types

type Config

type Config struct {
	Rules []rule.Rule `yaml:"rules"`

	IsDefault bool
}

Config is a travelgrunt repo-level configuration (a sequentially evaluated list of rules)

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns default travelgrunt repo-level configuration

func NewConfig

func NewConfig(path string) (cfg Config, err error)

NewConfig creates new travelgrunt repo-level configuration

func (Config) Admit

func (cfg Config) Admit(d os.DirEntry, relPath string) bool

Admit is a global "decider" function that includes/excludes the path given

func (Config) WithNameEx

func (cfg Config) WithNameEx(nameEx string) Config

WithNameEx returns a copy of config with regex-based rule added