config

package
v0.1.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 23, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package config provides exports for reading in configuration files.

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrNoLookupLocation represents when there is no filepath location to
	// find a configuration file.
	ErrNoLookupLocation = errors.New("no config file lookup location")
	// ErrNoConfig represents when no configuration file was loaded.
	ErrNoConfig = errors.New("no config file loaded")
)

Functions

This section is empty.

Types

type Config

type Config struct {
	ColorVariant string `yaml:"colorVariant"`
	Modules      []any  `yaml:"modules"`
}

Config is the data structure that represents the root of the configuration.

func GetConfig

func GetConfig(overrideFilepath string) (*Config, error)

GetConfig will retrieve a configuration file at an optionally overridden location.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL