senselogic-gson 0.1.9 → 0.3.0

package/README.md

@@ -106,6 +106,16 @@ Command strings are also enclosed by `‴` characters, but start with a `‼` ch
 * `‴‼%id‴` generates an MD5-based TUID.
 * `‴‼@path/to/file.gson‴` includes the contents of another GSON file.
 
+## Use Cases
+
+GSON is designed to extend JSON in scenarios where additional flexibility and expressiveness are beneficial.
+
+It is particularly well suited for configuration files where readability matters, especially when working with multiline text.
+
+It also helps organize large configurations or datasets by allowing them to be split into multiple files and included where needed.
+
+Additionally, GSON supports generating consistent identifiers such as UUIDs and TUIDs directly within the data.
+
 ## Limitations
 
 When used as literal text:
@@ -114,7 +124,7 @@ When used as literal text:
 
 ## Version
 
-0.1
+0.2
 
 ## Author
 

package/building.js

@@ -43,7 +43,7 @@ function getMultilineString(
     indentationText
     )
 {
-    let lineArray = value.replaceAll( "\r", "" ).split( "\n" );
+    let lineArray = value.replaceAll( "\r\n", "\n" ).split( "\n" );
     let lineCount = lineArray.length;
     let multilineString = indentationText + "‴";
 

package/fetching.js

@@ -1,3 +1,7 @@
+// -- IMPORTS
+
+import { processPrimedText } from "./processing.js";
+
 // -- FUNCTIONS
 
 export async function fetchFileText(
@@ -25,9 +29,9 @@ async function getUnprimedFetchedText(
          && primedText.startsWith( "‼@" ) )
     {
         let filePath = folderPath + primedText.slice( 2 );
-        let fileText = fetchFileTextFunction( filePath );
+        let fileText = await fetchFileTextFunction( filePath );
 
-        return await getFetchedJsonText( fileText, filePath, primedTextIsProcessed, fetchFileTextFunction, processPrimedTextFunction );
+        return await getFetchedJsonText( fileText, filePath, fetchFileTextFunction, processPrimedTextFunction, primedTextIsProcessed );
     }
     else if ( primedTextIsProcessed
               && processPrimedTextFunction !== null
@@ -89,7 +93,7 @@ export async function fetchGsonFileText(
 {
     let gsonText = await fetchFileTextFunction( filePath );
 
-    return await getFetchedJsonText( gsonText, filePath, primedTextIsProcessed, fetchFileTextFunction, processPrimedTextFunction );
+    return await getFetchedJsonText( gsonText, filePath, fetchFileTextFunction, processPrimedTextFunction, primedTextIsProcessed );
 }
 
 // ~~

package/index.js

@@ -1,12 +1,9 @@
 // -- IMPORTS
 
 import { buildGsonText } from "./building.js";
-import { getDumpText } from "./dumping.js";
 import { haveSameValue } from "./equivalence.js";
 import { fetchFileText, getFetchedJsonText, fetchGsonFileText, fetchGsonFileValue } from "./fetching.js";
-import { readFileText, getReadJsonText, readGsonFileText, readGsonFileValue } from "./reading.js";
 import { getTextHash, getTextUuid, getTextTuid, processPrimedText } from "./processing.js";
-import { writeFileText, writeGsonValue } from "./writing.js";
 
 // -- EXPORTS
 
@@ -14,18 +11,11 @@ export {
     fetchFileText,
     fetchGsonFileText,
     fetchGsonFileValue,
-    getDumpText,
     getFetchedJsonText,
     buildGsonText,
-    getReadJsonText,
     getTextHash,
     getTextTuid,
     getTextUuid,
     haveSameValue,
     processPrimedText,
-    readFileText,
-    readGsonFileText,
-    readGsonFileValue,
-    writeFileText,
-    writeGsonValue
     };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "senselogic-gson",
     "description": "Granular Structured Object Notation.",
-    "version": "0.1.9",
+    "version": "0.3.0",
     "author": "Eric Pelzer <ecstatic.coder@gmail.com>",
     "license": "LGPL-3.0-only",
     "repository": {
@@ -21,9 +21,6 @@
         "index.js",
         "parsing.js",
         "processing.js",
-        "reading.js",
-        "writing.js",
-        "test.js",
         "README.md"
     ],
     "keywords": [

package/reading.js

@@ -1,107 +0,0 @@
-// -- IMPORTS
-
-import { readFileSync } from "node:fs";
-import { processPrimedText } from "./processing.js";
-
-// -- FUNCTIONS
-
-export function readFileText(
-    filePath
-    )
-{
-    return readFileSync( filePath, "utf8" );
-}
-
-// ~~
-
-function getUnprimedReadText(
-    primedText,
-    folderPath,
-    primedTextIsProcessed = true,
-    readFileTextFunction = readFileText,
-    processPrimedTextFunction = processPrimedText
-    )
-{
-    if ( primedTextIsProcessed
-         && readFileTextFunction !== null
-         && primedText.startsWith( "‼@" ) )
-    {
-        let filePath = folderPath + primedText.slice( 2 );
-        let fileText = readFileTextFunction( filePath );
-
-        return getReadJsonText( fileText, filePath, primedTextIsProcessed, readFileTextFunction, processPrimedTextFunction );
-    }
-    else if ( primedTextIsProcessed
-              && processPrimedTextFunction !== null
-              && primedText.startsWith( "‼" ) )
-    {
-        return '"' + processPrimedTextFunction( primedText ) + '"';
-    }
-    else
-    {
-        let lineArray = primedText.split( "\n" );
-
-        for ( let lineIndex = 0;
-              lineIndex < lineArray.length;
-              ++lineIndex )
-        {
-            lineArray[ lineIndex ]
-                = lineArray[ lineIndex ].trim().replaceAll( "‗", " " );
-        }
-
-        return '"' + lineArray.join( "\\n" ) + '"';
-    }
-}
-
-// ~~
-
-export function getReadJsonText(
-    gsonText,
-    filePath,
-    primedTextIsProcessed = true,
-    readFileTextFunction = readFileText,
-    processPrimedTextFunction = processPrimedText
-    )
-{
-    gsonText = gsonText.replaceAll( "\r", "" ).trim();
-    filePath = filePath.replaceAll( "\\", "/" );
-
-    let folderPath = filePath.slice( 0, filePath.lastIndexOf( "/" ) + 1 );
-    let primedTextArray = gsonText.split( "‴" );
-
-    for ( let primedTextIndex = 1;
-          primedTextIndex < primedTextArray.length;
-          primedTextIndex += 2 )
-    {
-        primedTextArray[ primedTextIndex ]
-            = getUnprimedReadText( primedTextArray[ primedTextIndex ], folderPath, primedTextIsProcessed, readFileTextFunction, processPrimedTextFunction );
-    }
-
-    return primedTextArray.join( "" );
-}
-
-// ~~
-
-export function readGsonFileText(
-    filePath,
-    primedTextIsProcessed = true,
-    readFileTextFunction = readFileText,
-    processPrimedTextFunction = processPrimedText
-    )
-{
-    let gsonText = readFileTextFunction( filePath );
-
-    return getReadJsonText( gsonText, filePath, primedTextIsProcessed, readFileTextFunction, processPrimedTextFunction );
-}
-
-// ~~
-
-export function readGsonFileValue(
-    filePath,
-    primedTextIsProcessed = true,
-    readFileTextFunction = readFileText,
-    processPrimedTextFunction = processPrimedText
-    )
-{
-    return JSON.parse( readGsonFileText( filePath, primedTextIsProcessed, readFileTextFunction, processPrimedTextFunction ) );
-}

package/test.js

@@ -1,31 +0,0 @@
-// -- IMPORTS
-
-import { buildGsonText, readGsonFileText, readGsonFileValue, writeFileText } from "./index.js";
-
-// -- STATEMENTS
-
-let jsonText = readGsonFileText( "../../DATA/test.gson" );
-console.log( jsonText );
-writeFileText( "OUT/processed_test.json", jsonText );
-
-let jsonValue = readGsonFileValue( "../../DATA/test.gson" );
-console.log( JSON.stringify( jsonValue ) );
-
-let gsonText = buildGsonText( jsonValue );
-console.log( gsonText );
-writeFileText( "OUT/processed_test.gson", gsonText, 4 );
-
-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, true, false );
-console.log( gsonText );
-writeFileText( "OUT/unprocessed_test.gson", gsonText, 4 );

package/writing.js

@@ -1,24 +0,0 @@
-// -- IMPORTS
-
-import { writeFileSync } from "node:fs";
-import { buildGsonText } from "./building.js";
-
-// -- FUNCTIONS
-
-export function writeFileText(
-    filePath,
-    fileText
-    )
-{
-    writeFileSync( filePath, fileText, "utf8" );
-}
-
-// ~~
-
-export function writeGsonValue(
-    filePath,
-    value
-    )
-{
-    writeFileText( filePath, buildGsonText( value ) );
-}