INI data parse by golang. INI config data management tool library.
- Easy to use(get:
IntInt64BoolStringStringMap..., set:Set) - Support multi file, data load
- Support data override merge
- Support parse ENV variable
- Complete unit test(coverage > 90%)
- Support variable reference, default compatible with Python's configParser format
%(VAR)s
If you want more support for file content formats, recommended use gookit/config
- gookit/config - Support multi formats:
JSON(default),INI,YAML,TOML,HCL
- example data(
testdata/test.ini):
# comments
name = inhere
age = 50
debug = true
hasQuota1 = 'this is val'
hasQuota2 = "this is val1"
can2arr = val0,val1,val2
shell = ${SHELL}
noEnv = ${NotExist|defValue}
nkey = val in default section
; comments
[sec1]
key = val0
some = value
stuff = things
varRef = %(nkey)spackage main
import (
"github.com/gookit/ini"
)
// go run ./examples/demo.go
func main() {
// config, err := ini.LoadFiles("testdata/tesdt.ini")
// LoadExists will ignore not exists file
err := ini.LoadExists("testdata/test.ini", "not-exist.ini")
if err != nil {
panic(err)
}
// load more, will override prev data by key
err = ini.LoadStrings(`
age = 100
[sec1]
newK = newVal
some = change val
`)
// fmt.Printf("%v\n", config.Data())
}- Get integer
age := config.Int("age")
fmt.Print(age) // 100- Get bool
val := config.Bool("debug")
fmt.Print(val) // true- Get string
name := config.String("name")
fmt.Print(name) // inhere- Get section data(string map)
val := config.StringMap("sec1")
fmt.Println(val)
// map[string]string{"key":"val0", "some":"change val", "stuff":"things", "newK":"newVal"}- Value is ENV var
value := config.String("shell")
fmt.Printf("%q", value) // "/bin/zsh"- Get value by key path
value := config.String("sec1.key")
fmt.Print(value) // val0- Use var refer
value := config.String("sec1.varRef")
fmt.Printf("%q", value) // "val in default section"- Setting new value
// set value
config.Set("name", "new name")
name = config.String("name")
fmt.Printf("%q", value) // "new name"[portal]
url = http://%(host)s:%(port)s/api
host = localhost
port = 8080If variable resolution is enabled，will parse %(host)s and replace it：
cfg := ini.New()
// enable ParseVar
cfg.WithOptions(ini.ParseVar)
fmt.Print(cfg.MustString("portal.url"))
// OUT:
// http://localhost:8080/api type Options struct {
// set to read-only mode. default False
Readonly bool
// parse ENV var name. default True
ParseEnv bool
// parse variable reference "%(varName)s". default False
ParseVar bool
// var left open char. default "%("
VarOpen string
// var right close char. default ")s"
VarClose string
// ignore key name case. default False
IgnoreCase bool
// default section name. default "__default"
DefSection string
// sep char for split key path. default ".", use like "section.subKey"
SectionSep string
}- setting options
cfg := ini.New()
cfg.WithOptions(ini.ParseEnv,ini.ParseVar, func (opts *Options) {
opts.SectionSep = ":"
opts.DefSection = "default"
})- go tests with cover
go test ./... -cover- run lint by GoLint
golint ./...- go-ini/ini ini parser and config manage
- dombenson/go-ini ini parser and config manage
MIT