config

Documentation

Index

• func Marshal(opts ...OptT) string
• func WithWindow(window time.Duration) func(*optsT)
• func WriteDefaultConfig(path string, opts ...OptT) error
• type Config
  • func LoadConfig(dir, file string, opts ...OptT) (*Config, error)
  • func LoadConfigFromBytes(data string) (*Config, error)
  • func (c *Config) ResolveOpts() (opts []resolve.OptT)
• type NotificationWebhook
• type OptT
• type Regex
• type Rules

Functions

func Marshal

func Marshal(opts ...OptT) string

func WithWindow

func WithWindow(window time.Duration) func(*optsT)

func WriteDefaultConfig

func WriteDefaultConfig(path string, opts ...OptT) error

Types

type Config

type Config struct {
	TimestampRegexes []Regex             `yaml:"timestamps"`
	Rules            Rules               `yaml:"rules"`
	UpdateFrequency  *time.Duration      `yaml:"updateFrequency"`
	RulesVersion     string              `yaml:"rulesVersion"`
	AcceptUpdates    bool                `yaml:"acceptUpdates"`
	DataSources      string              `yaml:"dataSources"`
	Notification     NotificationWebhook `yaml:"notification"`
	Window           time.Duration       `yaml:"window"`
	Skip             int                 `yaml:"skip"`
}

func LoadConfig

func LoadConfig(dir, file string, opts ...OptT) (*Config, error)

func LoadConfigFromBytes

func LoadConfigFromBytes(data string) (*Config, error)

func (*Config) ResolveOpts

func (c *Config) ResolveOpts() (opts []resolve.OptT)

type NotificationWebhook

type NotificationWebhook struct {
	Type    string `yaml:"type"`
	Webhook string `yaml:"webhook"`
}

type OptT

type OptT func(*optsT)

type Regex

type Regex struct {
	Pattern string `yaml:"pattern"`
	Format  string `yaml:"format"`
}

type Rules

type Rules struct {
	Paths    []string `yaml:"paths"`
	Disabled bool     `yaml:"disableCommunityRules"`
}