yini-parser 1.0.0-alpha.6 → 1.0.0-alpha.7x

package/dist/grammar/YiniParserVisitor.d.ts

@@ -18,6 +18,8 @@ import { Null_literalContext } from "./YiniParser.js";
 import { String_literalContext } from "./YiniParser.js";
 import { String_concatContext } from "./YiniParser.js";
 import { Boolean_literalContext } from "./YiniParser.js";
+import { Empty_objectContext } from "./YiniParser.js";
+import { Empty_listContext } from "./YiniParser.js";
 /**
  * This interface defines a complete generic visitor for a parse tree produced
  * by `YiniParser`.
@@ -140,4 +142,16 @@ export default class YiniParserVisitor<Result> extends ParseTreeVisitor<Result>
      * @return the visitor result
      */
     visitBoolean_literal?: (ctx: Boolean_literalContext) => Result;
+    /**
+     * Visit a parse tree produced by `YiniParser.empty_object`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitEmpty_object?: (ctx: Empty_objectContext) => Result;
+    /**
+     * Visit a parse tree produced by `YiniParser.empty_list`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitEmpty_list?: (ctx: Empty_listContext) => Result;
 }

package/dist/index.d.ts

@@ -1 +1,4 @@
-export { default } from './YINI';
+import YINI from './YINI';
+export declare const parse: (yiniContent: string, strictMode?: boolean, bailSensitivity?: "auto" | 0 | 1 | 2, includeMetaData?: boolean) => import("./core/types").TJSObject;
+export declare const parseFile: (filePath: string, strictMode?: boolean, bailSensitivity?: "auto" | 0 | 1 | 2, includeMetaData?: boolean) => import("./core/types").TJSObject;
+export default YINI;

package/dist/index.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
+exports.parseFile = exports.parse = void 0;
 /*
     https://pauloe-me.medium.com/typescript-npm-package-publishing-a-beginners-guide-40b95908e69c
     
@@ -19,8 +19,10 @@ exports.default = void 0;
 const env_1 = require("./config/env");
 const system_1 = require("./utils/system");
 const YINI_1 = __importDefault(require("./YINI"));
-var YINI_2 = require("./YINI");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(YINI_2).default; } });
+// export { default } from './YINI'
+exports.parse = YINI_1.default.parse;
+exports.parseFile = YINI_1.default.parseFile;
+exports.default = YINI_1.default;
 (0, system_1.debugPrint)();
 (0, system_1.debugPrint)('-> Entered index.ts');
 (0, system_1.debugPrint)();
@@ -173,18 +175,35 @@ Expected JS output:
         //     id = 32403  # The correct app id.
         //     title = "My Program"
         // `
-        const validYini = `
-        ^ Root
-        value = 'At level 1'
-            ^^ Sub
-            value = 'At level 2'
-                ^^^ SubSub
-                value = 'At level 3'
-                
-        ^ BackToRoot
-        value = 'Bach at level 1'
-        `;
-        YINI_1.default.parse(validYini, true);
+        const yini = `
+/*
+    nested.yini
+    Demonstrates nested sections in YINI format.
+*/
+
+@yini
+
+^ App                  // Top-level section: App
+name = 'Nested Demo App'
+version = "1.2.3"
+
+    ^^ Theme           // Nested under App: App.Theme
+    primaryColor = #336699
+    darkMode = true
+
+
+        ^^^ Overrides  // Nested under Theme: App.Theme.Overrides
+        darkMode = false
+        fontSize = 14
+
+^ Database             // Another top-level section: Database
+host = "db.local"
+port = 5432
+
+    ^^ Credentials     // Nested under Database: Database.Credentials    username = "admin"
+    password = "secret"
+            `;
+        YINI_1.default.parse(yini);
         //         YINI.parse(`
         // ^ Section1
         //             ^^ Section2

package/dist/parsers/extractSignificantYiniLine.js

