Documentation
¶
Overview ¶
Package config provides access to Fairu configuration file.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidConfig = errors.New("invalid configuration value") ErrInvalidConfigGroup = fmt.Errorf("%w: unknown configuration group", ErrInvalidConfig) ErrInvalidConfigMap = fmt.Errorf("%w: a map is expected", ErrInvalidConfig) ErrInvalidConfigOption = fmt.Errorf("%w: an invalid option was provided", ErrInvalidConfig) ErrInvalidConfigString = fmt.Errorf("%w: a string is expected", ErrInvalidConfig) )
Errors when reading the configuration.
Functions ¶
func GetConfigFile ¶
GetConfigFile gets the default path of the configuration file.
Types ¶
type Config ¶
type Config struct {
Variables map[string]string `yaml:"Variables"`
Rules []Rule `yaml:"Rules"`
Options Options `yaml:"Options"`
}
Config contains the configuration of Fairu.
func ReadConfig ¶
ReadConfig reads the configuration from a io.Reader.
Example ¶
package main
import (
"fmt"
"os"
"github.com/anderson-lt/fairu/config"
)
func main() {
file, err := os.Open("testdata/example_config.yaml")
if err != nil {
panic(err)
}
config, err := config.ReadConfig(file)
if err != nil {
panic(err)
}
fmt.Println(config)
}
Output: <Config: 2 Variables, 4 Rules>
func (*Config) UnmarshalYAML ¶ added in v0.2.0
UnmarshalYAML implements yaml.Unmarshaler.
Source Files
Click to show internal directories.
Click to hide internal directories.