dotenvconfig

README

DotEnvConfig

Library responsible for configuring Go applications.

Installation

go get github.com/andrewapj/dotenvconfig

Usage

Loading a config file

err := Load(getFS(), "config.env", Options{})

Config file

A config file should end with .env and its content should be in the following format:

TEST_KEY=123

# This is a comment

TEST_KEY2 = 456

Get Key

Get a key from the config

val, err := cfg.GetKey("KEY")

Get Key Must

Get a key from the config, panic if the key is missing

val := cfg.GetKeyMust("KEY")

Get Int Key

Get an integer value from the config.

i, err := cfg.GetKeyAsInt("TEST_KEY")

Get Int Key Must

Get an integer value from the config, panic if the key is missing

i := cfg.GetKeyAsIntMust("TEST_KEY")

Documentation

Index

• Variables
• func GetKey(key string) (string, error)
• func GetKeyAsInt(key string) (int, error)
• func GetKeyAsIntMust(key string) int
• func GetKeyMust(key string) string
• func Load(fSys fs.FS, path string, opts Options) error
• type Options

Variables

var ErrConversion = errors.New("error, unable to convert value from string")

var ErrFsIsNil = errors.New("error, the FS was nil")

var ErrMissingKey = errors.New("error, could not find key")

Functions

func GetKey

func GetKey(key string) (string, error)

GetKey retrieves a value from the config by key.

func GetKeyAsInt

func GetKeyAsInt(key string) (int, error)

GetKeyAsInt retrieves a value from the config by key and converts the value to an int. If the key could not be found or the value can not be converted to an int, a zero is returned.

func GetKeyAsIntMust

func GetKeyAsIntMust(key string) int

GetKeyAsIntMust retrieves a value from the config by key and converts the value to an int. If the key could not be found or the value can not be converted to an int, the function will panic.

func GetKeyMust

func GetKeyMust(key string) string

GetKeyMust retrieves a value from the config by key. It panics if the key does not exist.

func Load

func Load(fSys fs.FS, path string, opts Options) error

Load reads the config from an env file and adds it to the environment. If an environment variable already exists then it is not overwritten.

Types

type Options

type Options struct {
	// JsonLogging indicates whether logging should be done in JSON format.
	JsonLogging bool

	// LoggingEnabled determines if logging is enabled for the library.
	LoggingEnabled bool
}

Options contains optional ways to configure an application.