up: update some parse logic, add more tests case

README.md

@@ -8,12 +8,12 @@
 
 `properties` - Java Properties format contents parse, marshal and unmarshal library.
 
-- Generic properties contents parser
+- Generic properties contents parser, marshal and unmarshal
 - Support `Marshal` and `Unmarshal` like `json` package
-- Support comments withs `#`, `//`, `/* multi line comments */`
-- Support multi line string value, withs `'''multi line string''''`, `"""multi line string"""`
+- Support comments start withs `!`, `#`, `//`, `/* multi line comments */`
+- Support multi line string value, withs `\\`, `'''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}`
-- Support value refer parse by var. format: `{$key_name}`
 
 > **[中文说明](README.zh-CN.md)**
 

options.go

@@ -2,7 +2,7 @@ package properties
 
 import "github.com/mitchellh/mapstructure"
 
-// DefaultTagName settings
+// DefaultTagName for mapping data to struct.
 var DefaultTagName = "properties"
 
 // OpFunc custom option func
@@ -12,7 +12,7 @@ type OpFunc func(opts *Options)
 type Options struct {
 	// ParseEnv parse ENV var name, default True. eg: "${SHELL}"
 	ParseEnv bool
-	// ParseVar reference. eg: "${other.var.name}"
+	// ParseVar reference. eg: "${other.var.name}". default: true
 	ParseVar bool
 	// ParseTime string on binding struct. eg: 3s -> 3*time.Second
 	ParseTime bool
@@ -26,6 +26,8 @@ type Options struct {
 	//
 	// allow chars: #, //
 	InlineComment bool
+	// InlineSlice support parse the inline slice. eg: [23, 34]. default: false
+	InlineSlice bool
 	// TrimMultiLine trim "\n" for multi line value. default: false
 	TrimMultiLine bool
 	// BeforeCollect value handle func.
@@ -39,9 +41,25 @@ func (opts *Options) shouldAddHookFunc() bool {
 	return false
 }
 
+func (opts *Options) makeDecoderConfig() *mapstructure.DecoderConfig {
+	decConf := opts.MapStructConfig
+	// compatible with settings on opts.TagName
+	if decConf.TagName == "" {
+		decConf.TagName = opts.TagName
+	}
+
+	// add hook on decode value to struct
+	if opts.shouldAddHookFunc() {
+		decConf.DecodeHook = ValDecodeHookFunc(opts.ParseEnv, opts.ParseTime)
+	}
+
+	return &decConf
+}
+
 func newDefaultOption() *Options {
 	return &Options{
-		TagName: DefaultTagName,
+		ParseVar: true,
+		TagName:  DefaultTagName,
 		// map struct config
 		MapStructConfig: mapstructure.DecoderConfig{
 			TagName: DefaultTagName,

parser.go

@@ -304,6 +304,8 @@ func (p *Parser) setValue(key, value, comments string) {
 	// set value by keys
 	if len(keys) == 1 {
 		p.Data[key] = value
+	} else if len(p.Data) == 0 {
+		p.Data = maputil.MakeByKeys(keys, value)
 	} else {
 		err := p.Data.SetByKeys(keys, value)
 		// err := maputil.SetByKeys((*map[string]any)(&p.Data), keys, value)
@@ -353,20 +355,10 @@ func (p *Parser) MapStruct(key string, ptr interface{}) error {
 		}
 	}
 
-	bindConf := p.opts.MapStructConfig
-	// compatible with settings on opts.TagName
-	if bindConf.TagName == "" {
-		bindConf.TagName = p.opts.TagName
-	}
-
-	// add hook on decode value to struct
-	if p.opts.shouldAddHookFunc() {
-		bindConf.DecodeHook = ValDecodeHookFunc(p.opts.ParseEnv, p.opts.ParseTime)
-	}
-
-	bindConf.Result = ptr // set result struct ptr
-	decoder, err := mapstructure.NewDecoder(&bindConf)
+	decConf := p.opts.makeDecoderConfig()
+	decConf.Result = ptr // set result ptr
 
+	decoder, err := mapstructure.NewDecoder(decConf)
 	if err == nil {
 		err = decoder.Decode(data)
 	}

parser_test.go

@@ -11,6 +11,9 @@ import (
 
 func TestParser_Parse(t *testing.T) {
 	text := `
+name = inhere
+age = 345
+
  ##### comments1
 top.sub.key0 = a string value
 top.sub.key1 = "a string value"
@@ -20,35 +23,45 @@ top.sub.key2 = 234
 # inline list
 top2.inline.list.ids = [234, 345, 456]
 
+# use var refer
+top2.sub.var-refer = ${top.sub.key0}
+
 /*
 multi line
 comments
 */
-top.sub.key2-other = has-char
+top2.sub.key2-other = has-char
 
 # comments 2
 top.sub.key3 = false
-top.sub.key4[0] = abc # comments at end1
-top.sub.key4[1] = def // comments at end2
+
+# 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
-invalid line
+
 top.sub2.mline1 = """multi line
 value
 """
+
+top.sub2.mline2 = this is\
+multi line2\
+value
 `
 
 	p := properties.NewParser()
 	err := p.Parse(text)
 	assert.NoErr(t, err)
+	fmt.Println("\ndata map:")
 	dump.NoLoc(p.Data)
 
-	fmt.Println("string map:")
+	fmt.Println("\nstring map:")
 	dump.NoLoc(p.SMap())
 
-	fmt.Println("comments:")
+	fmt.Println("\ncomments:")
 	dump.NoLoc(p.Comments())
 }
 

testdata/simple.properties → testdata/example.properties

@@ -2,10 +2,30 @@
 app.id=9527
 app.name=myapp
 app.some-string = a long string value
+app.var-refer = ${app.name}
+app.multi-line.string = a long \
+  and \
+  multi line\
+  string value
+
+top.sub2.mline1 = """multi line
+value
+"""
 
 # inline list
 server.user.ids = [34, 45]
 
+# multi line list
+server.rpc.ips[0] = 127.0.0.1
+server.rpc.ips[1] = 127.0.0.1
+
+# slice list
+top.sub.key4[0] = abc
+top.sub.key4[1] = def
+
+top.sub.key5[0].f1 = ab
+top.sub.key5[1].f2 = de
+
 spring.datasource.dynamic.strict=true
 
 # Redis settings
@@ -16,8 +36,3 @@ spring.redis.port=6379
 spring.redis.timeout=2000
 spring.redis.lettuce.pool.max-wait=-1
 spring.redis.lettuce.pool.min-idle=0
-
-
-# multi line list
-server.rpc.ips[0] = 127.0.0.1
-server.rpc.ips[1] = 127.0.0.1

util.go

@@ -10,7 +10,8 @@ import (
 	"github.com/mitchellh/mapstructure"
 )
 
-var refRegex = regexp.MustCompile(`^[a-z][a-z\d.]+`)
+// eg: ${some.other.key} -> some.other.key
+var refRegex = regexp.MustCompile(`^[a-z][a-z\d.]+$`)
 
 func parseVarRefName(val string) (string, bool) {
 	if !strings.HasPrefix(val, VarRefStartChars) || !strings.HasSuffix(val, "}") {