util

Documentation

Overview

Package util contains common functionality for "utilities" required by the bot.

This file is for processing the application's configuration from a YAML file.

Index

• type Config
  • func NewConfig(params ...string) *Config
  • func (c *Config) EnabledPlugins() []string
• type Plugin
  • func LoadPlugins(filenames []string) ([]*Plugin, []error)
  • func (p *Plugin) Run(c *command.Command) []*command.Response

Types

type Config

type Config struct {
	IRC              *ircConfig               `yaml:"irc"`
	Plugins          map[string]*pluginConfig `yaml:"plugins"`
	UnparsedLogLevel string                   `yaml:"log_level"`

	LogLevel logrus.Level
}

Config contains the entire application's configuration.

func NewConfig

func NewConfig(params ...string) *Config

NewConfig sets up the application's configuration.

func (*Config) EnabledPlugins

func (c *Config) EnabledPlugins() []string

type Plugin

type Plugin struct {
	// Contrib is the external plugin.
	Contrib contrib.Plugin
}

Plugin is a contributed plugin. It is wrapped with this struct so the Run function can be added for running user input against commands.

func LoadPlugins

func LoadPlugins(filenames []string) ([]*Plugin, []error)

LoadPlugins loads contributed plugins by filename. Any plugin which fails to load or doesn't have the correct function will instead add an error to the errors list.

func (*Plugin) Run

func (p *Plugin) Run(c *command.Command) []*command.Response

Run runs user input against the commands in the contributed plugin. Any command which returns input will be added to Run's output list.