yini-parser 1.0.0-beta.1 → 1.0.2-beta

package/CHANGELOG.md

@@ -1,12 +1,25 @@
 # CHANGELOG
 
-## 1.0.0-beta.1
+## 1.0.2-beta - 2025 Aug
+- Fixed issues with floats, including negative and exponential numbers with new test files here: `tests/fixed-issues/issue-32/*`
+- Fixed an issue where parseFile(..) did not output a warning when parsing a file missing a newline at EOF. Plus added test cases to check that it is fixed (in `tests/fixed-issues/issue-30`).
+- Fixed and improved number parsing to fully support negative values and edge cases for integers, floats, hex, bin, octal, duodecimal, and exponential numbers. Based on updated lexer and parser grammar files, and added extensive tests to ensure correct and robust handling. Here: `tests/integration/6-number-literals/*`
+
+## 1.0.1-beta - 2025 Aug
+- Fixed catching lexer related errors correctly.
+- Improves error and test handling for invalid YINI syntax.
+- Grammar logic updated to catch bad systax specifically related to bad syntax for (key-value) members.
+- Added another testing suite for reported and fixed tests.
+- Added another testing suite for golden tests.
+- Updated to the latest grammar (logic) version 1.0.0-rc.2.
+
+## 1.0.0-beta.1 - 2025-07-26
 - 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.
+- Updated to the latest grammar (logic) version 1.0.0-rc.1.
 
 ## 1.0.0-alpha.7
 - Fixed serious bug that on error did exit process.

package/README.md

@@ -1,6 +1,6 @@
 # YINI Parser for Node.js
 
