Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gookit/properties
📝 Java Properties format contents parse, marshal and unmarshal library. Java Properties 格式内容的解析器，编码解码库
https://github.com/gookit/properties
config golang java-properties properties properties-parser text-parser
Last synced: about 1 month ago
JSON representation
📝 Java Properties format contents parse, marshal and unmarshal library. Java Properties 格式内容的解析器，编码解码库
- Host: GitHub
- URL: https://github.com/gookit/properties
- Owner: gookit
- License: mit
- Created: 2022-07-20T12:20:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T08:24:04.000Z (about 1 month ago)
- Last Synced: 2024-11-11T09:26:23.961Z (about 1 month ago)
- Topics: config, golang, java-properties, properties, properties-parser, text-parser
- Language: Go
- Homepage:
- Size: 107 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Properties
[](https://github.com/gookit/properties/actions/workflows/go.yml)
[](https://github.com/gookit/properties)
[](https://goreportcard.com/report/github.com/gookit/properties)
[](https://pkg.go.dev/github.com/gookit/properties)
[](https://coveralls.io/github/gookit/properties?branch=master)
`properties` - Java Properties format contents parse, marshal and unmarshal library.
- Generic properties contents parser, marshal and unmarshal
- Support `Marshal` and `Unmarshal` like `json` package
- Support line comments start with `!`, `#`
- enhanced: allow `//`, `/* multi line comments */`
- Support multi line string value, end with `\\`
- enhanced: allow `'''multi line string''''`, `"""multi line string"""`
- Support value refer parse by var. format: `${some.other.key}`
- Support ENV var parse. format: `${APP_ENV}`, `${APP_ENV | default}`
> **[中文说明](README.zh-CN.md)**
## Install
```shell
go get github.com/gookit/properties
```
## Usage
Example `properties` contents:
```properties
name = inhere
age = 345
only-key =
env-key = ${SHELL | bash}
##### comments1
top.sub.key0 = a string value
top.sub.key1 = "a quote value1"
top.sub.key2 = 'a quote value2'
/* comments 1.1 */
top.sub.key3 = 234
! inline list
top2.inline.list.ids = [234, 345, 456]
# use var refer
top2.sub.var-refer = ${top.sub.key0}
/*
multi line
comments
*/
top2.sub.key2-other = has-char
# comments 2
top.sub.key3 = false
# slice list
top.sub.key4[0] = abc
top.sub.key4[1] = def
## --- comments 3 ---
top.sub.key5[0].f1 = ab
top.sub.key5[1].f2 = de
# multi line value
top.sub2.mline1 = """multi line
value
"""
# multi line value2
top.sub2.mline2 = this is \
multi line2 \
value
```
## Parse to data
```go
p := properties.NewParser(
properties.ParseEnv,
properties.ParseInlineSlice,
)
p.Parse(text)
fmt.Println("\ndata map:")
dump.NoLoc(p.Data)
```
**Output**:
```shell
maputil.Data { #len=6
"name": string("inhere"), #len=6
"age": string("345"), #len=3
"only-key": string(""), #len=0
"env-key": string("/bin/zsh"), #len=8
"top": map[string]interface {} { #len=2
"sub": map[string]interface {} { #len=6
"key5": []map[string]interface {} [ #len=2
map[string]interface {} { #len=1
"f1": string("ab"), #len=2
},
map[string]interface {} { #len=1
"f2": string("de"), #len=2
},
],
"key0": string("a string value"), #len=14
"key1": string("a quote value1"), #len=14
"key2": string("a quote value2"), #len=14
"key3": string("false"), #len=5
"key4": []string [ #len=2
string("abc"), #len=3
string("def"), #len=3
],
},
"sub2": map[string]interface {} { #len=2
"mline2": string("this is multi line2 value"), #len=25
"mline1": string("multi line
value
"), #len=17
},
},
"top2": map[string]interface {} { #len=2
"sub": map[string]interface {} { #len=2
"var-refer": string("a string value"), #len=14
"key2-other": string("has-char"), #len=8
},
"inline": map[string]interface {} { #len=1
"list": map[string]interface {} { #len=1
"ids": []string [ #len=3
string("234"), #len=3
string("345"), #len=3
string("456"), #len=3
],
},
},
},
},
```
## Parse and binding struct
```go
package main
import (
"fmt"
"github.com/gookit/properties"
)
func Example() {
text := `
# properties string
name = inhere
age = 200
`
p, err := properties.Parse(text)
if err != nil {
panic(err)
}
type MyConf struct {
Name string `properties:"name"`
Age int `properties:"age"`
}
cfg := &MyConf{}
err = p.MapStruct("", cfg)
if err != nil {
panic(err)
}
fmt.Println(*cfg)
// Output:
// {inhere 200}
}
```
## Marshal/Unmarshal
- `Marshal(v any) ([]byte, error)`
- `Unmarshal(v []byte, ptr any) error`
**Example: Unmarshal**:
```go
cfg := &MyConf{}
err := properties.Unmarshal([]byte(text), cfg)
if err != nil {
panic(err)
}
fmt.Println(*cfg)
```
**Example: Marshal**
```go
data := map[string]any{
"name": "inhere",
"age": 234,
"str1": "a string",
"str2": "a multi \nline string",
"top": map[string]any{
"sub0": "val0",
"sub1": []string{"val1-0", "val1-1"},
},
}
bs, err = properties.Marshal(data)
if err != nil {
panic(err)
}
fmt.Println(string(bs))
```
Output:
```properties
str1=a string
str2=a multi \
line string
top.sub1[0]=val1-0
top.sub1[1]=val1-1
top.sub0=val0
name=inhere
age=234
```
## Config management
If you want to support multiple formats and multiple file loading, it is recommended to use [gookit/config](https://github.com/gookit/config)
- Support multi formats: `JSON`(default), `INI`, `Properties`, `YAML`, `TOML`, `HCL`
- Support multi file loading and will auto merge loaded data
## Gookit packages
- [gookit/ini](https://github.com/gookit/ini) INI parse by golang. INI config data management library.
- [gookit/rux](https://github.com/gookit/rux) Simple and fast request router, web framework for golang
- [gookit/gcli](https://github.com/gookit/gcli) build CLI application, tool library, running CLI commands
- [gookit/event](https://github.com/gookit/event) Lightweight event manager and dispatcher implements by Go
- [gookit/cache](https://github.com/gookit/cache) Generic cache use and cache manager for golang. support File, Memory, Redis, Memcached.
- [gookit/config](https://github.com/gookit/config) Go config management. support JSON, YAML, TOML, INI, HCL, ENV and Flags
- [gookit/color](https://github.com/gookit/color) A command-line color library with true color support, universal API methods and Windows support
- [gookit/filter](https://github.com/gookit/filter) Provide filtering, sanitizing, and conversion of golang data
- [gookit/validate](https://github.com/gookit/validate) Use for data validation and filtering. support Map, Struct, Form data
- [gookit/goutil](https://github.com/gookit/goutil) Some utils for the Go: string, array/slice, map, format, cli, env, filesystem, test and more
- More, please see https://github.com/gookit
## See also
- Ini parse [gookit/ini/parser](https://github.com/gookit/ini/tree/master/parser)
- Properties parse [gookit/properties](https://github.com/gookit/properties)
## License
**MIT**