# ini

**Repository Path**: gookit/ini

## Basic Information

- **Project Name**: ini
- **Description**: 📝 Go INI config management. support multi file load, data override merge. parse ENV variable, parse variable reference. INI配置读取管理，支持多文件加载，数据覆盖合并, 解析ENV变量, 解析变量引用
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-21
- **Last Updated**: 2022-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# INI

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/gookit/ini?style=flat-square)
[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/gookit/ini)](https://github.com/gookit/ini)
[![GoDoc](https://godoc.org/github.com/gookit/ini?status.svg)](https://godoc.org/github.com/gookit/ini)
[![Build Status](https://travis-ci.org/gookit/ini.svg?branch=master)](https://travis-ci.org/gookit/ini)
[![Coverage Status](https://coveralls.io/repos/github/gookit/ini/badge.svg?branch=master)](https://coveralls.io/github/gookit/ini?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/gookit/ini)](https://goreportcard.com/report/github.com/gookit/ini)

使用INI格式作为配置，配置数据的加载，管理，使用。

> **[EN README](README.md)**

- 使用简单(获取: `Int` `Int64` `Bool` `String` `StringMap` ..., 设置: `Set` )
- 支持多文件，数据加载
- 支持数据覆盖合并
- 支持解析 ENV 变量名
- 支持变量参考，默认兼容Python的configParser格式 `%(VAR)s`
- 完善的单元测试(coverage > 90%)

## 更多格式

如果你想要更多文件内容格式的支持，推荐使用 `gookit/config`

- [gookit/config](https://github.com/gookit/config) - 支持多种格式: `JSON`(default), `INI`, `YAML`, `TOML`, `HCL`

## GoDoc

- [doc on gowalker](https://gowalker.org/github.com/gookit/ini)
- [godoc for github](https://godoc.org/github.com/gookit/ini)

## 安装

```bash
go get github.com/gookit/ini/v2
```

## 快速使用

- 示例数据(`testdata/test.ini`):

```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)s
```

### 载入数据

```go
package main

import (
	"github.com/gookit/ini/v2"
)

// go run ./examples/demo.go
func main() {
	// err := ini.LoadFiles("testdata/tesdt.ini")
	// LoadExists 将忽略不存在的文件
	err := ini.LoadExists("testdata/test.ini", "not-exist.ini")
	if err != nil {
		panic(err)
	}
	
	// 加载更多，相同的键覆盖之前数据
	err = ini.LoadStrings(`
age = 100
[sec1]
newK = newVal
some = change val
`)
	// fmt.Printf("%v\n", ini.Data())
}
```

### 获取数据

- 获取整型

```go
age := ini.Int("age")
fmt.Print(age) // 100
```

- 获取布尔值

```go
val := ini.Bool("debug")
fmt.Print(val) // true
```

- 获取字符串

```go
name := ini.String("name")
fmt.Print(name) // inhere
```

- 获取section数据(string map)

```go
val := ini.StringMap("sec1")
fmt.Println(val) 
// map[string]string{"key":"val0", "some":"change val", "stuff":"things", "newK":"newVal"}
```

- 获取的值是环境变量

```go
value := ini.String("shell")
fmt.Printf("%q", value)  // "/bin/zsh"
```

- 通过key path来直接获取子级值

```go
value := ini.String("sec1.key")
fmt.Print(value) // val0
```

- 支持变量参考

```go
value := ini.String("sec1.varRef")
fmt.Printf("%q", value)  // "val in default section"
```

- 设置新的值

```go
// set value
ini.Set("name", "new name")
name = ini.String("name")
fmt.Printf("%q", value)  // "new name"
```

## 变量参考解析

```ini
[portal] 
url = http://%(host)s:%(port)s/Portal
host = localhost 
port = 8080
```

启用变量解析后，将会解析这里的 `%(host)s` 并替换为相应的变量值 `localhost`：

```go
cfg := ini.New()
// 启用变量解析
cfg.WithOptions(ini.ParseVar)

fmt.Print(cfg.String("portal.url"))
// OUT: 
// http://localhost:8080/Portal 
```

## 可用选项

```go
type Options struct {
	// 设置为只读模式. default False
	Readonly bool
	// 解析 ENV 变量名称. default True
	ParseEnv bool
	// 解析变量引用 "%(varName)s". default False
	ParseVar bool

	// 变量左侧字符. default "%("
	VarOpen string
	// 变量右侧字符. default ")s"
	VarClose string

	// 忽略键名称大小写. default False
	IgnoreCase bool
	// 默认的section名称. default "__default"
	DefSection string
	// 路径分隔符，当通过key获取子级值时. default ".", 例如 "section.subKey"
	SectionSep string
}
```

- 应用选项

```go
cfg := ini.New()
cfg.WithOptions(ini.ParseEnv,ini.ParseVar, func (opts *Options) {
	opts.SectionSep = ":"
	opts.DefSection = "default"
})
```

## 测试

- 测试并输出覆盖率

```bash
go test ./... -cover
```

- 运行 GoLint 检查

```bash
golint ./... 
```

## 参考 

- [go-ini/ini](https://github.com/go-ini/ini) ini parser and config manage
- [dombenson/go-ini](https://github.com/dombenson/go-ini) ini parser and config manage

## License

**MIT**