tinyviper

README

tiny-viper

A minimalistic approach to spf13/viper.

Features

• Read ENV variables into a struct
• Read a .env file into a struct
• < 110 source lines of code
• No dependencies

Only string fields are supported.

Usage

package main

import (
	"github.com/nobloat/tinyviper"
	"fmt"
)

type Config struct {
	UserConfig struct {
		Email    string `env:"MY_APP_EMAIL"`
		Password string `env:"MY_APP_PASSWORD"`
        someOtherProperty string
	}
	Endpoint string `env:"MY_APP_ENDPOINT"`
}

func main() {
  cfg := Config{Endpoint: "some default endpoint"}
  err := tinyviper.LoadFromResolver(&cfg, tinyviper.NewEnvResolver(), tinyviper.NewEnvFileResolver(".env.sample"))
  if err != nil {
    panic(err)
  }

  fmt.Println("%+v", cfg)
}

Documentation

Index

• func LoadFromResolver[T any](cfg *T, resolver ...Resolver) error
• type EnvFileResolver
  • func (e EnvFileResolver) Get(key string) string
• type EnvResolver
  • func (e EnvResolver) Get(key string) string
• type Resolver
  • func NewEnvFileResolver(filename string) Resolver
  • func NewEnvResolver() Resolver

Functions

func LoadFromResolver

func LoadFromResolver[T any](cfg *T, resolver ...Resolver) error

Types

type EnvFileResolver

type EnvFileResolver struct {
	Variables map[string]string
}

func (EnvFileResolver) Get

func (e EnvFileResolver) Get(key string) string

type EnvResolver

type EnvResolver struct{}

func (EnvResolver) Get

func (e EnvResolver) Get(key string) string

type Resolver

type Resolver interface {
	Get(key string) string
}

func NewEnvFileResolver

func NewEnvFileResolver(filename string) Resolver

func NewEnvResolver

func NewEnvResolver() Resolver