rules

Documentation

Index

• type RuleAction
• type RuleMeta
• type RuleString
• type SimplifiedRule
  • func Load(dir string) ([]*SimplifiedRule, map[string]*SimplifiedRule, error)
  • func Parse(filePath string) ([]*SimplifiedRule, error)
  • func (r *SimplifiedRule) Evaluate(ctx *event.Context) (bool, error)
• type YAMLRule

Types

type RuleAction

type RuleAction struct {
	Type actions.ActionType `yaml:"type"`

	// Optional fields depending on the action
	ChannelID string `yaml:"channelId,omitempty"`
	Message   string `yaml:"message,omitempty"`
	Duration  string `yaml:"duration,omitempty"`
	Reason    string `yaml:"reason,omitempty"`
}

type RuleMeta

type RuleMeta struct {
	Event      event.EventType `yaml:"event"`
	IgnoreBots bool            `yaml:"ignoreBots"`
}

type RuleString

type RuleString struct {
	Name  string `yaml:"name"`
	Value string `yaml:"value"`
}

type SimplifiedRule

type SimplifiedRule struct {
	Name       string
	Disabled   bool
	Event      event.EventType
	IgnoreBots bool

	Strings map[string]RuleString
	Program cel.Program

	Actions []RuleAction

	RawExpression string
}

func Load

func Load(dir string) ([]*SimplifiedRule, map[string]*SimplifiedRule, error)

func Parse

func Parse(filePath string) ([]*SimplifiedRule, error)

func (*SimplifiedRule) Evaluate

func (r *SimplifiedRule) Evaluate(ctx *event.Context) (bool, error)

type YAMLRule

type YAMLRule struct {
	Rule struct {
		Name       string       `yaml:"name"`
		Disabled   bool         `yaml:"disabled"`
		Meta       RuleMeta     `yaml:"meta"`
		Strings    []RuleString `yaml:"strings"`
		Expression string       `yaml:"expression"`
		Actions    []RuleAction `yaml:"actions"`
	} `yaml:"rule"`
}