add options, readme

Author: laktak

README.md

@@ -0,0 +1,114 @@
+# hjson-go
+
+[![Build Status](https://img.shields.io/travis/laktak/hjson-go.svg?style=flat-square)](http://travis-ci.org/laktak/hjson-go)
+[![Releases](https://img.shields.io/github/release/laktak/hjson-go.svg?style=flat-square)](https://github.com/laktak/hjson-go/releases)
+
+![Hjson Intro](http://hjson.org/hjson1.gif)
+
+```
+{
+  # specify rate in requests/second (because comments are helpful!)
+  rate: 1000
+
+  // prefer c-style comments?
+  /* feeling old fashioned? */
+
+  # did you notice that rate doesn't need quotes?
+  hey: look ma, no quotes for strings either!
+
+  # best of all
+  notice: []
+  anything: ?
+
+  # yes, commas are optional!
+}
+```
+
+The Go implementation of Hjson is based on [hjson-js](https://github.com/laktak/hjson-js). For other platforms see [hjson.org](http://hjson.org).
+
+# Install
+
+Make sure you have a working Go environment. See the [install instructions](http://golang.org/doc/install.html).
+
+To install hjson, simply run:
+
+`go get -u github.com/laktak/hjson-go`
+
+## From the Commandline
+
+Install with `go get -u github.com/laktak/hjson-go/hjson-cli`
+
+```
+usage: hjson-cli [OPTIONS] [INPUT]
+hjson can be used to convert JSON from/to Hjson.
+
+hjson will read the given JSON/Hjson input file or read from stdin.
+
+Options:
+  -allowMinusZero
+      Allow -0.
+  -bracesSameLine
+      Print braces on the same line.
+  -c  Output as JSON.
+  -h  Show this screen.
+  -indentBy string
+      The indent string. (default "  ")
+  -j  Output as formatted JSON.
+  -omitRootBraces
+      Omit braces at the root.
+  -quoteAlways
+      Always quote string values.
+```
+
+Sample:
+- run `hjson-cli test.json > test.hjson` to convert to Hjson
+- run `hjson-cli -j test.hjson > test.json` to convert to JSON
+
+# Usage
+
+```go
+
+package main
+
+import (
+  "github.com/laktak/hjson-go"
+  "fmt"
+)
+
+func main() {
+
+    // Now let's look at decoding JSON data into Go
+    // values.
+    sample := []byte(`{"num":6.13,"strs":["a","b"]}`)
+
+    // We need to provide a variable where Hjson
+    // can put the decoded data.
+    var dat map[string]interface{}
+
+    // Decode and a check for errors.
+    if err := hjson.Unmarshal(sample, &dat); err != nil {
+        panic(err)
+    }
+    fmt.Println(dat)
+
+    // In order to use the values in the decoded map,
+    // we'll need to cast them to their appropriate type.
+
+    num := dat["num"].(float64)
+    fmt.Println(num)
+
+    strs := dat["strs"].([]interface{})
+    str1 := strs[0].(string)
+    fmt.Println(str1)
+
+
+    // To encode to Hjson with default options:
+    sampleMap := map[string]int{"apple": 5, "lettuce": 7}
+    hjson, _ := hjson.Marshal(sampleMap)
+    // this is short for:
+    // options := hjson.DefaultOptions()
+    // hjson, _ := hjson.MarshalWithOptions(sampleMap, options)
+    fmt.Println(string(hjson))
+}
+
+```

encode.go

@@ -269,7 +269,7 @@ func (e *hjsonEncoder) str(value reflect.Value, noIndent bool, separator string,
 
 			showBraces := !isRootObject || e.EmitRootBraces
 			indent1 := e.indent
-			e.indent++
+			if showBraces { e.indent++ }
 
 			if (showBraces) {
 				if !noIndent && !e.BracesSameLine {
@@ -285,7 +285,7 @@ func (e *hjsonEncoder) str(value reflect.Value, noIndent bool, separator string,
 
 			// Join all of the member texts together, separated with newlines
 			for i := 0; i < len; i++ {
-				e.writeIndent(e.indent)
+				if i > 0 || showBraces { e.writeIndent(e.indent) }
 				e.WriteString(e.quoteName(keys[i].String()))
 				e.WriteString(":")
 				if err := e.str(value.MapIndex(keys[i]), false, " ", false); err != nil { return err }

hjson-cli/main.go

@@ -24,7 +24,7 @@ func fixJson(data []byte) ([]byte) {
 func main() {
 
 	flag.Usage = func() {
-		fmt.Println("usage: hjson [OPTIONS] [INPUT]")
+		fmt.Println("usage: hjson-cli [OPTIONS] [INPUT]")
 		fmt.Println("hjson can be used to convert JSON from/to Hjson.")
 		fmt.Println("")
 		fmt.Println("hjson will read the given JSON/Hjson input file or read from stdin.")
@@ -36,11 +36,17 @@ func main() {
 	var help = flag.Bool("h", false, "Show this screen.")
 	var showJson = flag.Bool("j", false, "Output as formatted JSON.")
 	var showCompact = flag.Bool("c", false, "Output as JSON.")
+
+	var indentBy = flag.String("indentBy", "  ", "The indent string.")
+	var bracesSameLine = flag.Bool("bracesSameLine", false, "Print braces on the same line.")
+	var omitRootBraces = flag.Bool("omitRootBraces", false, "Omit braces at the root.")
+	var quoteAlways = flag.Bool("quoteAlways", false, "Always quote string values.")
+	var allowMinusZero = flag.Bool("allowMinusZero", false, "Allow -0.")
+
 	// var showVersion = flag.Bool("V", false, "Show version.")
 
 	flag.Parse()
 	if *help || flag.NArg() > 1 {
-		fmt.Println("{}", flag.NArg())
 		flag.Usage()
 		os.Exit(1)
 	}
@@ -66,11 +72,17 @@ func main() {
 		if err != nil { panic(err) }
 		out = fixJson(out)
 	} else if *showJson {
-		out, err = json.MarshalIndent(value, "", "  ")
+		out, err = json.MarshalIndent(value, "", *indentBy)
 		if err != nil { panic(err) }
 		out = fixJson(out)
 	} else {
-		out, err = hjson.Marshal(value)
+		opt := hjson.DefaultOptions()
+		opt.IndentBy = *indentBy
+		opt.BracesSameLine = *bracesSameLine
+		opt.EmitRootBraces = !*omitRootBraces
+		opt.QuoteAlways = *quoteAlways
+		opt.AllowMinusZero = *allowMinusZero
+		out, err = hjson.MarshalWithOptions(value, opt)
 	}
 
 	fmt.Println(string(out))

test/assets/sorted/strings_result.hjson

@@ -69,5 +69,7 @@
   text1: This is a valid string value.
   text2: a \ is just a \
   text3: "You need quotes\tfor escapes"
-  text4: " untrimmed "
+  text4a: " untrimmed "
+  text4b: " untrimmed"
+  text4c: "untrimmed "
 }

test/assets/sorted/strings_result.json

@@ -49,5 +49,7 @@
   "text1": "This is a valid string value.",
   "text2": "a \\ is just a \\",
   "text3": "You need quotes\tfor escapes",
-  "text4": " untrimmed "
+  "text4a": " untrimmed ",
+  "text4b": " untrimmed",
+  "text4c": "untrimmed "
 }

test/assets/strings_result.hjson

@@ -2,7 +2,9 @@
   text1: This is a valid string value.
   text2: a \ is just a \
   text3: "You need quotes\tfor escapes"
-  text4: " untrimmed "
+  text4a: " untrimmed "
+  text4b: " untrimmed"
+  text4c: "untrimmed "
   multiline1:
     '''
     first line

test/assets/strings_result.json

@@ -2,7 +2,9 @@
   "text1": "This is a valid string value.",
   "text2": "a \\ is just a \\",
   "text3": "You need quotes\tfor escapes",
-  "text4": " untrimmed ",
+  "text4a": " untrimmed ",
+  "text4b": " untrimmed",
+  "text4c": "untrimmed ",
   "multiline1": "first line\n  indented line\nlast line",
   "multiline2": "first line\n  indented line\nlast line",
   "multiline3": "first line\n  indented line\nlast line\n",

test/assets/strings_test.hjson

@@ -6,7 +6,9 @@
 
   text3: "You need quotes\tfor escapes"
 
-  text4: " untrimmed "
+  text4a: " untrimmed "
+  text4b: " untrimmed"
+  text4c: "untrimmed "
 
   # multiline string