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

package/CHANGELOG.md

@@ -1,10 +1,12 @@
 # CHANGELOG
 
-## --Upcoming-- -beta
+## 1.0.0-beta.1
 - Package updated to **beta**. The core API is stabilizing, some more advanced features may still change.
+- Bugfix, fixed exports cleanly (so this lib can be imported in CJS and in full ESM).
 - Implemented support for colon lists, both empty and with elements, including nested lists. Also updated to the latest grammar, which fixes handling of empty lists with or without spaces or tabs between the brackets.
 - Optimized the top part of readme for npmjs Short Page.
 - Added a dir `examples/` with a few example Yini files, `compare-formats.md` and TS file.
+- Updated to the latest grammar (logic) to the spec 1.0.0-rc.1.
 
 ## 1.0.0-alpha.7
 - Fixed serious bug that on error did exit process.

package/README.md

@@ -540,6 +540,16 @@ We welcome feedback, bug reports, feature requests, and code contributions!
 
 ---
 
+## Links
+- ➡️ [Why YINI? Why another format!?](./RATIONALE.md) (rationale)
+- ➡️ [Intro to YINI Config Format](https://github.com/YINI-lang/yini-parser-typescript?tab=readme-ov-file#intro-to-yini-config-format) (learn YINI)
+- ➡️ [Read the YINI Specification](./YINI-Specification.md#table-of-contents) (spec)
+- ➡️ [Official YINI Parser on npm](https://www.npmjs.com/package/yini-parser) (npm)
+- ➡️ [YINI Parser GitHub Repo](https://github.com/YINI-lang/yini-parser-typescript) (GitHub)
+- ➡️ [YINI vs Other Formats](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Examples%20of%20YINI%20vs%20Other%20Formats.md)
+
+---
+
 ## License
 This project is licensed under the Apache-2.0 license - see the [LICENSE](<./LICENSE>) file for details.
 

package/dist/YINI.js

@@ -7,7 +7,7 @@ const fs_1 = __importDefault(require("fs"));
 const env_1 = require("./config/env");
 const parseEntry_1 = require("./parseEntry");
 const pathAndFileName_1 = require("./utils/pathAndFileName");
-const system_1 = require("./utils/system");
+const print_1 = require("./utils/print");
 /**
  * This class is the public API, which exposes only parse(..) and
  * parseFile(..), rest of the implementation details are hidden.
@@ -33,7 +33,7 @@ YINI.filePath = ''; // Used in error reporting.
  * @returns A JavaScript object representing the parsed YINI content.
  */
 YINI.parse = (yiniContent, strictMode = false, bailSensitivity = 'auto', includeMetaData = false) => {
-    (0, system_1.debugPrint)('-> Entered static parse(..) in class YINI\n');
+    (0, print_1.debugPrint)('-> Entered static parse(..) in class YINI\n');
     // Important: First, before anything, trim beginning and trailing whitespaces!
     yiniContent = yiniContent.trim();
     if (!yiniContent) {
@@ -63,16 +63,16 @@ YINI.parse = (yiniContent, strictMode = false, bailSensitivity = 'auto', include
         isWithDiagnostics: (0, env_1.isDev)() || (0, env_1.isDebug)(),
         isWithTiming: (0, env_1.isDebug)(),
     };
-    (0, system_1.debugPrint)();
-    (0, system_1.debugPrint)('==== Call parse ==========================');
+    (0, print_1.debugPrint)();
+    (0, print_1.debugPrint)('==== Call parse ==========================');
     const result = (0, parseEntry_1.parseMain)(yiniContent, options);
-    (0, system_1.debugPrint)('==== End call parse ==========================\n');
+    (0, print_1.debugPrint)('==== End call parse ==========================\n');
     if ((0, env_1.isDev)()) {
         console.log();
-        (0, system_1.devPrint)('YINI.parse(..): result:');
+        (0, print_1.devPrint)('YINI.parse(..): result:');
         console.log(result);
-        (0, system_1.devPrint)('Complete result:');
-        (0, system_1.printObject)(result);
+        (0, print_1.devPrint)('Complete result:');
+        (0, print_1.printObject)(result);
     }
     return result;
 };
@@ -93,7 +93,7 @@ YINI.parse = (yiniContent, strictMode = false, bailSensitivity = 'auto', include
  * @returns A JavaScript object representing the parsed YINI content.
  */
 YINI.parseFile = (filePath, strictMode = false, bailSensitivity = 'auto', includeMetaData = false) => {
-    (0, system_1.debugPrint)('Current directory = ' + process.cwd());
+    (0, print_1.debugPrint)('Current directory = ' + process.cwd());
     if ((0, pathAndFileName_1.getFileNameExtension)(filePath).toLowerCase() !== '.yini') {
         console.error('Invalid file extension for YINI file:');
         console.error(`"${filePath}"`);
@@ -128,16 +128,16 @@ YINI.parseFile = (filePath, strictMode = false, bailSensitivity = 'auto', includ
         isWithDiagnostics: (0, env_1.isDev)() || (0, env_1.isDebug)(),
         isWithTiming: (0, env_1.isDebug)(),
     };
-    (0, system_1.debugPrint)();
-    (0, system_1.debugPrint)('==== Call parse ==========================');
+    (0, print_1.debugPrint)();
+    (0, print_1.debugPrint)('==== Call parse ==========================');
     const result = (0, parseEntry_1.parseMain)(content, options);
-    (0, system_1.debugPrint)('==== End call parse ==========================\n');
+    (0, print_1.debugPrint)('==== End call parse ==========================\n');
     if ((0, env_1.isDev)()) {
         console.log();
-        (0, system_1.devPrint)('YINI.parse(..): result:');
+        (0, print_1.devPrint)('YINI.parse(..): result:');
         console.log(result);
-        (0, system_1.devPrint)('Complete result:');
-        (0, system_1.printObject)(result);
+        (0, print_1.devPrint)('Complete result:');
+        (0, print_1.printObject)(result);
     }
     return result;
 };

package/dist/core/ErrorDataHandler.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorDataHandler = void 0;
 const env_1 = require("../config/env");
-const system_1 = require("../utils/system");
+const print_1 = require("../utils/print");
 // All the issue titles are defined here to get a quick overview of all
 // titles, and to easier check that all titles match with relation to
 // the other titles.
@@ -48,7 +48,7 @@ class ErrorDataHandler {
                     column: endCol,
                 },
             };
-            (0, system_1.debugPrint)('issue:');
+            (0, print_1.debugPrint)('issue:');
             (0, env_1.isDebug)() && console.log(issue);
             return issue;
         };
@@ -67,16 +67,16 @@ class ErrorDataHandler {
          */
         this.pushOrBail = (ctx, type, msgWhat, msgWhy = '', msgHint = '') => {
             var _a, _b, _c, _d, _e, _f;
-            (0, system_1.debugPrint)('-> pushOrBail(..)');
-            (0, system_1.debugPrint)('ctx.exception?.name       =' + ((_a = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _a === void 0 ? void 0 : _a.name));
-            (0, system_1.debugPrint)('ctx.exception?.message    = ' + ((_b = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _b === void 0 ? void 0 : _b.message));
-            (0, system_1.debugPrint)('exception?.offendingToken = ' + ((_c = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _c === void 0 ? void 0 : _c.offendingToken));
-            (0, system_1.debugPrint)();
-            (0, system_1.debugPrint)('ctx.ruleIndex    = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.start.channel));
-            (0, system_1.debugPrint)('ctx.ruleIndex    = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.ruleIndex));
-            (0, system_1.debugPrint)('ctx.ruleContext  = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.ruleContext));
-            (0, system_1.debugPrint)('ctx.stop?.line   = ' + ((_d = ctx === null || ctx === void 0 ? void 0 : ctx.stop) === null || _d === void 0 ? void 0 : _d.line));
-            (0, system_1.debugPrint)('ctx.stop?.column = ' + ((_e = ctx === null || ctx === void 0 ? void 0 : ctx.stop) === null || _e === void 0 ? void 0 : _e.column));
+            (0, print_1.debugPrint)('-> pushOrBail(..)');
+            (0, print_1.debugPrint)('ctx.exception?.name       =' + ((_a = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _a === void 0 ? void 0 : _a.name));
+            (0, print_1.debugPrint)('ctx.exception?.message    = ' + ((_b = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _b === void 0 ? void 0 : _b.message));
+            (0, print_1.debugPrint)('exception?.offendingToken = ' + ((_c = ctx === null || ctx === void 0 ? void 0 : ctx.exception) === null || _c === void 0 ? void 0 : _c.offendingToken));
+            (0, print_1.debugPrint)();
+            (0, print_1.debugPrint)('ctx.ruleIndex    = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.start.channel));
+            (0, print_1.debugPrint)('ctx.ruleIndex    = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.ruleIndex));
+            (0, print_1.debugPrint)('ctx.ruleContext  = ' + (ctx === null || ctx === void 0 ? void 0 : ctx.ruleContext));
+            (0, print_1.debugPrint)('ctx.stop?.line   = ' + ((_d = ctx === null || ctx === void 0 ? void 0 : ctx.stop) === null || _d === void 0 ? void 0 : _d.line));
+            (0, print_1.debugPrint)('ctx.stop?.column = ' + ((_e = ctx === null || ctx === void 0 ? void 0 : ctx.stop) === null || _e === void 0 ? void 0 : _e.column));
             const lineNum = (ctx === null || ctx === void 0 ? void 0 : ctx.start.line) || 0; // Column (1-based).
             const startCol = !ctx ? 0 : ++ctx.start.column; // Column (0-based).
             const endCol = (((_f = ctx === null || ctx === void 0 ? void 0 : ctx.stop) === null || _f === void 0 ? void 0 : _f.column) || 0) + 1; // Column (0-based).
@@ -85,9 +85,9 @@ class ErrorDataHandler {
             if (process.env.NODE_ENV === 'test') {
                 msgWhat += `\nAt line: ${lineNum}, column(s): ${startCol}-${endCol}`;
             }
-            (0, system_1.debugPrint)('persistThreshold = ' + this.persistThreshold);
-            (0, system_1.debugPrint)('lineNum = ' + lineNum);
-            (0, system_1.debugPrint)();
+            (0, print_1.debugPrint)('persistThreshold = ' + this.persistThreshold);
+            (0, print_1.debugPrint)('lineNum = ' + lineNum);
+            (0, print_1.debugPrint)();
             const issue = this.makeIssuePayload(type, msgWhat, lineNum, startCol, endCol);
             switch (type) {
                 case 'Internal-Error':