@stxt-lang/core 0.8.1 → 0.9.0

package/out/core/Line.d.ts

@@ -8,7 +8,10 @@ export declare class Line {
     readonly level: number;
     /** Content of the line with the indentation already removed. */
     readonly content: string;
-    /** True if the line is a comment (`#`). */
+    /**
+     * True if the line is a comment (`#`). Its indentation has already been validated like a
+     * node's (spec 9), but it produces no node and never moves the hierarchy.
+     */
     readonly isComment: boolean;
     /** True if the line is a text line belonging to an open BLOCK node (`>>`). */
     readonly isBlock: boolean;

package/out/core/LineParser.d.ts

@@ -5,7 +5,10 @@ import { Line } from "./Line";
  *
  * Indentation is one level per tab or per {@link Constants.TAB_SPACES} spaces; mixing both, using
  * a number of spaces that is not a multiple of four or going more than one level deeper than the
- * previous node are errors (spec 8.1 and 8.3).
+ * previous node are errors (spec 8.1 and 8.3). Comment lines are validated exactly like node lines
+ * (spec 9 and 11): they produce no node and never move the hierarchy, but their indentation must
+ * be homogeneous, a multiple of four when spaces, and at most one level deeper than the last node.
+ * Only empty lines are exempt.
  *
  * @param line source line, with its indentation.
  * @param lastNodeBlock true if the node currently open is a BLOCK text node.

package/out/core/LineParser.js

@@ -11,7 +11,10 @@ const Line_1 = require("./Line");
  *
  * Indentation is one level per tab or per {@link Constants.TAB_SPACES} spaces; mixing both, using
  * a number of spaces that is not a multiple of four or going more than one level deeper than the
- * previous node are errors (spec 8.1 and 8.3).
+ * previous node are errors (spec 8.1 and 8.3). Comment lines are validated exactly like node lines
+ * (spec 9 and 11): they produce no node and never move the hierarchy, but their indentation must
+ * be homogeneous, a multiple of four when spaces, and at most one level deeper than the last node.
+ * Only empty lines are exempt.
  *
  * @param line source line, with its indentation.
  * @param lastNodeBlock true if the node currently open is a BLOCK text node.
@@ -28,6 +31,7 @@ function parseLine(line, lastNodeBlock, lastLevel, numLine, validate = true) {
     let pointer = 0;
     let sawSpace = false;
     let sawTab = false;
+    let isComment = false;
     while (pointer < line.length) {
         const c = line.charAt(pointer);
         if (c === Constants_1.Constants.SPACE) {
@@ -44,7 +48,13 @@ function parseLine(line, lastNodeBlock, lastLevel, numLine, validate = true) {
             spaces = 0;
         }
         else if (c === Constants_1.Constants.COMMENT_CHAR) {
-            return new Line_1.Line(level, line.substring(pointer + 1), true, false, pointer);
+            // Comment line: produces no node, but its indentation is validated below exactly like
+            // a node's (spec 9). Reached only when the line is not block text (a '#' deeper than an
+            // open block is caught as text by the check below, before getting here), so inside an
+            // open block a comment always has indent <= the block node: the Parser closes the block
+            // (spec 9.1) and hands the comment over to the observers.
+            isComment = true;
+            break;
         }
         else {
             // First character that is not space/tab/comment => end of indentation
@@ -79,10 +89,15 @@ function parseLine(line, lastNodeBlock, lastLevel, numLine, validate = true) {
     if (validate && spaces > 0) {
         throw new ParseException_1.ParseException(numLine, "INVALID_NUMBER_SPACES", `There are ${spaces} spaces before node`);
     }
-    // Validate the level
+    // Validate the level (spec 11.3). Comments included (spec 9): lastLevel is the level of the
+    // last NODE, a comment never becomes the reference.
     if (validate && level > lastLevel + 1) {
         throw new ParseException_1.ParseException(numLine, "INDENTATION_LEVEL_NOT_VALID", `Level of indent incorrect: ${level}`);
     }
+    // Comment: the text after '#', verbatim
+    if (isComment) {
+        return new Line_1.Line(level, line.substring(pointer + 1), true, false, pointer);
+    }
     // General case: return the line without the indentation already consumed
     // Blank-only trim (spec 4): an NBSP after the value is part of it
     return new Line_1.Line(level, StringUtils_1.StringUtils.trim(line.substring(pointer)), false, false, pointer);

package/out/core/Parser.js

@@ -90,6 +90,8 @@ class Parser {
             // Parse the line
             const line = (0, LineParser_1.parseLine)(lineString, lastNodeText, lastLevel, lineNumber);
             if (line.isComment) {
+                // Its indentation was validated by parseLine like a node's (spec 9), but it never
+                // becomes the reference level: the stack (and so lastLevel) is only moved by nodes.
                 // A comment at the level of an open block node (or shallower) closes the block
                 // (spec 6.1 and 9.1): a block is a literal and cannot be commented from inside.
                 // Only the block closes; the comment does not touch the rest of the hierarchy.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stxt-lang/core",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Parser and schema validator for STXT, an indentation-based structured-text format.",
   "main": "out/all.js",
   "types": "out/all.d.ts",