https://github.com/ultimaweapon/vars

Simple and yet powerful configuration management for Go
https://github.com/ultimaweapon/vars

configuration environment-variables go

Last synced: about 2 months ago
JSON representation

Simple and yet powerful configuration management for Go

• Host: GitHub
• URL: https://github.com/ultimaweapon/vars
• Owner: ultimaweapon
• License: mit
• Created: 2022-03-11T16:16:45.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-16T22:11:53.000Z (almost 3 years ago)
• Last Synced: 2024-12-16T20:15:59.158Z (about 2 months ago)
• Topics: configuration, environment-variables, go
• Language: Go
• Homepage:
• Size: 11.7 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Go Vars

[![Go Reference](https://pkg.go.dev/badge/github.com/ultimicro/vars.svg)](https://pkg.go.dev/github.com/ultimicro/vars)

This is a Go library for simple configuration management. It act as a key-value store backed with default value. Each

value can be override with environment variable. This library utilize generics in Go 1.18.

## Usage

```go

package main

import (

	"errors"

	"io/fs"

	"log"

	"github.com/joho/godotenv"

	"github.com/ultimicro/vars"

)

const (

	KeyFoo vars.Key[int]    = "Foo"

	KeyBar vars.Key[string] = "Bar"

)

func main() {

	vars.SetDefault(KeyFoo, 7)

	vars.SetDefault(KeyBar, "abc")

	// When lookup for environment variable the specified key will transform to

	// snake case in upper case (e.g. MYAPP_KEY1) by default. Use

	// SetEnvKeyTransformer() to change this behavior.

	vars.SetEnvPrefix("MYAPP_")

	// Remove the following code if you don't want to load .env file.

	if err := godotenv.Load(); err != nil {

		if !errors.Is(err, fs.ErrNotExist) {

			log.Fatalln(err)

		}

	}

	// Now you can access your configuration with vars.Get(Key).

}

```

### Override environment variable name

You can override environment variable name for a specific key by using `SetEnvName`:

```go

vars.SetEnvName(Key, "SOmeWeIrDNaME")

```

This name will not get transformed by `KeyTransformer` but the prefix that was specified by `SetEnvPrefix` still in

effect.

### Custom parser

If you need to change how the value is parsed you can set an implementation of `ValueParser` to use with `SetParser`:

```go

vars.SetParser[SomeType](Key, &SomeTypeParser{})

```

Yes you need to specify type manually due to currently Go cannot infer type in this case.

## License

MIT