Comment storage and formatting options

.gitignore

@@ -4,5 +4,6 @@ gradle
 gradlew
 gradle.bat
 build/
+out/
 hjson.iml
 .idea

README.md

@@ -1,5 +1,11 @@
-# hjson-java
+# PersonTheCat/hjson-java
+
+## Notice of deprecation
 
+This repository is being replaced with a new ecosystem: [XJS](https://github.com/exjson). The new ecosystem will primarily focus on its own syntax and data storage format, but will provide compatibility with Hjson, YAML, JSON-C, and other formats through `xjs-compat`. It is also built from the ground up to support streams, type coercion, and provides a number of other utilities which I believe will make for an extremely convenient experience. If your code is based on this fork of Hjson, I recommend migrating as soon as possible. 
+
+# hjson-java
+
 [![Build Status](https://img.shields.io/travis/hjson/hjson-java.svg?style=flat-square)](http://travis-ci.org/hjson/hjson-java)
 [![Maven Central](https://img.shields.io/maven-central/v/org.hjson/hjson.svg?style=flat-square)](http://search.maven.org/#search|ga|1|g%3A%22org.hjson%22%20a%3A%22hjson%22)
 [![Javadoc](https://javadoc-emblem.rhcloud.com/doc/org.hjson/hjson/badge.svg?style=flat-square&color=blue)](http://www.javadoc.io/doc/org.hjson/hjson)

assets/comments1_result.hjson

@@ -0,0 +1,74 @@
+# Headers placed in this location will now be
+# correctly saved by hjson-java!
+{
+  # Comments can be placed above values.
+  numPenguins: 417 # And beside values.
+  // Multiple comment styles are supported.
+  anotherNum: 24
+  randString: "info" # Even with quotes and commas.
+  /*
+   There's a lot of info here.
+   Here's another line.
+   And another line.
+  */
+  complicatedObject:
+  {
+    apples: 12
+    bananas: 14
+    /*
+     a fancy
+       interior comment
+         for you
+    */
+  }
+  # Objects and arrays placed on a single line are
+  # considered "condensed" and will remain that way.
+  arrayOfNums: [ 1, 2, 3, 4, 5 ]
+  # Objects and arrays with multiple values per-
+  # line will continue to have multiple values
+  # per-line, based on the average line length.
+  multiLine:
+  [
+    1, 2, 3
+    4, 5, 6
+  ]
+  # These should get averaged to 2.
+  averageLines:
+  [
+    1, 2
+    3, 4
+    5, 6
+  ]
+  # This works especially well for multi-dimensional
+  # arrays (i.e. matrices).
+  matrix:
+  [
+    [ 1, 2, 3 ]
+    [ 4, 5, 6 ]
+    [ 7, 8, 9 ]
+    /*
+     Another comment
+       goes here
+    */
+  ]
+  # Objects will do the same. Keys and values will
+  # be correctly quoted, when necessary.
+  multiLineObj:
+  {
+    value1: 1, value2: 2
+    value3: "three", value4: 4
+  }
+  # Unnecessary quotes will be removed.
+  unnecessaryQuotes:
+  {
+    numPenguins: 36
+    numPolarBears: twenty-four
+  }
+  # Just to verify that these still work.
+  multiLineString: 
+    '''
+    test
+    and more test
+    and still more
+    '''
+}

assets/comments1_result.json

@@ -0,0 +1,67 @@
+{
+  "numPenguins": 417,
+  "anotherNum": 24,
+  "randString": "info",
+  "complicatedObject":
+  {
+    "apples": 12,
+    "bananas": 14
+  },
+  "arrayOfNums":
+  [
+    1,
+    2,
+    3,
+    4,
+    5
+  ],
+  "multiLine":
+  [
+    1,
+    2,
+    3,
+    4,
+    5,
+    6
+  ],
+  "averageLines":
+  [
+    1,
+    2,
+    3,
+    4,
+    5,
+    6
+  ],
+  "matrix":
+  [
+    [
+      1,
+      2,
+      3
+    ],
+    [
+      4,
+      5,
+      6
+    ],
+    [
+      7,
+      8,
+      9
+    ]
+  ],
+  "multiLineObj":
+  {
+    "value1": 1,
+    "value2": 2,
+    "value3": "three",
+    "value4": 4
+  },
+  "unnecessaryQuotes":
+  {
+    "numPenguins": 36,
+    "numPolarBears": "twenty-four"
+  },
+  "multiLineString": "test\nand more test\nand still more"
+}

assets/comments1_test.hjson

@@ -0,0 +1,74 @@
+# Headers placed in this location will now be
+# correctly saved by hjson-java!
+{
+  # Comments can be placed above values.
+  numPenguins: 417 # And beside values.
+  // Multiple comment styles are supported.
+  anotherNum: 24
+  randString: "info", # Even with quotes and commas.
+  /*
+   There's a lot of info here.
+   Here's another line.
+   And another line.
+  */
+  complicatedObject:
+  {
+    apples: 12
+    bananas: 14
+    /*
+     a fancy
+       interior comment
+         for you
+    */
+  }
+  # Objects and arrays placed on a single line are
+  # considered "condensed" and will remain that way.
+  arrayOfNums: [ 1, 2, 3, 4, 5 ]
+  # Objects and arrays with multiple values per-
+  # line will continue to have multiple values
+  # per-line, based on the average line length.
+  multiLine:
+  [
+    1, 2, 3
+    4, 5, 6
+  ]
+  # These should get averaged to 2.
+  averageLines:
+  [
+    1
+    2, 3
+    4, 5, 6
+  ]
+  # This works especially well for multi-dimensional
+  # arrays (i.e. matrices).
+  matrix:
+  [
+    [ 1, 2, 3 ]
+    [ 4, 5, 6 ]
+    [ 7, 8, 9 ]
+    /*
+     Another comment
+       goes here
+    */
+  ]
+  # Objects will do the same. Keys and values will
+  # be correctly quoted, when necessary.
+  multiLineObj:
+  {
+    value1: 1, value2: 2
+    value3: "three", value4: 4
+  }
+  # Unnecessary quotes will be removed.
+  unnecessaryQuotes:
+  {
+    "numPenguins": 36,
+    "numPolarBears": "twenty-four"
+  }
+  # Just to verify that these still work.
+  multiLineString: 
+    '''
+    test
+    and more test
+    and still more
+    '''
+}

assets/legacy_result.hjson

@@ -0,0 +1,9 @@
+{
+  num: 55
+  dec: 55.5
+  obj:
+  {
+    value: 55
+  }
+  array: [ 55 ]
+}

assets/legacy_result.json

@@ -0,0 +1,12 @@
+{
+  "num": 55,
+  "dec": 55.5,
+  "obj":
+  {
+    "value": 55
+  },
+  "array":
+  [
+    55
+  ]
+}

assets/legacy_test.hjson

@@ -0,0 +1,7 @@
+num: 55
+dec: 55.5
+obj:
+{
+  value: 55
+}
+array: [ 55 ]

assets/mltabs_result.hjson

@@ -1,5 +1,5 @@
 {
-  foo:
+  foo: 
     '''
     bar	joe
     oki	doki

assets/pass1_result.hjson

@@ -1,11 +1,6 @@
 [
   JSON Test Pattern pass1
-  {
-    "object with 1 member":
-    [
-      array with 1 element
-    ]
-  }
+  { "object with 1 member": [ "array with 1 element" ] }
   {}
   []
   -42
@@ -42,24 +37,10 @@
     "# -- --> */": " "
     " s p a c e d ":
     [
-      1
-      2
-      3
-      4
-      5
-      6
-      7
-    ]
-    compact:
-    [
-      1
-      2
-      3
-      4
-      5
-      6
-      7
+      1, 2, 3
+      4, 5, 6
     ]
+    compact: [ 1, 2, 3, 4, 5, 6 ]
     jsontext: '''{"object with 1 member":["array with 1 element"]}'''
     quotes: " " %22 0x22 034 "
     "/\\\"쫾몾ꮘﳞ볚\b\f\n\r\t`1~!@#$%^&*()_+-=[]{}|;:',./<>?": A key can be any string

assets/pass1_result.json

@@ -45,17 +45,15 @@
       3,
       4,
       5,
-      6,
-      7
+      6
     ],
     "compact": [
       1,
       2,
       3,
       4,
       5,
-      6,
-      7
+      6
     ],
     "jsontext": "{\"object with 1 member\":[\"array with 1 element\"]}",
     "quotes": "" \" %22 0x22 034 "",

assets/pass1_test.json

@@ -37,9 +37,9 @@
         "# -- --> */": " ",
         " s p a c e d " :[1,2 , 3
 
-,
+    ,
 
-4 , 5        ,          6           ,7        ],"compact":[1,2,3,4,5,6,7],
+4 , 5        ,          6           ,],"compact":[1,2,3,4,5,6],
         "jsontext": "{\"object with 1 member\":[\"array with 1 element\"]}",
         "quotes": "" \u0022 %22 0x22 034 "",
         "\/\\\"\uCAFE\uBABE\uAB98\uFCDE\ubcda\uef4A\b\f\n\r\t`1~!@#$%^&*()_+-=[]{}|;:',./<>?"

assets/pass2_result.hjson

@@ -1,39 +1 @@
-[
-  [
-    [
-      [
-        [
-          [
-            [
-              [
-                [
-                  [
-                    [
-                      [
-                        [
-                          [
-                            [
-                              [
-                                [
-                                  [
-                                    [
-                                      Not too deep
-                                    ]
-                                  ]
-                                ]
-                              ]
-                            ]
-                          ]
-                        ]
-                      ]
-                    ]
-                  ]
-                ]
-              ]
-            ]
-          ]
-        ]
-      ]
-    ]
-  ]
-]
+[ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ "Not too deep" ] ] ] ] ] ] ] ] ] ] ] ] ] ] ] ] ] ] ]