yini-parser 1.5.0 → 1.6.1

package/dist/core/runtime.js

@@ -16,8 +16,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _YiniRuntime_runtime;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.YiniRuntime = void 0;
+// src/core/runtime.ts
 const fs_1 = __importDefault(require("fs"));
 const env_1 = require("../config/env");
+const validateShebangPlacement_1 = require("../parsers/validateShebangPlacement");
 const pathAndFileName_1 = require("../utils/pathAndFileName");
 const print_1 = require("../utils/print");
 const string_1 = require("../utils/string");
@@ -54,6 +56,7 @@ class YiniRuntime {
             timeIoMs: null,
             preferredBailSensitivity: null,
             sha256: null,
+            preflightIssues: [],
         };
     }
     // --- Single implementation --------------------------------------------
@@ -62,21 +65,6 @@ class YiniRuntime {
     runParse(yiniContent, arg2, // strictMode | options
     failLevel = 'auto', includeMetadata = false) {
         (0, print_1.debugPrint)('-> Entered runParse(..) in YiniRuntime class\n');
-        // Handle optional UTF-8 BOM content of file.
-        if (yiniContent.startsWith('\uFEFF')) {
-            // (!) NOTE: slice(1) only because UTF-8 BOM appears as one single Unicode code characte, even though it is 3 bytes (EF BB BF) on disk.
-            yiniContent = yiniContent.slice(1);
-            (0, print_1.devPrint)('runParse(..): BOM was detected and stripped BOM in UTF-8 content');
-        }
-        // Handle optional shebang line (if line starts with "#!").
-        if (yiniContent.startsWith('#!')) {
-            const newlineIndex = yiniContent.indexOf('\n');
-            (0, print_1.devPrint)('runParse(..): Shebang detected at first line, stripped line 1.');
-            if (newlineIndex < 2) {
-                throw new Error('Syntax-Error: Unexpected YINI input');
-            }
-            yiniContent = yiniContent.slice(newlineIndex + 1);
-        }
         // Runtime guard to catch illegal/ambiguous calls coming from JS or any-cast code
         if ((0, optionsFunctions_1.isOptionsObjectForm)(arg2) &&
             (failLevel !== 'auto' || includeMetadata !== false)) {
@@ -102,6 +90,20 @@ class YiniRuntime {
                 includeMetadata,
             };
         }
+        const shebangIssue = (0, validateShebangPlacement_1.getShebangPlacementIssue)(yiniContent, userOpts.strictMode);
+        if (shebangIssue) {
+            __classPrivateFieldGet(this, _YiniRuntime_runtime, "f").preflightIssues.push(shebangIssue);
+        }
+        const originalContent = yiniContent;
+        yiniContent = (0, validateShebangPlacement_1.stripBomAndValidShebang)(yiniContent);
+        yiniContent = (0, validateShebangPlacement_1.normalizeShebangCommentLines)(yiniContent);
+        if (originalContent.startsWith('\uFEFF')) {
+            (0, print_1.devPrint)('runParse(..): BOM was detected and stripped from UTF-8 content.');
+        }
+        if (originalContent.startsWith('#!') ||
+            originalContent.startsWith('\uFEFF#!')) {
+            (0, print_1.devPrint)('runParse(..): Shebang detected on first line and ignored.');
+        }
         if (userOpts.includeMetadata && __classPrivateFieldGet(this, _YiniRuntime_runtime, "f").sourceType === 'Inline') {
             const lineCount = yiniContent.split(/\r?\n/).length; // Counts the lines.
             const sha256 = (0, string_1.computeSha256)(yiniContent); // NOTE: Compute BEFORE any possible tampering of content.
@@ -111,9 +113,13 @@ class YiniRuntime {
         }
         // NOTE: Important: Do not trim or mutate the yiniContent here, due
         // to it will mess up the line numbers in error reporting.
-        if (!yiniContent) {
-            throw new Error('Syntax-Error: Unexpected blank YINI input');
+        // if (!yiniContent) {
+        //     throw new Error('Syntax-Error: Unexpected blank YINI input')
+        // }
+        if (yiniContent === null || yiniContent === undefined) {
+            throw new Error('Syntax-Error: Missing YINI input');
         }
+        // IMPORTANT: Makes sure input ends with an empty NL!
         if (!yiniContent.endsWith('\n')) {
             yiniContent += '\n';
         }
@@ -166,13 +172,6 @@ class YiniRuntime {
             };
         }
         if ((0, pathAndFileName_1.getFileNameExtension)(filePath).toLowerCase() !== '.yini') {
-            // IMPORTANT: If "silent" option is set, do not log anything to console!
-            if (!userOpts.silent) {
-                // In quiet-mode we still show errors (these are fine).
-                console.error('Invalid file extension for YINI file:');
-                console.error(`"${filePath}"`);
-                console.error('File does not have a valid ".yini" extension (case-insensitive).');
-            }
             throw new Error('Error: Unexpected file extension for YINI file');
         }
         // ---- Phase 0: I/O ----
@@ -192,22 +191,18 @@ class YiniRuntime {
             __classPrivateFieldGet(this, _YiniRuntime_runtime, "f").preferredBailSensitivity = userOpts.failLevel;
             __classPrivateFieldGet(this, _YiniRuntime_runtime, "f").sha256 = (0, string_1.computeSha256)(content); // NOTE: Compute BEFORE any possible tampering of content.
         }
-        let hasNoNewlineAtEOF = false;
         if (!content.endsWith('\n')) {
+            __classPrivateFieldGet(this, _YiniRuntime_runtime, "f").preflightIssues.push({
+                locInput: undefined,
+                type: 'Syntax-Warning',
+                msgWhat: 'No newline at end of file.',
+                msgWhy: `It's recommended to end a YINI file with a newline. File: "${filePath}"`,
+            });
             content += '\n';
-            hasNoNewlineAtEOF = true;
         }
         const result = this.runParse(content, {
             ...userOpts,
         });
-        // if (hasNoNewlineAtEOF && !userOpts.quiet && !userOpts.silent) {
-        if (hasNoNewlineAtEOF && !userOpts.quiet) {
-            // IMPORTANT: If "silent" option is set, do not log anything to console!
-            if (!userOpts.silent) {
-                //@todo: (or maybe not, 20250917) Maybe let errorHandler emit message
-                console.warn(`No newline at end of file, it's recommended to end a file with a newline. File:\n"${filePath}"`);
-            }
-        }
         return result;
     }
 }

package/dist/grammar/generated/YiniLexer.d.ts

@@ -1,4 +1,4 @@
-import { ATN, CharStream, DFA, Lexer, RuleContext } from "antlr4";
+import { ATN, CharStream, DFA, Lexer } from "antlr4";
 export default class YiniLexer extends Lexer {
     static readonly SHEBANG = 1;
     static readonly YINI_TOKEN = 2;
@@ -13,44 +13,39 @@ export default class YiniLexer extends Lexer {
     static readonly EMPTY_OBJECT = 11;
     static readonly EMPTY_LIST = 12;
     static readonly STRING = 13;
-    static readonly TRIPLE_QUOTED_STRING = 14;
-    static readonly SINGLE_OR_DOUBLE = 15;
-    static readonly R_AND_C_STRING = 16;
-    static readonly HYPER_STRING = 17;
-    static readonly NUMBER = 18;
-    static readonly SS = 19;
-    static readonly CARET = 20;
-    static readonly GT = 21;
-    static readonly LT = 22;
-    static readonly EQ = 23;
-    static readonly HASH = 24;
-    static readonly COMMA = 25;
-    static readonly COLON = 26;
-    static readonly OB = 27;
-    static readonly CB = 28;
-    static readonly OC = 29;
-    static readonly CC = 30;
-    static readonly PLUS = 31;
-    static readonly DOLLAR = 32;
-    static readonly PC = 33;
-    static readonly AT = 34;
-    static readonly SEMICOLON = 35;
-    static readonly NL = 36;
-    static readonly WS = 37;
-    static readonly BLOCK_COMMENT = 38;
-    static readonly LINE_COMMENT = 39;
-    static readonly INLINE_COMMENT = 40;
-    static readonly KEY = 41;
-    static readonly IDENT_INVALID = 42;
-    static readonly REST = 43;
-    static readonly META_INVALID = 44;
+    static readonly NUMBER = 14;
+    static readonly CARET = 15;
+    static readonly SS = 16;
+    static readonly GT = 17;
+    static readonly LT = 18;
+    static readonly EQ = 19;
+    static readonly COMMA = 20;
+    static readonly COLON = 21;
+    static readonly OB = 22;
+    static readonly CB = 23;
+    static readonly OC = 24;
+    static readonly CC = 25;
+    static readonly PLUS = 26;
+    static readonly DOLLAR = 27;
+    static readonly PC = 28;
+    static readonly AT = 29;
+    static readonly SEMICOLON = 30;
+    static readonly NL = 31;
+    static readonly WS = 32;
+    static readonly BLOCK_COMMENT = 33;
+    static readonly DISABLED_LINE = 34;
+    static readonly FULL_LINE_COMMENT = 35;
+    static readonly INLINE_COMMENT = 36;
+    static readonly KEY = 37;
+    static readonly IDENT_INVALID = 38;
+    static readonly REST = 39;
+    static readonly META_INVALID = 40;
     static readonly EOF: number;
     static readonly channelNames: string[];
     static readonly literalNames: (string | null)[];
     static readonly symbolicNames: (string | null)[];
     static readonly modeNames: string[];
     static readonly ruleNames: string[];
-    atLineStart(): boolean;
     constructor(input: CharStream);
     get grammarFileName(): string;
     get literalNames(): (string | null)[];
@@ -59,8 +54,6 @@ export default class YiniLexer extends Lexer {
     get serializedATN(): number[];
     get channelNames(): string[];
     get modeNames(): string[];
-    sempred(localctx: RuleContext, ruleIndex: number, predIndex: number): boolean;
-    private LINE_COMMENT_sempred;
     static readonly _serializedATN: number[];
     private static __ATN;
     static get _ATN(): ATN;