config

Documentation

Index

• type Config
  • func NewConfig(filename string, disableDefaultRules bool) (*Config, error)
  • func (c *Config) ConfigureRules(disableDefaultRules bool)
  • func (c *Config) GetSuccessExitMessage() string
  • func (c *Config) RemoveRule(i int)

Types

type Config

type Config struct {
	Rules              []*rule.Rule `yaml:"rules"`
	IgnoreFiles        []string     `yaml:"ignore_files"`
	SuccessExitMessage *string      `yaml:"success_exit_message"`
	IncludeNote        bool         `yaml:"include_note"`
	ExcludeCategories  []string     `yaml:"exclude_categories"`
}

Config contains a list of rules

func NewConfig

func NewConfig(filename string, disableDefaultRules bool) (*Config, error)

NewConfig returns a new Config

func (*Config) ConfigureRules

func (c *Config) ConfigureRules(disableDefaultRules bool)

ConfigureRules adds the config Rules to DefaultRules Configure RegExps for all rules Configure IncludeNote for all rules Filter out any rules that fall under ExcludeCategories

func (*Config) GetSuccessExitMessage

func (c *Config) GetSuccessExitMessage() string

GetSuccessExitMessage returns the message to be shows on a successful exit as defined in the config, or a default message.

func (*Config) RemoveRule

func (c *Config) RemoveRule(i int)

Remove rule at index i in c.Rules while maintaining order