yini-parser 1.0.1-beta → 1.1.0-beta

package/dist/grammar/YiniParserVisitor.d.ts

@@ -1,25 +1,27 @@
 import { ParseTreeVisitor } from 'antlr4';
 import { YiniContext } from "./YiniParser.js";
-import { SectionContext } from "./YiniParser.js";
-import { Terminal_lineContext } from "./YiniParser.js";
-import { Section_membersContext } from "./YiniParser.js";
+import { PrologContext } from "./YiniParser.js";
+import { Terminal_stmtContext } from "./YiniParser.js";
+import { StmtContext } from "./YiniParser.js";
+import { Meta_stmtContext } from "./YiniParser.js";
+import { DirectiveContext } from "./YiniParser.js";
+import { AnnotationContext } from "./YiniParser.js";
+import { EolContext } from "./YiniParser.js";
+import { AssignmentContext } from "./YiniParser.js";
 import { MemberContext } from "./YiniParser.js";
-import { Member_colon_listContext } from "./YiniParser.js";
+import { Colon_list_declContext } from "./YiniParser.js";
 import { ValueContext } from "./YiniParser.js";
 import { Object_literalContext } from "./YiniParser.js";
-import { ObjectMemberListContext } from "./YiniParser.js";
-import { ObjectMemberContext } from "./YiniParser.js";
-import { ListContext } from "./YiniParser.js";
-import { List_in_bracketsContext } from "./YiniParser.js";
+import { Object_membersContext } from "./YiniParser.js";
+import { Object_memberContext } from "./YiniParser.js";
+import { List_literalContext } from "./YiniParser.js";
 import { ElementsContext } from "./YiniParser.js";
-import { ElementContext } from "./YiniParser.js";
 import { Number_literalContext } from "./YiniParser.js";
 import { Null_literalContext } from "./YiniParser.js";
 import { String_literalContext } from "./YiniParser.js";
 import { String_concatContext } from "./YiniParser.js";
 import { Boolean_literalContext } from "./YiniParser.js";
