yini-parser 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/tests/integration/10-special-validation-modes/validation-modes.test.js

@@ -1,38 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = __importDefault(require("../../../src"));
-const system_1 = require("../../../src/utils/system");
-/**
- * Validation modes tests.
- */
-describe('Validation modes tests:', () => {
-    test('1. Empty/missing value in non-strict mode gets null.', () => {
-        // Arrange.
-        const validYini = `^ Title
-            nullVal = null
-            empty_val =          # ← Implicit null (lenient mode)
-        `;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(!!result).toEqual(true);
-        expect(result.Title.nullVal).toEqual(null);
-        expect(result.Title.empty_val).toEqual(null);
-    });
-    test('2. Should throw on empty (missing) value in strict mode.', () => {
-        // Arrange.
-        const isStrict = true;
-        const invalidInStrict = `^ Title
-            nullVal = null
-            empty_val =          # ← ERROR: Requires explicit null (strict mode)
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidInStrict, isStrict);
-        }).toThrow();
-    });
-});

package/dist/tests/integration/2-file-structure-and-error/able to parse mixed case filenames.test.js

@@ -1,72 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const src_1 = __importDefault(require("../../../src"));
-const system_1 = require("../../../src/utils/system");
-const DIR_OF_FIXTURES = '../../fixtures/valid/single-section-member-w-mixed-casing';
-/**
- * Able to parse filename (+ext.) with mixed case tests.
- */
-describe('Able to parse filename (+ext.) with mixed case tests:', () => {
-    const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-    beforeAll(() => { });
-    test('1. Parse a value from file "single-section-member-1.yini".', () => {
-        // Arrange.
-        const fileName = 'single-section-member-1.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        // NOTE: Dry run parsing - enough that something is successfully returned.
-        expect(!!result).toEqual(true);
-        expect(result.unknownKey).toEqual(undefined);
-        expect(result.general.name).toEqual('Kim');
-    });
-    test('2. Parse a value from file "SINGLE-SECTION-MEMBER-2.YINI".', () => {
-        // Arrange.
-        const fileName = 'SINGLE-SECTION-MEMBER-2.YINI';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        // NOTE: Dry run parsing - enough that something is successfully returned.
-        expect(!!result).toEqual(true);
-        expect(result.APP.IS_DARK_THEME).toEqual(true);
-    });
-    test('3. Parse a value from file "Single-Section-Member-3.Yini".', () => {
-        // Arrange.
-        const fileName = 'Single-Section-Member-3.Yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        // NOTE: Dry run parsing - enough that something is successfully returned.
-        expect(!!result).toEqual(true);
-        expect(result.Title.Id).toEqual(46568);
-    });
-    test('4. Parse a value from file "singleSectionMember-4.yINI".', () => {
-        // Arrange.
-        const fileName = 'singleSectionMember-4.yINI';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        // NOTE: Dry run parsing - enough that something is successfully returned.
-        expect(!!result).toEqual(true);
-        expect(result.appConfig.ratio).not.toEqual(0);
-        expect(result.appConfig.ratio).not.toEqual(1);
-        expect(result.appConfig.ratio).not.toEqual(0.255);
-        expect(result.appConfig.ratio).toEqual(0.25);
-    });
-});

package/dist/tests/integration/2-file-structure-and-error/throw error on bad file extensions.test.js

@@ -1,36 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const src_1 = __importDefault(require("../../../src"));
-const system_1 = require("../../../src/utils/system");
-const DIR_OF_FIXTURES = '../../fixtures/valid/single-section-member-w-mixed-casing';
-/**
- * Throw error on invalid file extensions tests.
- */
-describe('Throw error on invalid file extensions tests:', () => {
-    const DIR_OF_FIXTURES = './fixtures/invalid';
-    const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-    test('Should throw error if invalid file extension-1.', () => {
-        // Arrange.
-        const fileName = 'invalid-file-extension-1.abcd';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-    test('Should throw error if invalid file extension-2.', () => {
-        // Arrange.
-        const fileName = 'invalid-file-extension-2.txt';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-});

package/dist/tests/integration/2-file-structure-and-error/throw error parsing bad content.test.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = __importDefault(require("../../../src"));
-const system_1 = require("../../../src/utils/system");
-const DIR_OF_FIXTURES = '../../fixtures/valid/single-section-member-w-mixed-casing';
-/**
- * Throw error when parsing bad file/inline content tests.
- */
-describe('Throw error when parsing bad file/inline content tests:', () => {
-    beforeAll(() => { });
-    beforeAll(() => {
-        (0, system_1.debugPrint)('beforeAll');
-        // const isDebug = !!process.env.IS_DEBUG
-        // if (!isDebug) {
-        //     console.log('process.env.IS_DEBUG is false, OK')
-        // } else {
-        //     console.error('process.env.IS_DEBUG is true, FAIL')
-        //     console.error(
-        //         'Detected that IS_DEBUG is true, is should be false when testing',
-        //     )
-        //     console.error('process.env.IS_DEBUG:')
-        //     console.error(process.env.IS_DEBUG)
-        //     throw Error('ERROR: A variable in ENV has wrong state')
-        // }
-    });
-    test('1. Should throw error if parsing some garbage.', () => {
-        // Arrange.
-        const fixture = `someGarbage`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('2. Should throw error if parsing nothing ("").', () => {
-        // Arrange.
-        const fixture = ''; // (!) Blank!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('3. Should throw error if parsing only whitespaces.', () => {
-        // Arrange.
-        const fixture = '      \t  \n  '; // (!) Only whitepaces!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('4. Should throw error if parsing invalid characters (£ÆŁ).', () => {
-        // Arrange.
-        const fixture = `^ sectionTitle
-            key £ÆŁ 321 // Double = is an error!`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('5. Should throw error if parsing unknown file name.', () => {
-        // Arrange.
-        const fullPath = './gibberish-file-name';
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-    test('6. Should throw error if parsing blank file name ("").', () => {
-        // Arrange.
-        const fullPath = ''; // (!) Blank!
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-});

package/dist/tests/smoke/A-general-smoke.test.js

@@ -1,259 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const src_1 = __importDefault(require("../../src"));
-const env_1 = require("../../src/config/env");
-const system_1 = require("../../src/utils/system");
-/**
- * General Smoke Tests.
- */
-describe('General Smoke Tests:', () => {
-    const DIR_OF_FIXTURES = '../fixtures/smoke-fixtures/strings-with-paths';
-    const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-    beforeAll(() => { });
-    beforeAll(() => {
-        (0, system_1.debugPrint)('beforeAll');
-        // const isDebug = !!process.env.IS_DEBUG
-        // if (!isDebug) {
-        //     console.log('process.env.IS_DEBUG is false, OK')
-        // } else {
-        //     console.error('process.env.IS_DEBUG is true, FAIL')
-        //     console.error(
-        //         'Detected that IS_DEBUG is true, is should be false when testing',
-        //     )
-        //     console.error('process.env.IS_DEBUG:')
-        //     console.error(process.env.IS_DEBUG)
-        //     throw Error('ERROR: A variable in ENV has wrong state')
-        // }
-    });
-    // Trivial test to see if everything is okey before moving on to "real" tests.
-    test('1. Trivial test case.', () => {
-        // Arrange.
-        const a = 3;
-        const b = 5;
-        // Act.
-        const result = a + b;
-        // Assert.
-        expect(result).toEqual(8);
-    });
-    test('2. Correctly parse a short YINI Example.', () => {
-        // Arrange.
-        const validYini = `^ sectionTitle
-            strVar = "Hello World!"
-            intVar = 98.21`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.sectionTitle.strVar).toEqual('Hello World!');
-        expect(result.sectionTitle.intVar).toEqual(98.21);
-    });
-    test('3. Should throw error if parsing some "garbage".', () => {
-        // Arrange.
-        const fixture = `someGarbage`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('4. Should throw error if parsing lines of "invalid" content.', () => {
-        // Arrange.
-        const fixture = `
-            古池や蛙飛び込む水の音
-            ふるいけやかわずとびこむみずのおと
-            furu ike ya kawazu tobikomu mizu no oto
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('5. Should throw error if parsing unknown file name.', () => {
-        // Arrange.
-        const fullPath = 'gibberish-path-and-file-name';
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-    test('6. Should throw error if parsing "blank" content.', () => {
-        // Arrange.
-        const fixture = ' '; // NOTE: Only a blank space!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('7. Correctly parse paths with forward slash "/".', () => {
-        // Arrange.
-        const fixture = `^ PathsWithSlash
-        path1 = '/'
-        path2 = '/etc'
-        path3 = 'etc/'
-        path4 = 'folder/subfolder'
-        path5 = '/usr/local/bin/'
-        `;
-        // Act.
-        const result = src_1.default.parse(fixture);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithSlash.path1).toEqual('/');
-        expect(result.PathsWithSlash.path2).toEqual('/etc');
-        expect(result.PathsWithSlash.path3).toEqual('etc/');
-        expect(result.PathsWithSlash.path4).toEqual('folder/subfolder');
-        expect(result.PathsWithSlash.path5).toEqual('/usr/local/bin/');
-        expect(result.PathsWithSlash.path1).not.toEqual('*');
-    });
-    test('8. Correctly parse paths with backslash "\\".', () => {
-        // Arrange.
-        const fileName = 'PathsWithBackslash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithBackslash.path1).toEqual('\\');
-        expect(result.PathsWithBackslash.path2).toEqual('\\Temp');
-        expect(result.PathsWithBackslash.path3).toEqual('Temp\\');
-        expect(result.PathsWithBackslash.path4).toEqual('Windows\\System32');
-        expect(result.PathsWithBackslash.path5).toEqual('\\Users\\Public\\Documents\\');
-        expect(result.PathsWithBackslash.path1).not.toEqual('*');
-    });
-    test('9. Correctly parse paths with quotes and forward slash "/".', () => {
-        // Arrange.
-        const fileName = 'paths-w-quotes-and-slash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithQuotesSlash.path1).toEqual("/'My Folder'/Documents/file.txt");
-        expect(result.PathsWithQuotesSlash.path2).toEqual('/"data"/set.csv');
-        expect(result.PathsWithQuotesSlash.path3).toEqual('/`Projects`/Code/'); // NOTE: Has backticks!
-        expect(result.PathsWithQuotesSlash.path1).not.toEqual('*');
-    });
-    test('10. Correctly parse paths with quotes and backslash "\\".', () => {
-        const DIR_OF_FIXTURES = '../fixtures/smoke-fixtures/strings-with-paths';
-        const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-        // Arrange.
-        const fileName = 'paths-w-quotes-and-backslash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithQuotesBackslash.path1).toEqual("\\'Program Files'\\App\\");
-        expect(result.PathsWithQuotesBackslash.path2).toEqual('\\"user name"\\Desktop\\');
-        expect(result.PathsWithQuotesBackslash.path3).toEqual('\\Projects\\\`2024\`\\"Quarter 2"\\'); // NOTE: Has backticks!
-        expect(result.PathsWithQuotesBackslash.path1).not.toEqual('*');
-    });
-    test('11. Throw error if using section repeating markers higher than supported.', () => {
-        // Arrange.
-        const fixture1 = `^ Section1
-            ^^ Section2
-            ^^^ Section3
-            ^^^^ Section4
-            ^^^^^ Section5
-            ^^^^^^ Section6 // Section 6.
-            strVar = "These section headers are valid!"
-        `;
-        const fixture2 = `^ Section1
-            ^^ Section2
-            ^^^ Section3
-            ^^^^ Section4
-            ^^^^^ Section5
-            ^^^^^^ Section6 // Section 6.
-            ^^^^^^^ Section7 // INVALID HEADER MARKER!
-            strVar = "^^^^^^^ (7) is invalid"
-        `;
-        // Act.
-        const result1 = src_1.default.parse(fixture1);
-        (0, env_1.isDebug)() && (0, system_1.printObject)(result1);
-        // Assert.
-        expect(!!result1).toEqual(true);
-        expect(result1.Section1.Section2.Section3.Section4.Section5.Section6
-            .strVar).toBe('These section headers are valid!');
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture2);
-        }).toThrow();
-    });
-    test('12. Should throw error if parsing an incorrect hash comment.', () => {
-        // Arrange.
-        const invalidYini = `^ App
-            id = 32403  #This hash comment is invalid due to a missing space.
-            title = "My Program"
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-        }).toThrow();
-    });
-    test('13. Correctly parse a YINI with a hash comment.', () => {
-        // Arrange.
-        const validYini = `^ App
-            id = 32403  # The correct app id.
-            title = "My Program"
-        `;
-        // Act.
-        (0, env_1.isDebug)() && (0, system_1.printObject)(validYini);
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.App.id).toEqual(32403);
-        expect(result.App.title).toEqual('My Program');
-    });
-    test('14. Correctly parse a YINI enclosed in comments.', () => {
-        // Arrange.
-        const validYini = `
-// This whole line is a comment.
-            ^SectionName# This part is a comment.
-            // This whole line is a comment.
-        `;
-        // Act.
-        (0, env_1.isDebug)() && (0, system_1.printObject)(validYini);
-        const result = src_1.default.parse(validYini);
-        (0, env_1.isDebug)() && (0, system_1.printObject)(result);
-        // Assert.
-        expect(result).toHaveProperty('SectionName');
-        //@todo Fix issue that the below value will correctly be {} and not undefined
-        //expect(result.SectionName).toEqual({})
-    });
-    test('15. Should throw error due to illegal section name.', () => {
-        // Arrange.
-        const invalidYini = `// Should detect illegal section name 2SubSub1!!
-        ^ App
-            ^^ SubSect
-                ^^^ 2SubSub1 // NOT OK, illegal name!
-                valueSS1 = "Something."
-                valueSS2 = OFF
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-            (0, system_1.debugPrint)(invalidYini);
-        }).toThrow();
-    });
-    test('16. Should throw error due to illegal section name.', () => {
-        // Arrange.
-        const invalidYini = `// Should detect illegal section name 2SubSub1!!
-        ^ App
-            ^^ \` lsdfkj lj\`
-                ^^^ 2SubSub1 // NOT OK, illegal name!
-                valueSS1 = "Something."
-                valueSS2 = OFF
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-            (0, system_1.debugPrint)(invalidYini);
-        }).toThrow();
-    });
-});