@stxt-lang/core 0.11.1 → 0.13.0

package/out/core/LineParser.d.ts

@@ -12,7 +12,7 @@ import { Line } from "./Line";
  *
  * @param line source line, with its indentation.
  * @param lastNodeBlock true if the node currently open is a BLOCK text node.
- * @param lastLevel indentation level of the node currently open.
+ * @param lastLevel indentation level of the node currently open, -1 when there is none.
  * @param numLine line number, for the error messages.
  * @param validate false to split the line without enforcing the indentation rules.
  * @returns the line already split into indentation and content.

package/out/core/LineParser.js

@@ -18,7 +18,7 @@ const Line_1 = require("./Line");
  *
  * @param line source line, with its indentation.
  * @param lastNodeBlock true if the node currently open is a BLOCK text node.
- * @param lastLevel indentation level of the node currently open.
+ * @param lastLevel indentation level of the node currently open, -1 when there is none.
  * @param numLine line number, for the error messages.
  * @param validate false to split the line without enforcing the indentation rules.
  * @returns the line already split into indentation and content.

package/out/core/Parser.js

@@ -86,7 +86,9 @@ class Parser {
         try {
             const lastNode = stack.length === 0 ? null : stack[stack.length - 1];
             // The stack holds the open nodes, one per level: its size is the level of the next line's parent
-            const lastLevel = lastNode ? stack.length - 1 : 0;
+            // With no open node the reference level is -1 (spec 8.3): the first line of the
+            // document, and the first after every node has been closed, must be at level 0.
+            const lastLevel = lastNode ? stack.length - 1 : -1;
             const lastNodeText = lastNode instanceof TextNode_1.TextNode;
             // Parse the line
             const line = (0, LineParser_1.parseLine)(lineString, lastNodeText, lastLevel, lineNumber);

package/out/runtime/Formatter.d.ts

@@ -46,8 +46,9 @@ export interface FormatResult {
  *   new style; the remainder only survives in documents with errors, which this conversion
  *   neither repairs nor hides.
  *
- * The result is idempotent, round-trips between the two styles, and produces the same canonical
- * tree (STXT-TREE-SPEC) as the source. The document is parsed without any schema: formatting
+ * These are the rules of STXT-TREE-SPEC 12 (`stxt-impl/core/formatter.txt`). The result is
+ * idempotent, round-trips between the two styles, and produces the same canonical tree as the
+ * source; an initial BOM is removed. The document is parsed without any schema: formatting
  * has nothing to do with validation.
  */
 export declare class Formatter {

package/out/runtime/Formatter.js

@@ -37,8 +37,9 @@ const NodeWriter_1 = require("./NodeWriter");
  *   new style; the remainder only survives in documents with errors, which this conversion
  *   neither repairs nor hides.
  *
- * The result is idempotent, round-trips between the two styles, and produces the same canonical
- * tree (STXT-TREE-SPEC) as the source. The document is parsed without any schema: formatting
+ * These are the rules of STXT-TREE-SPEC 12 (`stxt-impl/core/formatter.txt`). The result is
+ * idempotent, round-trips between the two styles, and produces the same canonical tree as the
+ * source; an initial BOM is removed. The document is parsed without any schema: formatting
  * has nothing to do with validation.
  */
 class Formatter {
@@ -51,6 +52,10 @@ class Formatter {
      * @returns the formatted text and the syntax errors found; see {@link FormatResult}.
      */
     static format(text, style = NodeWriter_1.IndentStyle.TABS) {
+        // STXT-TREE-SPEC 12.1: an initial BOM is not kept
+        if (text.startsWith("\uFEFF")) {
+            text = text.substring(1);
+        }
         const sourceLines = new SourceLines();
         const parser = new Parser_1.Parser();
         parser.registerObserver(sourceLines);

package/out/runtime/NodeWriter.d.ts

@@ -25,6 +25,13 @@ export declare class NodeWriter {
      * @returns the documents serialized to STXT text.
      */
     static toSTXTDocs(docs: ReadonlyArray<Node>, style?: IndentStyle): string;
+    /**
+     * Writes one node and, recursively, its children, in the canonical text form of
+     * STXT-TREE-SPEC 11.1.
+     *
+     * @param parentNs effective namespace of the parent, "" for a root: the namespace is
+     *        declared only where it changes (rule 3), wherever the source declared it.
+     */
     private static writeNode;
     private static indent;
 }

package/out/runtime/NodeWriter.js

@@ -23,7 +23,7 @@ class NodeWriter {
      */
     static toSTXT(node, style = IndentStyle.TABS) {
         const out = [];
-        NodeWriter.writeNode(out, node, 0, style);
+        NodeWriter.writeNode(out, node, 0, style, "");
         return out.join("");
     }
     /**
@@ -39,17 +39,22 @@ class NodeWriter {
             if (i > 0) {
                 out.push("\n");
             }
-            NodeWriter.writeNode(out, docs[i], 0, style);
+            NodeWriter.writeNode(out, docs[i], 0, style, "");
         }
         return out.join("");
     }
-    static writeNode(out, n, depth, style) {
+    /**
+     * Writes one node and, recursively, its children, in the canonical text form of
+     * STXT-TREE-SPEC 11.1.
+     *
+     * @param parentNs effective namespace of the parent, "" for a root: the namespace is
+     *        declared only where it changes (rule 3), wherever the source declared it.
+     */
+    static writeNode(out, n, depth, style, parentNs) {
         NodeWriter.indent(out, depth, style);
-        // The namespace is written where the node declares it; inherited ones are implicit,
-        // exactly as in the source (the effective namespace is the same either way)
-        const ns = n.getDeclaredNamespace();
+        const ns = n.getNamespace();
         out.push(n.getName());
-        if (ns.length > 0) {
+        if (ns !== parentNs) {
             out.push(" (", ns, ")");
         }
         if (n instanceof TextNode_1.TextNode) {
@@ -67,7 +72,7 @@ class NodeWriter {
             }
             out.push("\n");
             for (const child of n.getChildren()) {
-                NodeWriter.writeNode(out, child, depth + 1, style);
+                NodeWriter.writeNode(out, child, depth + 1, style, ns);
             }
         }
     }

package/package.json

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