yini-parser 1.0.0-alpha.7 → 1.0.0-beta.1

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-output.js

@@ -0,0 +1,18 @@
+// Parsed output in config from examples/nested.yini using YINI.parseFile(...)
+
+config = {
+    App: {
+        name: 'Nested Demo App',
+        version: '1.2.3',
+        Theme: {
+            primaryColor: 3368601,
+            darkMode: true,
+            Overrides: { darkMode: false, fontSize: 14 },
+        },
+    },
+    Database: {
+        host: 'db.local',
+        port: 5432,
+        Credentials: { password: 'secret' },
+    },
+}

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.7",
+    "version": "1.0.0-beta.1",
     "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",