Git Product home page Git Product logo

goconf's Introduction

goconf

GoDoc Build Status Coverage Status Go Report Card

Combine yaml and environment config

Features

Installation

go get gopkg.in/plimble/goconf.v1

Env format

type SampleA struct {
	A               string // PREFIX_A
	CamelCase       bool // PREFIX_CAMELCASE
	ManualOverride1 string `envconfig:"manual_override_1"` // PREFIX_MANUAL_OVERRIDE_1
	SplitWord1      string `split_words:"true"` // SPLIT_WORD1
	ID              string // PREFIX_ID
	DefaultValue    string `envconfig:"DEFAULT_VALUE"` // PREFIX_DEFAULT_VALUE
}

Yaml format

type SampleA struct {
	A               string `json:"abc"` // abc
	CamelCase       bool `yaml:"cc"` // cc
	ManualOverride1 string // manualoverride1
	SplitWord1      string // splitword1
	ID              string // id
	DefaultValue    string // defaultvalue
}

Example

type Sample struct {
  Value string
}

var bytes = `
value: v1
`

sample := &Sample{}
// Parse Order: yaml bytes -> yaml file -> env
err = goconf.Parse(sample,
    WithEnv("prefix"),
    WithYamlFromBytes(bytes),
    WithYaml("path.yml"),
)

Watch Config

goconf.WatchYamlFile("path.yml", sample, func() error {
  fmt.Println("event on chane")
  return nil
})

// or ignore event
goconf.WatchYamlFile("path.yml", sample, nil)

goconf's People

Contributors

witooh avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

onedaycat

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.