@@ -55,6 +55,8 @@ const extractYiniLine = (rawYiniContent) => {
             break;
         default:
             (0, system_1.debugPrint)('(!) Did find several significant lines in rawYiniContent! - Maybe internal error...');
+            (0, system_1.debugPrint)('significantLines[0] = >>>' + significantLines[0] + '<<<');
+            (0, system_1.debugPrint)('significantLines[1] = >>>' + significantLines[1] + '<<<');
         // throw new Error(
         //     'Internal error: Detected several row lines in rawYiniContent: >>>' +
         //         rawYiniContent +

package/examples/basic-with-comments.yini

@@ -0,0 +1,15 @@
+/*
+    basic-explained.yini
+*/
+
+@yini  // Optional marker indicating this is a YINI config file.
+
+^ App  // Section header: defines the "App" section.
+title = 'My App'     // A string (single-quoted or double-quoted are both supported).
+items = 10           // A number value.
+debug = ON           // Boolean true (ON/OFF are case-insensitive aliases for true/false).
+
+^ Server  // Another top-level section.
+host = "localhost"   // A string using double quotes.
+port = 8080          // A number value.
+useTLS = OFF         // Boolean false.

package/examples/basic.yini

@@ -0,0 +1,11 @@
+@yini
+
+^ App
+title = 'My App'
+items = 10
+debug = ON
+
+^ Server
+host = "localhost"
+port = 8080
+useTLS = OFF

package/examples/compare-formats.md

@@ -0,0 +1,89 @@
+# YINI vs JSON, YAML, INI, and TOML
+
+This document shows how the same configuration would look in different formats.
+
+It highlights YINI's goal: *clean, human-friendly config syntax* - with full support for nesting, comments, and typed values - while remaining simpler than YAML or JSON.
+
+---
+
+## 🔵 YINI
+
+This example shows how YINI compares to other formats for common configuration needs.
+
+```yini
+@yini
+
+^ App
+name = 'Demo App'
+items = 25
+darkMode = true
+
+    ^^ Special
+    color = #336699
+    isCaching = false
+```
+
+## 🟠 JSON
+
+```json
+{
+  "App": {
+    "name": "Demo App",
+    "items": 25,
+    "darkMode": true,
+    "Special": {
+      "color": 3368601,
+      "isCaching": false
+    }
+  }
+}
+```
+
+## 🟡 YAML
+
+```yaml
+App:
+  name: "Demo App"
+  items: 25
+  darkMode: true
+  Special:
+    color: 0x336699
+    isCaching: false
+```
+
+## 🟢 INI
+
+```ini
+[App]
+name = Demo App
+items = 25
+darkMode = true
+
+[App.Special]
+color = 3368601
+isCaching = false
+```
+
+## 🔴 TOML
+
+```toml
+[App]
+name = "Demo App"
+items = 25
+darkMode = true
+
+[App.Special]
+color = 0x336699
+isCaching = false
+```
+
+## ✅ Summary
+
+| Feature            | **YINI**      | **JSON**    | **YAML**   | **INI**     | **TOML** |
+|--------------------|---------------|-------------|------------|-------------|----------|
+| Comments           | ✅ Yes        | ❌ No      | ✅ Yes     | ✅ Yes     | ✅ Yes |
+| Nesting            | ✅ Clean      | ✅ Manual  | ✅ Native  | ⚠️ Limited | ✅ Native |
+| Data Types         | ✅ Rich       | ✅ Rich    | ✅ Rich    | ⚠️ Limited | ✅ Rich |
+| Syntax Noise       | 🚫 Minimal    | 🔺 High    | ⚠️ Medium  | ✅ Minimal | ⚠️ Medium |
+| Human-Writable     | ✅ Yes        | ❌ Verbose | ✅ Yes     | ✅ Yes     | ✅ Yes |
+| Designed for Config| ✅ Purposeful | ❌ General | ✅ Yes     | ✅ Yes     | ✅ Yes |

package/examples/nested.yini

@@ -0,0 +1,26 @@
+/*
+    nested.yini
+    Demonstrates nested sections in YINI format.
+*/
+
+@yini
+
+^ App                  // Top-level section: App
+name = 'Nested Demo App'
+version = "1.2.3"
+
+    ^^ Theme           // Nested under App: App.Theme
+    primaryColor = #336699
+    darkMode = true
+
+
+        ^^^ Overrides  // Nested under Theme: App.Theme.Overrides
+        darkMode = false
+        fontSize = 14
+
+^ Database             // Another top-level section: Database
+host = "db.local"
+port = 5432
+
+    ^^ Credentials     // Nested under Database: Database.Credentials    username = "admin"
+    password = "secret"

package/examples/parse-example.ts

@@ -0,0 +1,22 @@
+/**
+ * parse-example.ts
+ *
+ * Demonstrates reading and parsing a YINI configuration file.
+ */
+
+import path from 'path'
+import YINI from 'yini-parser'
+
+// Resolve path to the example config file.
+const configPath = path.resolve(__dirname, './basic.yini')
+
+// Parse the YINI config file.
+const config = YINI.parseFile(configPath)
+
+// Output some example values.
+console.log('App Title:', config.App.title)
+console.log('Items:', config.App.items)
+console.log('Dark Theme Enabled:', config.App.isDarkTheme)
+
+console.log('\nFull Config:')
+console.dir(config, { depth: null })

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "yini-parser",
-    "version": "1.0.0-alpha.6",
+    "version": "1.0.0-alpha.7x",
     "description": "Simple and flexible config parser for Node.js. YINI: an enhanced, readable alternative to JSON, INI, and YAML—built for modern JavaScript and TypeScript projects.",
     "keywords": [
         "yini",
@@ -26,7 +26,8 @@
         "package.json",
         "README.md",
         "LICENSE",
-        "CHANGELOG.md"
+        "CHANGELOG.md",
+        "examples/"
     ],
     "main": "dist/index.js",
     "types": "dist/index.d.ts",