senselogic-gson 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,12 +6,12 @@ Granular Structured Object Notation.
6
6
 
7
7
  ## Features
8
8
 
9
- * Multiline strings
10
- * File inclusions
11
- * UUID and TUID generation
12
- * Customizable commands
13
- * Ultra fast parsing
14
- * Based on obscure characters
9
+ GSON is a superset of JSON with:
10
+ * Multiline strings.
11
+ * File inclusions.
12
+ * UUID and TUID generation.
13
+ * Customizable commands.
14
+ * Ultra fast parsing based on obscure Unicode characters.
15
15
 
16
16
  ## Sample
17
17
 
@@ -52,7 +52,7 @@ Granular Structured Object Notation.
52
52
  "age":
53
53
  38
54
54
  }
55
- ],
55
+ },
56
56
  "personByIdMap":
57
57
  {
58
58
  "mike":
@@ -76,7 +76,7 @@ Granular Structured Object Notation.
76
76
  "age":
77
77
  38
78
78
  }
79
- },
79
+ ],
80
80
  "escaped":
81
81
  "\u2034",
82
82
  "uuid":
@@ -88,10 +88,29 @@ Granular Structured Object Notation.
88
88
  }
89
89
  ```
90
90
 
91
+ ## Syntax
92
+
93
+ Any JSON file is also a GSON file, since GSON is a superset of JSON.
94
+
95
+ Multiline strings are enclosed by `‴` characters, and use the `‗` character to represent a non-trimmable space:
96
+ ```
97
+ ‴first line
98
+ second line
99
+ third line ‗
100
+ ‗ fourth line
101
+ fifth line‴
102
+ ```
103
+
104
+ Command strings are also enclosed by `‴` characters, but start with a `‼` character:
105
+ * `‴‼#id‴` generates an MD5-based UUID.
106
+ * `‴‼%id‴` generates an MD5-based TUID.
107
+ * `‴‼@path/to/file.gson‴` includes the contents of another GSON file.
108
+
91
109
  ## Limitations
92
110
 
93
- * `‴` must be escaped in string literals.
94
- * `‼` and `‗` can't be used in string literals.
111
+ When used as literal text:
112
+ * The `‴` character must be escaped in string literals.
113
+ * The `‼` and `‗` characters must be escaped in multiline string literals.
95
114
 
96
115
  ## Version
97
116
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "senselogic-gson",
3
3
  "description": "Granular Structured Object Notation.",
4
- "version": "0.1.5",
4
+ "version": "0.1.7",
5
5
  "author": "Eric Pelzer <ecstatic.coder@gmail.com>",
6
6
  "license": "LGPL-3.0-only",
7
7
  "repository": {