senselogic-gson 0.1.4 → 0.1.6

package/README.md

@@ -10,8 +10,7 @@ Granular Structured Object Notation.
 *   File inclusions
 *   UUID and TUID generation
 *   Customizable commands
-*   Ultra fast parsing
-*   Based on obscure characters
+*   Ultra fast parsing based on obscure Unicode characters
 
 ## Sample
 
@@ -52,7 +51,7 @@ Granular Structured Object Notation.
                 "age":
                     38
             }
-        ],
+        },
     "personByIdMap":
         {
             "mike":
@@ -76,7 +75,7 @@ Granular Structured Object Notation.
                     "age":
                         38
                 }
-        },
+        ],
     "escaped":
         "\u2034",
     "uuid":
@@ -88,10 +87,26 @@ Granular Structured Object Notation.
 }
 ```
 
+## Syntax
+
+Multiline strings are enclosed between `‴` characters, and use the `‗` character to represent a non-trimmable space:
+```
+‴first line
+second line
+third line ‗
+‗ fourth line
+fifth line‴
+```
+
+Command strings are also enclosed between `‴` characters, but start with a `‼` character:
+* `‴‼#id‴` generates an MD5-based UUID.
+* `‴‼%id‴` generates an MD5-based TUID.
+* `‴‼@path/to/file.gson‴` includes the contents of another GSON file.
+
 ## Limitations
 
-*   `‴` must be escaped in string literals.
-*   `‼` and `‗` can't be used in string literals.
+*   The `‴` character must be escaped in string literals.
+*   The `‼` and `‗` characters can't be used in multiline string literals.
 
 ## Version
 

package/building.js

@@ -19,25 +19,27 @@ export function getIndentationText(
 // ~~
 
 function getEscapedLine(
-    text
+    line,
+    primedTextIsEscaped = true
     )
 {
-    return (
-        text
-            .replaceAll( '\\', '\\\\' )
-            .replaceAll( '\b', '\\b' )
-            .replaceAll( '\f', '\\f' )
-            .replaceAll( '\r', '' )
-            .replaceAll( '\t', '\\t' )
-            .replaceAll( /[-\u001F]/g, character => `\\u${ character.charCodeAt( 0 ).toString( 16 ).padStart( 4, '0' ) }` )
-            .replaceAll( '‴', '\\u2034' )
-        );
+    let escapedLine = JSON.stringify( line ).slice( 1, -1 ).replaceAll( '‴', '\\u2034' );
+
+    if ( primedTextIsEscaped )
+    {
+        return escapedLine.replaceAll( '‼', '\\u203C' ).replaceAll( '‗', '\\u2017' );
+    }
+    else
+    {
+        return escapedLine;
+    }
 }
 
 // ~~
 
 function getMultilineString(
     value,
+    primedTextIsEscaped = true,
     indentationText
     )
 {
@@ -84,7 +86,7 @@ function getMultilineString(
             lineSuffix = '';
         }
 
-        let multilineStringLine = linePrefix + getEscapedLine( lineContent ) + lineSuffix;
+        let multilineStringLine = linePrefix + getEscapedLine( lineContent, primedTextIsEscaped ) + lineSuffix;
 
         if ( lineIndex === lineCount - 1 )
         {
@@ -108,6 +110,8 @@ function getMultilineString(
 
 function buildGsonString(
     value,
+    primedTextIsGenerated = true,
+    primedTextIsEscaped = true,
     context,
     level,
     lineSuffix = ''
@@ -115,17 +119,18 @@ function buildGsonString(
 {
     let indentationText  = getIndentationText( level * context.levelSpaceCount );
 
-    if ( value.startsWith( '‼' )
-         || value.includes( '\n' ) )
+    if ( primedTextIsGenerated
+         && ( value.startsWith( '‼' )
+              || value.includes( '\n' ) ) )
     {
         if ( value.startsWith( '‼' ) )
         {
-            let text = '‴' + getEscapedLine( value ) + '‴' + lineSuffix;
+            let text = '‴' + getEscapedLine( value, primedTextIsEscaped ) + '‴' + lineSuffix;
             context.lineArray.push( indentationText  + text );
         }
         else
         {
-            let multilineString = getMultilineString( value, indentationText  );
+            let multilineString = getMultilineString( value, primedTextIsEscaped, indentationText );
             let lineArray = multilineString.split( '\n' );
             let lastIndex = lineArray.length - 1;
 
@@ -147,7 +152,8 @@ function buildGsonString(
     }
     else
     {
-        let text = JSON.stringify( value ) + lineSuffix;
+        let text = '"' + getEscapedLine( value, primedTextIsEscaped ) + '"' + lineSuffix;
+
         context.lineArray.push( indentationText  + text );
     }
 }
@@ -156,6 +162,8 @@ function buildGsonString(
 
 function buildGsonValue(
     value,
+    primedTextIsGenerated = true,
+    primedTextIsEscaped = true,
     context,
     level
     )
@@ -164,7 +172,7 @@ function buildGsonValue(
 
     if ( typeof value === 'string' )
     {
-        buildGsonString( value, context, level, '' );
+        buildGsonString( value, primedTextIsGenerated, primedTextIsEscaped, context, level, '' );
     }
     else if ( Array.isArray( value ) )
     {
@@ -181,6 +189,8 @@ function buildGsonValue(
 
             buildGsonValue(
                 element,
+                primedTextIsGenerated,
+                primedTextIsEscaped,
                 context,
                 level + 1
                 );
@@ -215,6 +225,8 @@ function buildGsonValue(
 
             buildGsonValue(
                 value[ key ],
+                primedTextIsGenerated,
+                primedTextIsEscaped,
                 context,
                 valueIndentLevel
                 );
@@ -238,9 +250,9 @@ function buildGsonValue(
 
 export function buildGsonText(
     value,
-    {
-        indentationSpaceCount = 4
-    } = {}
+    primedTextIsGenerated = true,
+    primedTextIsEscaped = true,
+    indentationSpaceCount = 4
     )
 {
     let context =
@@ -251,6 +263,8 @@ export function buildGsonText(
 
     buildGsonValue(
         value,
+        primedTextIsGenerated,
+        primedTextIsEscaped,
         context,
         0
         );

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "senselogic-gson",
     "description": "Granular Structured Object Notation.",
-    "version": "0.1.4",
+    "version": "0.1.6",
     "author": "Eric Pelzer <ecstatic.coder@gmail.com>",
     "license": "LGPL-3.0-only",
     "repository": {

package/test.js

@@ -19,9 +19,13 @@ jsonText = readGsonFileText( '../../../DATA/test.gson', false );
 console.log( jsonText );
 writeFileText( 'OUT/unprocessed_test.json', jsonText );
 
+gsonText = buildGsonText( jsonValue, false );
+console.log( gsonText );
+writeFileText( 'OUT/unprocessed_test.gson', gsonText, 4 );
+
 jsonValue = readGsonFileValue( '../../../DATA/test.gson', false );
 console.log( JSON.stringify( jsonValue ) );
 
-gsonText = buildGsonText( jsonValue );
+gsonText = buildGsonText( jsonValue, true, false );
 console.log( gsonText );
 writeFileText( 'OUT/unprocessed_test.gson', gsonText, 4 );