-import { Empty_objectContext } from "./YiniParser.js";
-import { Empty_listContext } from "./YiniParser.js";
+import { Bad_meta_textContext } from "./YiniParser.js";
 import { Bad_memberContext } from "./YiniParser.js";
 /**
  * This interface defines a complete generic visitor for a parse tree produced
@@ -36,83 +38,101 @@ export default class YiniParserVisitor<Result> extends ParseTreeVisitor<Result>
      */
     visitYini?: (ctx: YiniContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.section`.
+     * Visit a parse tree produced by `YiniParser.prolog`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitSection?: (ctx: SectionContext) => Result;
+    visitProlog?: (ctx: PrologContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.terminal_line`.
+     * Visit a parse tree produced by `YiniParser.terminal_stmt`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitTerminal_line?: (ctx: Terminal_lineContext) => Result;
+    visitTerminal_stmt?: (ctx: Terminal_stmtContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.section_members`.
+     * Visit a parse tree produced by `YiniParser.stmt`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitSection_members?: (ctx: Section_membersContext) => Result;
+    visitStmt?: (ctx: StmtContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.member`.
+     * Visit a parse tree produced by `YiniParser.meta_stmt`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitMember?: (ctx: MemberContext) => Result;
+    visitMeta_stmt?: (ctx: Meta_stmtContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.member_colon_list`.
+     * Visit a parse tree produced by `YiniParser.directive`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitMember_colon_list?: (ctx: Member_colon_listContext) => Result;
+    visitDirective?: (ctx: DirectiveContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.value`.
+     * Visit a parse tree produced by `YiniParser.annotation`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitValue?: (ctx: ValueContext) => Result;
+    visitAnnotation?: (ctx: AnnotationContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.object_literal`.
+     * Visit a parse tree produced by `YiniParser.eol`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitObject_literal?: (ctx: Object_literalContext) => Result;
+    visitEol?: (ctx: EolContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.objectMemberList`.
+     * Visit a parse tree produced by `YiniParser.assignment`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitObjectMemberList?: (ctx: ObjectMemberListContext) => Result;
+    visitAssignment?: (ctx: AssignmentContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.objectMember`.
+     * Visit a parse tree produced by `YiniParser.member`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitObjectMember?: (ctx: ObjectMemberContext) => Result;
+    visitMember?: (ctx: MemberContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.list`.
+     * Visit a parse tree produced by `YiniParser.colon_list_decl`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitList?: (ctx: ListContext) => Result;
+    visitColon_list_decl?: (ctx: Colon_list_declContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.list_in_brackets`.
+     * Visit a parse tree produced by `YiniParser.value`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitList_in_brackets?: (ctx: List_in_bracketsContext) => Result;
+    visitValue?: (ctx: ValueContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.elements`.
+     * Visit a parse tree produced by `YiniParser.object_literal`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitElements?: (ctx: ElementsContext) => Result;
+    visitObject_literal?: (ctx: Object_literalContext) => Result;
+    /**
+     * Visit a parse tree produced by `YiniParser.object_members`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitObject_members?: (ctx: Object_membersContext) => Result;
+    /**
+     * Visit a parse tree produced by `YiniParser.object_member`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitObject_member?: (ctx: Object_memberContext) => Result;
+    /**
+     * Visit a parse tree produced by `YiniParser.list_literal`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitList_literal?: (ctx: List_literalContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.element`.
+     * Visit a parse tree produced by `YiniParser.elements`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitElement?: (ctx: ElementContext) => Result;
+    visitElements?: (ctx: ElementsContext) => Result;
     /**
      * Visit a parse tree produced by `YiniParser.number_literal`.
      * @param ctx the parse tree
@@ -144,17 +164,11 @@ export default class YiniParserVisitor<Result> extends ParseTreeVisitor<Result>
      */
     visitBoolean_literal?: (ctx: Boolean_literalContext) => Result;
     /**
-     * Visit a parse tree produced by `YiniParser.empty_object`.
-     * @param ctx the parse tree
-     * @return the visitor result
-     */
-    visitEmpty_object?: (ctx: Empty_objectContext) => Result;
-    /**
-     * Visit a parse tree produced by `YiniParser.empty_list`.
+     * Visit a parse tree produced by `YiniParser.bad_meta_text`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitEmpty_list?: (ctx: Empty_listContext) => Result;
+    visitBad_meta_text?: (ctx: Bad_meta_textContext) => Result;
     /**
      * Visit a parse tree produced by `YiniParser.bad_member`.
      * @param ctx the parse tree

package/dist/grammar/YiniParserVisitor.js

@@ -1,5 +1,5 @@
 "use strict";
-// Generated from grammar/v1.0.0-rc.2/YiniParser.g4 by ANTLR 4.13.2
+// Generated from grammar/v1.0.0-rc.3/YiniParser.g4 by ANTLR 4.13.2
 Object.defineProperty(exports, "__esModule", { value: true });
 const antlr4_1 = require("antlr4");
 /**

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import YINI from './YINI';
-export declare const parse: (yiniContent: string, strictMode?: boolean, bailSensitivity?: "auto" | 0 | 1 | 2, includeMetaData?: boolean) => import("./core/types").TJSObject;
-export declare const parseFile: (filePath: string, strictMode?: boolean, bailSensitivity?: "auto" | 0 | 1 | 2, includeMetaData?: boolean) => import("./core/types").TJSObject;
+export declare const parse: typeof YINI.parse;
+export declare const parseFile: typeof YINI.parseFile;
+export declare const getTabSize: typeof YINI.getTabSize;
+export declare const setTabSize: typeof YINI.setTabSize;
 export default YINI;

package/dist/index.js

@@ -1,27 +1,29 @@
 "use strict";
-// import { isDebug&&console.log } from './utils/general'
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _a, _b, _c;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = exports.parse = void 0;
 /*
-    https://pauloe-me.medium.com/typescript-npm-package-publishing-a-beginners-guide-40b95908e69c
+    https://github.com/YINI-lang/yini-parser-typescript/blob/main/docs/Project-Setup.md
     
     Run the code with the following command:
-        npx ts-node index
-    or
         npm start
+    or
+        npm run start:dev
+    or
+        npm run start:dev:debug
     
     /END
 */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a, _b, _c;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTabSize = exports.getTabSize = exports.parseFile = exports.parse = void 0;
 const env_1 = require("./config/env");
 const print_1 = require("./utils/print");
 const YINI_1 = __importDefault(require("./YINI"));
-// export { default } from './YINI'
 exports.parse = YINI_1.default.parse;
 exports.parseFile = YINI_1.default.parseFile;
+exports.getTabSize = YINI_1.default.getTabSize;
+exports.setTabSize = YINI_1.default.setTabSize;
 exports.default = YINI_1.default;
 (0, print_1.debugPrint)();
 (0, print_1.debugPrint)('-> Entered index.ts');
@@ -52,99 +54,7 @@ if ((0, env_1.isProdEnv)()) {
     // Do nothing, and exit.
 }
 else {
-    const invalidInput1 = `
-^ Settings
-fruit = "Pear"
-number = 5
-value q= "something"
-`;
-    const invalidInput2 = `
-^ 	Config
-varAge = 30
-varName = abcd
-varNull = NULL
-`;
-    const input1 = `
-^ 	SectionName
-varBool = true
-varBool2 = off
-varInt = 30
-varFloat = 12.34
-varStr = "Alice"
-listItems = ["a", "b", "c"]
-varE1 = 1e4
-varE2 = 1.23e4
-varE3 = 6.5E23
-/END
-`;
-    const input2 = `
-^ 	Config
-varAge = 30
-varName = "Alice"
-varNull = NULL
-listItems = ["a", "b", "c"]
-	^^Extra
-	isExtra = true
-/END
-`;
-    // const input = `
-    // # 	Config`;
-    // debugPrint('input2:')
-    // if (isDebug()) {
-    //     console.debug(input2)
-    // }
-    // parseUntilError(input2)
-    // debugPrint('invalidInput1:')
-    // if (isDebug()) {
-    //     console.debug(invalidInput1)
-    // }
-    // parseUntilError(invalidInput1)
     if (env_1.localAppEnv === 'local' && env_1.localNodeEnv !== 'test') {
-        /*
-        parseUntilError(`
---^ Section0
-    --value = 0
-^ Section1
-    value = 1
-
-^^ Section11
-    value = 11
-
-    ^^^ Section111
-     value = 111
-//^^^^ Section2104
-    value = 24
-
-^ Section2
-    value = 2
-`)
-    }
-*/
-        // parseUntilError(`number = 42`)
-        /*
-Expected JS output:
-{
-  Section1: { value: 1, Section2: { value: 11 }},
-  Section2: { value: 2 }
-}
-
-*/
-        /*
-        parseUntilError(
-            `
-// Using numeric shorthand section markers.
-
-@yini
-
-// This whole line is a comment.
-            ^SectionName# This part is a comment.
-            // This whole line is a comment.
-            --x=1
-                `,
-            false,
-            2,
-        )
-*/
         // parseUntilError(`^1 SectionName`, false, 2)
         //         const validYini = `
         // < user
@@ -175,24 +85,292 @@ Expected JS output:
         //     id = 32403  # The correct app id.
         //     title = "My Program"
         // `
-        //         const yini = ` // corrupt yini
-        // ^ Section
-        // = "missing_key_name"  // In strict should throw error, while lenient should pass
+        /*
+        const yini = `
+        @yini
+
+        ^ NumberFormats
+
+          ^^ HexFormat              // Hexadecimal (base-16)
+             hex    = #FF0066       // Default notation
+             altHex = 0xFF0066      // Alternative notation
+          ^^ BinFormat              // Binary (base-2)
+             bin    = %10101111     // Default notation
+             altBin = 0b10101111    // Alternative notation
+          ^^ OctFormat              // Octal (base-8)
+             oct    = 0o755         // ( = decimal 493)
+          ^^ DozFormat              // Duodecimal (base-12)
+             doz    = 0z10XE        // Default notation:     X=10, E=11
+             altDoz = 0z10AB        // Alternative notation: A=10, B=11
+        ` // End.
+        */
+        /*
+        const yini = `
+    @yini
+    @YINI   ///dfsf
+
+    < User
+    nullKey =
+    nullKey2 = NULL
+    username = 'tester two'
+    userId   = 234
+    userColor = #ffaa99
+    userPerm = 0O733
+    userFearues = %01101
+    isSysOp = YES
+
+    map = {
+        a: 3,
+        b: 4,
+        cc: 5,
+        \`d d\`: 3453
+        }
+
+    listValueB: 3, 4, 5
+    listValue2 = ["a", "b"]
+    listValue3 = [434]
+    listValue4 = []
+    listValue5 = [1, ["a", "b", "c", [null, TRUE]], 3]
+    
+    --listObject = { a: 1, b: 2}
+    
+    colonList:
+        1,
+        2,
+        3,
+
+        << Prefs
+        theme = "light"
+        notifications = OFF
+        nullValue = NULL
+
+    ^1 User2
+    ^2 PrefsOfUser2
+    ^3 DeepSection
+    ^4 DeeperSection
+    key = "Level 4 section"
+    ^5 YetDeeperSection
+    key = "Level 5 section"
+    item = 77
+
+    <1 User3
+    username = 'tester three'
+    isSysOp = NO
+
+        <2 Prefs2
+        theme = "special-dark"
+        notifications = ON
+
+        <2 Special
+        value = 123
+        `
+*/
+        // npm run start:dev
+        // "timing": {
+        //     "totalMs": 158.421,
+        //     "phase1Ms": 151.36,
+        //     "phase2Ms": 6.92,
+        //     "phase3Ms": 0.14
+        // }
+        //console.log(toPrettyJSON(YINI.parse(yini, false, 'auto', true)))
+        // const yini = `
+        //     < SubTitle
+        //     theme = "special-dark"
+        //     notifications = ON
+        //     < SubTitle // NOT OK, SubTitle already exists
+        //     theme2 = "special-dark"
         //         `
+        // Arrange.
+        /*
         const yini = `
-// NOTE: Raw string doesn't support escapes, escape sequences will appear as-is!
-    `;
-        // YINI.parse(yini, false)
-        console.log((0, print_1.toPrettyJSON)(YINI_1.default.parse(yini, false)));
-        //         parseUntilError(`
-        // ^ Section1
-        //             ^^ Section2
-        //             ^^^ Section3
-        //             ^^^^ Section4  // Level 4.
-        //             ^^^^^ Section5
-        //             ^^^^^^ Section6
-        //             ^^^^^^^ Section7
-        //             strVar = "These section header are valid!"
-        //     `)
+        @yini
+        // Example: Strict-friendly YINI document (no trailing commas, explicit /END)
+
+        ^ App
+        name = 'YINI Demo Service'
+        version = '1.4.0'
+        description = 'Demo service for showcasing the YINI format'
+        owners = ['dev-team', 'ops-team']
+
+        // String concatenation (the '+' joins adjacent STRING tokens)
+--        longNote = 'This text is split across ' +
+--                    'two strings and then concatenated.'
+
+        // Case-insensitive booleans
+        enabled = YES
+        experimentalMode = off
+
+        // Numbers (ints, floats, scientific)
+        retries = 3
+        requestTimeoutMs = 2500
+        backoffFactor = 1.25
+        maxPayloadMB = 1.0e2
+
+        ^ Server
+        host = '127.0.0.1'
+        port = 8080
+        useTLS = false
+
+        ^^ CORS
+            allowedOrigins: 'https://example.com', 'https://admin.example.com'
+            allowCredentials = true
+
+        ^^ Headers
+            // Object literal with key:value pairs
+            defaults = {
+            \`X-Frame-Options\`: 'DENY',
+            \`X-Content-Type-Options\`: 'nosniff'
+            }
+
+        ^ Database
+        engine = 'postgres'
+        host = 'db.internal'
+        port = 5432
+        username = 'app_user'
+        password = 'change_me'
+        pool = {
+            min: 2,
+            max: 16
+        }
+
+        ^^ Replicas
+            // Colon-form list (values only)
+            endpoints: 'db-replica-1.internal', 'db-replica-2.internal'
+            readPreference = 'nearest'
+
+        ^ Features
+        // Mixed data types
+        betaFlags = ['new-ui', 'fast-path']
+        darkLaunch = NO
+        uploadLimitMB = 128
+
+        ^ Integrations
+        // List of objects
+        webhooks = [
+            { name: 'audit', url: 'https://hooks.example.com/audit',  active: true },
+            { name: 'metrics', url: 'https://hooks.example.com/metric', active: true }
+        ]
+
+        ^ Users
+        // Simple table-ish list using colon form
+        admins: 'alice', 'bob', 'carol'
+        reviewers: 'dave', 'erin'
+
+        ^^ Profiles
+            // Object-of-objects
+            alice = {
+            email: 'alice@example.com',
+            roles: ['admin', 'dev'],
+            mfa: true
+            }
+            bob = {
+            email: 'bob@example.com',
+            roles: ['admin'],
+            mfa: false
+            }
+
+        ^ Paths
+        logs = '/var/log/yini-demo/'
+        data = '/srv/yini-demo/data'
+
+        ^^ \`Backups\`
+            // Empty value -> null in lenient mode; in strict mode, supply explicit null:
+            lastFull = null
+            targets: '/mnt/backup1', '/mnt/backup2'
+        ^^^ Backups2
+            value = 23
+
+        ^ Security
+        allowedIPs: '10.0.0.0/24', '10.1.0.0/24'
+
+        ^ Logging
+        level = 'info'
+        format = 'json'
+        sinks = ['stdout']
+
+        /END
+        `*/
+        // const yini = `
+        //     /*sdfsdf*/
+        //     @yini
+        //     @include 'sdf'
+        //     --@invalid
+        //     @deprecated
+        //     ^ window
+        //     --^^ window2
+        //     title = 'Sample Window'  // Strings can be enclosed in either ' or ".
+        //     @deprecated
+        //     id = 'window_main'
+        //     // @bla
+        //     --@include 'wrongplace'
+        //     --@yini   // This is an error should be catched in the parser.
+        //     /end
+        // `
+        // YINI.setTabSize(2)
+        // debugPrint('tab size = ' + YINI.getTabSize())
+        const yini = `        @yini
+        --@yini
+        ^^ Header // INVALID: Must start with atleast one 1-level section.
+        key = 33254
+        /END
+        --/END
+        `;
+        console.log((0, print_1.toPrettyJSON)(YINI_1.default.parse(yini, {
+            strictMode: false,
+            failLevel: 1,
+            includeMetaData: false,
+            requireDocTerminator: false,
+        })));
+        //         const yini = `
+        // ^ Booleans
+        // bool1 = true
+        // bool2 = false
+        // bool3 = on
+        // bool4 = off
+        // bool5 = yes
+        // bool6 = no
+        //         `
+        //         console.log(
+        //             toPrettyJSON(
+        //                 YINI.parse(yini, {
+        //                     strictMode: true,
+        //                     failLevel: 'auto',
+        //                     includeMetaData: false,
+        //                     requireDocTerminator: false,
+        //                 }),
+        //             ),
+        //         )
+        // console.log(
+        //     toPrettyJSON(
+        //         YINI.parseFile(
+        //             'comprehensive-example.yini',
+        //             false,
+        //             'auto',
+        //             true,
+        //         ),
+        //     ),
+        // )
+        // console.log(
+        //     toPrettyJSON(
+        //         YINI.parseFile('comprehensive-example.yini', {
+        //             strictMode: false,
+        //             failLevel: 'auto',
+        //             includeMetaData: true,
+        //         }),
+        //     ),
+        // )
+        // const fileName = './tests/fixtures/valid/common/common-config-2.yini'
+        // YINI.parseFile(fileName, {
+        //     strictMode: false,
+        //     failLevel: 'auto',
+        //     includeMetaData: true,
+        // })
+        // const fileName =
+        //     './tests/fixtures/invalid/bad-user-profile-config-2.yini'
+        // YINI.parseFile(fileName, {
+        //     strictMode: true,
+        //     failLevel: 'auto',
+        //     includeMetaData: true,
+        // })
     }
 }

package/dist/parseEntry.d.ts

@@ -1,2 +1,3 @@
-import { IParseMainOptions } from './core/types';
-export declare const parseMain: (yiniContent: string, options?: IParseMainOptions) => any;
+import { IParseCoreOptions, IRuntimeInfo } from './core/types';
+/** Single source of truth. */
+export declare const _parseMain: (yiniContent: string, options: IParseCoreOptions | undefined, runtimeInfo: IRuntimeInfo) => any;