-YINI is a clean, minimal, and human-readable config format for structured configuration. This parser implements the YINI spec in TypeScript for Node.js, with support for nested sections, strict/lenient modes, and typed values.
+A TypeScript/Node.js parser for YINI — A type-safe, structured, and human-readable config format with nested sections, types, comments, and support for strict validation.
 
 [![npm version](https://img.shields.io/npm/v/yini-parser.svg)](https://www.npmjs.com/package/yini-parser) [![All Tests](https://github.com/YINI-lang/yini-parser-typescript/actions/workflows/run-all-tests.yml/badge.svg)](https://github.com/YINI-lang/yini-parser-typescript/actions/workflows/run-all-tests.yml)
 
@@ -13,7 +13,7 @@ import YINI from 'yini-parser'
 const config = YINI.parseFile('./config.yini')
 ```
 
-A clean, minimal, human-readable config format—designed as an alternative to INI, YAML, and JSON.
+YINI (Yet another INI): YINI is a configuration format designed for readability and structure, inspired by INI and YAML.
 
 ➡️ See full [documentation or YINI format specification](https://github.com/YINI-lang/YINI-spec)
 
@@ -34,6 +34,28 @@ YINI is a simple, human-friendly configuration format inspired by INI and JSON.
 
 ---
 
+## 🙋‍♀️ Why YINI?
+- **YINI is an alternative** to other great config formats like INI, JSON, YAML, XML, and TOML — Supports section nesting and explicit syntax for configuration files.
+- **Started as a personal project and a research challenge:** Provides structure similar to INI, with features inspired by JSON and YAML.
+- **Built for clarity:**
+    * Uses a concise syntax to minimize unnecessary characters.
+    * Supports commonly used configuration structures.
+- *Developed to meet practical needs, driven by curiosity and a desire **for configuration clarity, simplicity, minimalism, and flexibility**.
+
+---
+
+## 💡 What is YINI?
+- **Simple like INI** — but with strong typing, comments, and nested sections.
+- **Provides concise, structured syntax** for configuration.
+- Supports section nesting **without requiring indentation or dot-delimited keys**.
+- This repo/parser is built for both **JavaScript and TypeScript**.
+- **Supports strict and lenient modes**, and all major data types.
+- Can be **edited manually** or **processed programmatically**.
+- 👉 See [how YINI compares with JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
+- Want the full syntax reference? See the [YINI Specification](https://github.com/YINI-lang/YINI-spec).
+  
+---
+
 ## Quick Start
 
 A minimal example using YINI in TypeScript:
@@ -71,239 +93,25 @@ false
     name: 'My Title',
     items: 25,
     darkMode: true,
-    Special: { primaryColor: 3368601, isCaching: false }
+    Special: { 
+      primaryColor: 3368601,
+      isCaching: false
+    }
   }
 }
 ```
 
 That's it!
 
-▶️ Link to [examples/](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples) files.
+- ▶️ Link to [examples/](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples) files.
+- ▶️ Link to [Demo Apps](https://github.com/YINI-lang/yini-demo-apps/tree/main) with complete basic usage.
 
-## 💡 Why YINI?
-- **Easy to read and write**, minimal syntax noise, maximum clarity.
-- **Clear and minimal section nesting** without painful indentation rules or long dot nested strings, etc.
-- A perfect alternative to messy JSON, legacy INI, or complex YAML.
-- Built for both **JavaScript and TypeScript**.
-- **Supports strict/lenient modes**, and all major data types.
-- Both **human-friendly**, and **machine-friendly**.
-- 👉 See [how YINI compares to JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
-- Want the full syntax reference? See the [YINI Specification](https://github.com/YINI-lang/YINI-spec).
-  
 ---
 
 ## Intro to YINI Config Format
+**YINI** is a simple and readable configuration format. Sections are defined with `^ SectionName`, and values are assigned using `key = value`. The format supports common data types (same as those found in JSON), including strings, numbers, booleans, nulls, and lists. 
 
-### 1. Sections
-Group settings under a named header. A section header name starts with `^`.
-
-Start a section with `^`, e.g.:
-```yini
-^ App
-title = "AppName"
-```
-
-> Alternative section markers to `^` are also supported: `<`, `§`, `€` (e.g. `< Section`).
-
-> See section 9 for more advanced marker and naming options.
-
-### 2. Key = Value
-Each line inside a section is a **key** (name) and **value**, separated by `=`.
-
-Write settings as `key = value`:
-```yini
-maxConnections = 100
-enableLogging  = true
-```
-
-> See section 9 for more advanced marker and naming options.
-
-#### 💡Tip
-Use backticks (\`) to quote section or key names that contain spaces or special characters.
-
-Key names with spaces/special characters can be backticked:
-
-```yini
- user id  = 1            # Invalid ❌
-`user id` = 1            # Valid ✅
-```
-
-### 3. Values
-Values can be:
-- **Strings** (always quoted): `'hello'` or `"world"` (either single or double quoted)
-- **Numbers:** `42`, `3.14` or `-10`
-- **Booleans:** `true`, `false`, `on`, `off`, `yes`, `no` (all case-insensitive)
-- **Nulls:** Use `null` or leave the value blank after `=` (in lenient mode)
-- **Lists:**
-  * JSON‑style: `["red", "green", "blue"]`
-  * Colon‑style: *(Planned – not yet implemented in parser)* 
-
-### 4. Comments
-Various commenting styles are supported:
-```yini
-// This is a line comment
-timeout = 30  // inline comment
-# This is also a line comment (must have a space after #)
-interval = 30  # inline comment (must have a space after #)
-/* Block comment spanning
-   multiple lines */
-; Full line comment (must be whole line).
-```
-
-> **Tip:** You can add comments anywhere—above, beside, or below any setting or section.
-> 
-👆 **Caveat 1:** If you use `#` for comments, always put a space after the `#`.
-(Otherwise, the parser might misinterpret it as part of a value.)
-
-👆 **Caveat 2:** `;` is used only for full-line comments. The `;` must be the first non-whitespace character on a line (only spaces or tabs are allowed before it).
-(If `;` appears later in the line, the parser may treat it as part of a value or as a line delimiter, not as a comment.)
-
-💡**Tip:** You can use any comment style in your file.
-For best readability, try to stick to one style per file.
-
-### 5. Nested Sections
-Use extra carets `^` for sub‑sections:
-```yini
-^ Parent
-^^ Child
-
-// Add another caret `^` and you get a sub-section
-// of the previous section, and so...
-^^^ SubChild
-```
-
-If you prefer, you can indent the nested section for visibility:
-```yini
-^ Main
-    ^^ Sub
-    host = "db.example.com"
-```
-
-One can nest multiple sections:
-```yini
-^ Root
-^^ Sub
-^^^ SubSub
-^ BackToRoot
-```
-
-Example with indented sections:
-```yini
-^ Root
-value = 'At level 1'
-    ^^ Sub
-    value = 'At level 2'
-        ^^^ SubSub
-        value = 'At level 3'
-        
-^ BackToRoot
-value = 'Back at level 1'
-```
-
-The above Yini code will produce the following JavaScript object:
-```js
-// JS object
-{
-  Root: {
-    value: 'At level 1',
-    Sub: { value: 'At level 2', SubSub: { value: 'At level 3' } }
-  },
-  BackToRoot: { value: 'Back at level 1' }
-}
-```
-
-> See section 9 for more advanced marker and naming options.
-
-### 6. Lists
-```yini
-// JSON‑style lists
-colors = ["red", "green", "blue"]
-
-numberList = [
-    10,
-    20,
-    30
-]
-
-
-// Colon‑style list
-// 👆 Colon‑style list support is planned for an upcoming release.
-fruits:
-  "Pear",
-  "Cherry",
-  "Banana"
-```
-
-> You can use either single or double quotes for string values in YINI.
-
-### 7. Document Terminator (strict mode)
-The `/END` marker is required only in strict mode, and optional in lenient (default) mode.
-
-End a file explicitly with:
-```yini
-^ App
-title = "MyTitle"
-
-/END    // Must be included in strict mode.
-```
-
-### 8. Disabled Lines
-Prefix any valid line with `--` to skip it entirely:
-```yini
---maxRetries = 5
-```
-
-### 9. Advanced: Alternative Section Markers & Naming
-In addition to the standard syntax, YINI supports several advanced options:
-
-- (a.) **Alternative section markers:**  
-  Besides `^`, you can use `<`, `§`, or `€` as section header markers.  
-  
-  ```yini
-  < MySection
-  § Settings
-  € MyApp
-  ```
-
-- (b.) **Backticked section names and key names:**  
-  Use backticks (`) to allow spaces or special characters in section or key names:
-
-  ```yini
-    ^ `Section name with spaces`
-    `user id` = 42
-  ```
-
-- (c.) **Numeric shorthand section markers:**  
-  To create deeply nested sections (beyond 6 levels), use numeric shorthand:
-
-  ```yini
-  ^7 DeepSection    # Equivalent to 7 carets: ^^^^^^^ DeepSection
-  <10 VeryDeep      # Equivalent to <<<<<<<<<<< VeryDeep
-  ```
-
-  👆 Though, can not mix standard/classic and numeric shorthand markers in the same section header.
-
-- (d.) **More features:**  
-  The YINI format supports even more features than listed here, such as additional number notations, string types, and advanced escaping. For full details, see the [latest release of the YINI specification](https://github.com/YINI-lang/YINI-spec/blob/release/YINI-Specification.md).
-
-### 10. Complete Example
-
-```yini
-@yini       # Optional marker to identify YINI format.
-
-^ App
-name    = "MyApp"
-version = "1.0.0"
-debug   = off  // Turn on for debugging.
-
-^^ Database
-host     = "db.local"
-port     = 5432
---user   = "secret"  # This line is disabled due to --.
-userList = ["alice", "bob", "carol"]
-
-/END
-```
+To learn more, see the [Getting Started: Intro to YINI Config Format](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md) tutorial.
 
 ---
 
@@ -541,12 +349,26 @@ 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)
+- ➡️ [Getting Started: Intro to YINI Config Format](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md)  
+  *Beginner-friendly walkthrough and basic usage examples.*
+
+- ➡️ [YINI Parser on npm](https://www.npmjs.com/package/yini-parser)  
+  *Install and view package details.*
+
+- ➡️ [Read the YINI Specification](https://github.com/YINI-lang/YINI-spec/blob/release/YINI-Specification.md#table-of-contents)  
+  *Full formal spec for the YINI format, including syntax and features.*
+
+- ➡️ [YINI CLI on GitHub](https://github.com/YINI-lang/yini-cli)  
+  *TypeScript source code, issue tracker, and contributing guide.*
+
+- ➡️ [YINI vs Other Formats](https://github.com/YINI-lang/YINI-spec/tree/release#-summary-difference-with-other-formats)  
+  *How does YINI differ: comparison with INI, YAML, and JSON.*
+  
+- ➡️ [Why YINI? (Project Rationale)](https://github.com/YINI-lang/YINI-spec/blob/release/RATIONALE.md)  
+  *Learn about the motivations and design decisions behind YINI.*
+
+- ➡️ [YINI Project](https://github.com/YINI-lang)  
+  *YINI home.*
 
 ---
 

package/dist/YINI.js

@@ -2,6 +2,7 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const env_1 = require("./config/env");
@@ -15,6 +16,7 @@ const print_1 = require("./utils/print");
  */
 class YINI {
 }
+_a = YINI;
 YINI.filePath = ''; // Used in error reporting.
 /**
  * Parse YINI content into a JavaScript object.
@@ -43,15 +45,11 @@ YINI.parse = (yiniContent, strictMode = false, bailSensitivity = 'auto', include
         yiniContent += '\n';
     }
     let level = 0;
-    // if (bailSensitivity === 'auto' && !strictMode) level = 0
-    // if (bailSensitivity === 'auto' && strictMode) level = 1
     if (bailSensitivity === 'auto') {
         if (!strictMode)
             level = 0;
         if (strictMode)
             level = 1;
-        if (process.env.NODE_ENV === 'test')
-            level = 1;
     }
     else {
         level = bailSensitivity;
@@ -106,38 +104,10 @@ YINI.parseFile = (filePath, strictMode = false, bailSensitivity = 'auto', includ
         content += '\n';
         hasNoNewlineAtEOF = true;
     }
-    YINI.filePath = filePath;
-    let level = 0;
-    // if (bailSensitivity === 'auto' && !strictMode) level = 0
-    // if (bailSensitivity === 'auto' && strictMode) level = 1
-    if (bailSensitivity === 'auto') {
-        if (!strictMode)
-            level = 0;
-        if (strictMode)
-            level = 1;
-        if (process.env.NODE_ENV === 'test')
-            level = 1;
-    }
-    else {
-        level = bailSensitivity;
-    }
-    const options = {
-        isStrict: strictMode,
-        bailSensitivityLevel: level,
-        isIncludeMeta: includeMetaData,
-        isWithDiagnostics: (0, env_1.isDev)() || (0, env_1.isDebug)(),
-        isWithTiming: (0, env_1.isDebug)(),
-    };
-    (0, print_1.debugPrint)();
-    (0, print_1.debugPrint)('==== Call parse ==========================');
-    const result = (0, parseEntry_1.parseMain)(content, options);
-    (0, print_1.debugPrint)('==== End call parse ==========================\n');
-    if ((0, env_1.isDev)()) {
-        console.log();
-        (0, print_1.devPrint)('YINI.parse(..): result:');
-        console.log(result);
-        (0, print_1.devPrint)('Complete result:');
-        (0, print_1.printObject)(result);
+    _a.filePath = filePath;
+    const result = _a.parse(content, strictMode, bailSensitivity, includeMetaData);
+    if (hasNoNewlineAtEOF) {
+        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/core/YINIVisitor.d.ts

@@ -1,4 +1,4 @@
-import { Boolean_literalContext, ElementContext, ElementsContext, List_in_bracketsContext, ListContext, Member_colon_listContext, MemberContext, Null_literalContext, Number_literalContext, Object_literalContext, ObjectMemberContext, ObjectMemberListContext, Section_membersContext, SectionContext, String_concatContext, String_literalContext, Terminal_lineContext, ValueContext, YiniContext } from '../grammar/YiniParser.js';
+import { Bad_memberContext, Boolean_literalContext, ElementContext, ElementsContext, List_in_bracketsContext, ListContext, Member_colon_listContext, MemberContext, Null_literalContext, Number_literalContext, Object_literalContext, ObjectMemberContext, ObjectMemberListContext, Section_membersContext, SectionContext, String_concatContext, String_literalContext, Terminal_lineContext, ValueContext, YiniContext } from '../grammar/YiniParser.js';
 import YiniParserVisitor from '../grammar/YiniParserVisitor';
 import { ErrorDataHandler } from './ErrorDataHandler';
 export type TDataType = undefined | 'String' | 'Number-Integer' | 'Number-Float' | 'Boolean' | 'Null' | 'Object' | 'List';
@@ -42,6 +42,12 @@ export default class YINIVisitor<IResult> extends YiniParserVisitor<IResult> {
      * @returns { [sectionName]: sectionObj }
      */
     visitSection: (ctx: SectionContext) => any;
+    /**
+     * Visit a parse tree produced by `YiniParser.bad_member`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitBad_member: (ctx: Bad_memberContext) => any;
     /**
      * Visit a parse tree produced by `YiniParser.terminal_line`.
      * @param ctx the parse tree

package/dist/core/YINIVisitor.js

@@ -496,6 +496,15 @@ class YINIVisitor extends YiniParserVisitor_1.default {
                 members: members,
             };
         };
+        /**
+         * Visit a parse tree produced by `YiniParser.bad_member`.
+         * @param ctx the parse tree
+         * @return the visitor result
+         */
+        this.visitBad_member = (ctx) => {
+            ctx.REST;
+            this.errorHandler.pushOrBail(ctx, 'Syntax-Error', 'Invalid or malformed member found.', `Offending text: ${ctx.getText()}`);
+        };
         /**
          * Visit a parse tree produced by `YiniParser.section_members`.
          * In here will mount object onto members object.
@@ -767,8 +776,6 @@ class YINIVisitor extends YiniParserVisitor_1.default {
         this.visitValue = (ctx) => {
             (0, env_1.isDebug)() && console.log();
             (0, print_1.debugPrint)('-> Entered visitValue(..)');
-            (0, print_1.debugPrint)('ctx.number_literal(): ' + ctx.number_literal());
-            (0, print_1.debugPrint)('ctx.boolean_literal(): ' + ctx.boolean_literal());
             if (ctx.string_literal())
                 return this.visit(ctx.string_literal());
             if (ctx.number_literal())

package/dist/grammar/YiniLexer.d.ts

@@ -46,6 +46,7 @@ export default class YiniLexer extends Lexer {
     static readonly LINE_COMMENT = 44;
     static readonly INLINE_COMMENT = 45;
     static readonly IDENT_INVALID = 46;
+    static readonly REST = 47;
     static readonly EOF: number;
     static readonly channelNames: string[];
     static readonly literalNames: (string | null)[];