yini-parser 1.4.3 → 1.6.0

package/dist/core/pipeline/pipeline.js

@@ -8,6 +8,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runPipeline = void 0;
+// src/core/pipeline/pipeline.ts
 const perf_hooks_1 = require("perf_hooks");
 const antlr4_1 = require("antlr4");
 const env_1 = require("../../config/env");
@@ -48,6 +49,9 @@ const runPipeline = (yiniContent, coreOptions, runtimeInfo, _meta_userOpts) => {
     (0, print_1.debugPrint)('coreOptions.isThrowOnError = ' + coreOptions.isThrowOnError);
     (0, print_1.debugPrint)('  runtimeInfo.sourceType = ' + runtimeInfo.sourceType);
     (0, print_1.debugPrint)('    runtimeInfo.fileName = ' + runtimeInfo.fileName);
+    (0, print_1.debugPrint)('         bailSensitivity = ' + coreOptions.bailSensitivity);
+    (0, print_1.debugPrint)('coreOptions.isThrowOnError = ' + coreOptions.isThrowOnError);
+    (0, print_1.debugPrint)('   treatEmptyValueAsNull = ' + coreOptions.rules.treatEmptyValueAsNull);
     // let persistThreshold: TBailSensitivityLevel
     // switch (coreOptions.bailSensitivity) {
     //     case '0-Ignore-Errors':
@@ -59,12 +63,21 @@ const runPipeline = (yiniContent, coreOptions, runtimeInfo, _meta_userOpts) => {
     //     default:
     //         persistThreshold = '2-Abort-Even-on-Warnings'
     // }
-    const errorHandler = new errorDataHandler_1.ErrorDataHandler(runtimeInfo.sourceType, runtimeInfo.fileName, coreOptions.bailSensitivity, coreOptions.isQuiet, coreOptions.isSilent, coreOptions.isThrowOnError);
-    if (yiniContent.trim() === '') {
-        const isFileSourceType = runtimeInfo?.sourceType === 'File';
-        // Note, after pushing processing may continue or exit, depending on the error and/or the bail threshold.
-        errorHandler.pushOrBail(undefined, 'Syntax-Error', 'Empty YINI document.', `The input is blank or contains only whitespace in the ${isFileSourceType ? 'YINI file' : 'YINI inline content'}.`, `Tip: Add at least one section '^ SectionName' or a key-value pair 'key = value' to make it a valid YINI file.`);
+    const errorHandler = new errorDataHandler_1.ErrorDataHandler(runtimeInfo.sourceType, runtimeInfo.fileName, coreOptions.bailSensitivity, coreOptions.isDiagnosticOutputEnabled, coreOptions.isQuiet, coreOptions.isSilent, coreOptions.isThrowOnError);
+    for (const issue of runtimeInfo.preflightIssues) {
+        errorHandler.pushOrBail(issue.locInput, issue.type, issue.msgWhat, issue.msgWhy, issue.msgHint);
     }
+    // if (yiniContent.trim() === '') {
+    //     const isFileSourceType: boolean = runtimeInfo?.sourceType === 'File'
+    //     // Note, after pushing processing may continue or exit, depending on the error and/or the bail threshold.
+    //     errorHandler.pushOrBail(
+    //         undefined,
+    //         'Syntax-Error',
+    //         'Empty YINI document.',
+    //         `The input is blank or contains only whitespace in the ${isFileSourceType ? 'YINI file' : 'YINI inline content'}.`,
+    //         `Tip: Add at least one section '^ SectionName' or a key-value pair 'key = value' to make it a valid YINI file.`,
+    //     )
+    // }
     //---------------------------------------------
     // Note: Only computed when isWithTiming.
     let timeStartMs = 0;
@@ -136,8 +149,18 @@ const runPipeline = (yiniContent, coreOptions, runtimeInfo, _meta_userOpts) => {
     const builder = new astBuilder_1.default(errorHandler, coreOptions, runtimeInfo.sourceType, runtimeInfo.fileName || null);
     const ast = builder.buildAST(parseTree);
     if (ast.numOfMembers === 0 && ast.numOfSections === 0) {
-        // Note, after pushing processing may continue or exit, depending on the error and/or the bail threshold.
-        errorHandler.pushOrBail(undefined, 'Syntax-Error', 'No meaningful content.', `No sections or members found in the ${ast.sourceType === 'File' ? 'YINI file' : 'YINI inline content'}.`, `${ast.sourceType === 'File' ? 'A valid YINI file' : 'Any valid YINI inline content'} must contain at least one section '^ SectionName' or a key–value pair 'key = value' to make it a valid YINI file.`);
+        // Lenient mode: empty document is allowed, but warning.
+        // Strict mode: empty document is invalid, error.
+        const sourceLabel = ast.sourceType === 'File' ? 'YINI file' : 'YINI inline content';
+        const sourceRequirement = ast.sourceType === 'File'
+            ? 'A valid YINI file must contain at least one section, for example: ^ SectionName, or a key-value pair, for example: key = value.'
+            : 'Valid YINI inline content must contain at least one section, for example: ^ SectionName, or a key-value pair, for example: key = value.';
+        if (ast.isStrict === true) {
+            errorHandler.pushOrBail(undefined, 'Syntax-Error', 'Empty YINI document.', `The ${sourceLabel} contains no meaningful content.`, sourceRequirement);
+        }
+        else {
+            errorHandler.pushOrBail(undefined, 'Syntax-Warning', 'Empty YINI document.', `The ${sourceLabel} contains no meaningful content.`, sourceRequirement);
+        }
     }
     if ((0, env_1.isDebug)()) {
         console.log();
@@ -176,8 +199,9 @@ const runPipeline = (yiniContent, coreOptions, runtimeInfo, _meta_userOpts) => {
         // Note, after pushing processing may continue or exit, depending on the error and/or the bail threshold.
         errorHandler.pushOrBail(undefined, 'Syntax-Warning', 'Warning: Strict initialMode is not yet fully implemented.', 'Some validation rules may still be missing or incomplete.');
         if (coreOptions.bailSensitivity === '0-Ignore-Errors') {
-            // IMPORTANT: If "silent" option is set, do not log anything to console!
-            if (!coreOptions.isQuiet && !coreOptions.isSilent) {
+            if (coreOptions.isDiagnosticOutputEnabled &&
+                !coreOptions.isQuiet &&
+                !coreOptions.isSilent) {
                 console.warn(`Warning: The initial mode was set to strict mode, but fail level is set to 'ignore-errors'. This combination is contradictory and might be a mistake.`);
             }
         }
@@ -204,7 +228,8 @@ const runPipeline = (yiniContent, coreOptions, runtimeInfo, _meta_userOpts) => {
     const constructedMetadata = (0, resultMetadataBuilder_1.buildResultMetadata)(params);
     (0, print_1.debugPrint)('getNumOfErrors(): ' + errorHandler.getNumOfErrors());
     // Print a summary line at the end if any errors or warnings.
-    if (!coreOptions.isQuiet && !coreOptions.isSilent) {
+    if (coreOptions.isDiagnosticOutputEnabled &&
+        !coreOptions.isSilent) {
         const errors = errorHandler.getNumOfErrors();
         const warnings = errorHandler.getNumOfWarnings();
         // Notes:

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 --------------------------------------------
@@ -102,6 +105,19 @@ 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);
+        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 +127,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 +186,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 +205,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,62 +1,51 @@
-import { ATN, CharStream, DFA, Lexer, RuleContext } from "antlr4";
+import { ATN, CharStream, DFA, Lexer } from "antlr4";
 export default class YiniLexer extends Lexer {
-    static readonly YINI_TOKEN = 1;
-    static readonly INCLUDE_TOKEN = 2;
-    static readonly DEPRECATED_TOKEN = 3;
-    static readonly SECTION_HEAD = 4;
+    static readonly SHEBANG = 1;
+    static readonly YINI_TOKEN = 2;
+    static readonly INCLUDE_TOKEN = 3;
+    static readonly DEPRECATED_TOKEN = 4;
     static readonly TERMINAL_TOKEN = 5;
-    static readonly SS = 6;
-    static readonly EUR = 7;
-    static readonly CARET = 8;
-    static readonly GT = 9;
-    static readonly LT = 10;
-    static readonly EQ = 11;
-    static readonly HASH = 12;
-    static readonly COMMA = 13;
-    static readonly COLON = 14;
-    static readonly OB = 15;
-    static readonly CB = 16;
-    static readonly OC = 17;
-    static readonly CC = 18;
-    static readonly PLUS = 19;
-    static readonly DOLLAR = 20;
-    static readonly PC = 21;
-    static readonly AT = 22;
-    static readonly SEMICOLON = 23;
-    static readonly BOOLEAN_FALSE = 24;
-    static readonly BOOLEAN_TRUE = 25;
-    static readonly NULL = 26;
-    static readonly EMPTY_OBJECT = 27;
-    static readonly EMPTY_LIST = 28;
-    static readonly SHEBANG = 29;
-    static readonly NUMBER = 30;
-    static readonly KEY = 31;
-    static readonly IDENT = 32;
-    static readonly IDENT_BACKTICKED = 33;
-    static readonly STRING = 34;
-    static readonly TRIPLE_QUOTED_STRING = 35;
-    static readonly SINGLE_OR_DOUBLE = 36;
-    static readonly R_AND_C_STRING = 37;
-    static readonly HYPER_STRING = 38;
-    static readonly ESC_SEQ = 39;
-    static readonly ESC_SEQ_BASE = 40;
-    static readonly NL = 41;
-    static readonly SINGLE_NL = 42;
-    static readonly WS = 43;
-    static readonly BLOCK_COMMENT = 44;
-    static readonly COMMENT = 45;
-    static readonly LINE_COMMENT = 46;
-    static readonly INLINE_COMMENT = 47;
-    static readonly IDENT_INVALID = 48;
-    static readonly REST = 49;
-    static readonly META_INVALID = 50;
+    static readonly SECTION_HEAD = 6;
+    static readonly INVALID_SECTION_HEAD = 7;
+    static readonly BOOLEAN_FALSE = 8;
+    static readonly BOOLEAN_TRUE = 9;
+    static readonly NULL = 10;
+    static readonly EMPTY_OBJECT = 11;
+    static readonly EMPTY_LIST = 12;
+    static readonly STRING = 13;
+    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)[];
@@ -65,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;