yini-parser 1.0.0-alpha.4 → 1.0.0-alpha.5

package/README.md

@@ -13,6 +13,13 @@ YINI is a simple, human-friendly configuration format inspired by INI and JSON.
 
 ---
 
+## 💡 Why YINI?
+- Easy to read and write — minimal syntax, maximum clarity.
+- Supports nested sections, strict/lenient modes, and all major data types.
+- A perfect alternative to messy JSON, legacy INI, or complex YAML.
+- Built for both JavaScript and TypeScript.
+- Human-friendly, machine-friendly, and ready for modern projects.
+  
 ## ✨ Features
 - Simple syntax (supports both strict and lenient modes).
 - Familiar config file style (inspired by INI, YAML, TOML).
@@ -47,13 +54,26 @@ pnpm add yini-parser
 
 ## Usage
 
-> Only import the main class:
->
-> ```ts
-> import YINI from 'yini-parser';
-> ```
+### Node.js (CommonJS)
+**Note:** Only a default export (YINI) is provided. Named imports are not supported.
+```js
+const YINI = require('yini-parser');
+// If you get undefined, try:
+const YINI = require('yini-parser').default;
+
+// Parse from string.
+const config = YINI.parse(`
+    ^ App
+    title = 'My App Title'
+    items = 25
+    isDarkTheme = true
+`);
 
-### Example:
+// Parse from file.
+const configFromFile = YINI.parseFile('./config.yini');
+```
+
+### TypeScript (with `"esModuleInterop": true`)
 ```ts
 import YINI from 'yini-parser';
 
@@ -114,6 +134,79 @@ Returns a JavaScript object representing the parsed YINI configuration file.
 }
 ```
 
+---
+---
+
+### Bigger Example
+
+```js
+const YINI = require('yini-parser'); // Or: import YINI from 'yini-parser';
+
+const config = YINI.parse(`
+    /*
+        This is a multi-line block comment.
+    */
+
+    @yini
+
+    ^ App
+    name = "Nested Example"
+    version = "1.0.0"
+    debug = OFF  // This is a comment.
+
+        # Database settings.
+        ^^ Database
+        host = "db.example.com"
+        port = 3306
+        user = "appuser"
+        --password = "dbpassword"  # Disabled line due to --.
+        //password = "dbpassword"  # Not sure yet about this pw.
+        password = "dbpassword"  # Keep this secret.
+
+            // Commenting with slashes works too.
+            ^^^ Pool
+            min = 2
+            max = 10
+            idleTimeout = 300
+
+        /* Block comment on a single line. */
+        ^^ Logging
+        level = "info"
+        logToFile = ON # This is a comment.
+        filePath = "./logs/app.log"
+    
+    /END
+`);
+
+console.log(config);
+```
+
+#### Output:
+```js
+{
+    "App": {
+        "name": "Nested Example",
+        "version": "1.0.0",
+        "debug": false,
+        "Database": {
+            "host": "db.example.com",
+            "port": 3306,
+            "user": "appuser",
+            "password": "dbpassword",
+            "Pool": {
+                "min": 2,
+                "max": 10,
+                "idleTimeout": 300
+            }
+        },
+        "Logging": {
+            "level": "info",
+            "logToFile": true,
+            "filePath": "./logs/app.log"
+        }
+    }
+}
+```
 ---
 
 ## 📚 Documentation

package/dist/utils/system.d.ts

@@ -4,4 +4,5 @@
  */
 export declare const debugPrint: (str?: any) => void;
 export declare const devPrint: (str?: any) => void;
+export declare const toPrettyJSON: (obj: any) => string;
 export declare const printObject: (obj: any) => void;

package/dist/utils/system.js

@@ -4,7 +4,7 @@
  * @note More specific YINI helper functions should go into yiniHelpers.ts-file.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printObject = exports.devPrint = exports.debugPrint = void 0;
+exports.printObject = exports.toPrettyJSON = exports.devPrint = exports.debugPrint = void 0;
 const env_1 = require("../config/env");
 const debugPrint = (str = '') => {
     (0, env_1.isDebug)() && console.debug('DEBUG: ' + str);
@@ -14,10 +14,15 @@ const devPrint = (str = '') => {
     (0, env_1.isDev)() && !(0, env_1.isTestEnv)() && console.log('DEV: ' + str);
 };
 exports.devPrint = devPrint;
+const toPrettyJSON = (obj) => {
+    const str = JSON.stringify(obj, null, 4);
+    return str;
+};
+exports.toPrettyJSON = toPrettyJSON;
 const printObject = (obj) => {
     if ((0, env_1.isProdEnv)() || ((0, env_1.isTestEnv)() && !(0, env_1.isDebug)()))
         return;
-    const str = JSON.stringify(obj, null, 4);
+    const str = (0, exports.toPrettyJSON)(obj);
     console.log(str);
 };
 exports.printObject = printObject;

package/package.json

@@ -1,16 +1,23 @@
 {
     "name": "yini-parser",
-    "version": "1.0.0-alpha.4",
-    "description": "YINI parser for JavaScript/TypeScript, an INI-inspired configuration format, meant to be readable, and easy to use.",
+    "version": "1.0.0-alpha.5",
+    "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": [
-        "read",
         "yini",
+        "yini-parser",
         "config",
+        "config-file",
+        "configuration",
+        "settings",
         "ini",
+        "ini-parser",
+        "json-alternative",
+        "yaml-alternative",
         "parser",
-        "file",
         "parse",
-        "configuration"
+        "read",
+        "nodejs",
+        "javascript"
     ],
     "homepage": "https://m4se.com/yini-lang.org/",
     "license": "Apache-2.0",
@@ -49,6 +56,7 @@
         "test:smoke:debug": "cross-env npm run test:smoke -- --isDebug=1",
         "test:unit:debug": "cross-env npm run test:unit -- --isDebug=1",
         "test:integr:debug": "cross-env npm run test:integr -- --isDebug=1",
+        "test:esm": "node ./tests/fixtures/test-src-files/esm-smoke.js",
         "ci:test": "cross-env NODE_ENV=test APP_ENV=ci jest --verbose --runInBand",
         "ci:test:smoke": "cross-env NODE_ENV=test APP_ENV=ci jest tests/smoke --verbose --runInBand",
         "tsc": "npx tsc -p ./tsconfig.json",