Giter VIP home page Giter VIP logo

openvvar's Introduction

github codecov

openvvar - Opinionated Environment Variables

Package openvvar provides an easy way to manage flags and environment variables at same time. Making use of struct tags to structure your configurations, providing neat features like nested structs for correlated configurations, required fields, default values for all the "primitive" types, like ints, uints, strings, booleans, floats, time.Duration and slices for any of those types.

Usage

package main

import (
    "fmt"
    "time"
    "os"
    "github.com/fogodev/openvvar"
)

type DatabaseConfig struct {
    Name     string `config:"name;default=postgresql,options=postgresql,mysql"`
    Host     string `config:"host;default=localhost"`
    Port     int    `config:"port;default=5432"`
    User     string `config:"user;required"`
    Password string `config:"password;required"`
}

type Config struct {
    Database          DatabaseConfig
    Debug             bool          `config:"debug;default=false;description=Set this config to true for debug log"`
    AcceptedHeroNames []string      `config:"hero-names;default=Deadpool,Iron Man,Dr. Strange,Rocket Raccon"`
    UniversalAnswer   uint8         `config:"universal-answer;default=42;short=u;description=THE ANSWER TO LIFE, THE UNIVERSE AND EVERYTHING"`
    SomeRandomFloat   float64       `config:"random-float;default=149714.1241"`
    OneSecond         time.Duration `config:"second;default=1s"`
}

func main() {
    configs := Config{}
    if err := openvvar.Load(&configs); err != nil {
        fmt.Fprintln(os.Stderr, err)
        os.Exit(1)
    }
    /*
        ...
    */
}

Nested fields have their parent field name concatenated to its own name

$ DATABASE_USER=root # For environment variables

$ ./your_program -database-password=1234 # for flags

To load configurations, just instantiate an object from your struct and pass its pointer to Load function, checking for errors afterward, just like in the example above, or you can pass one or more paths to dot env files

For more examples check unit tests file

openvvar's People

Contributors

fogodev avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.