links-notation 0.16.1 → 0.17.0

package/README.md

@@ -223,6 +223,35 @@ parent
     grandchild2
 ```
 
+### Multi-line Groups
+
+A parenthesized group opens a _nested context_: its body starts fresh at
+indentation level zero and follows the same rules as the root document, so a
+line break inside parentheses is structure rather than decoration.
+
+```lino
+value (
+  id "1"
+  label "one"
+)
+```
+
+The document above parses to `(value ((id 1) (label one)))` - two children, each
+a link of its own - rather than to one flat list in which the boundary between
+`id` and `label` would be lost. A body that stays on a single line still
+collapses to a single link, so `(a b c)` is unchanged.
+
+```javascript
+import { Parser, formatLinks } from 'links-notation';
+
+const links = new Parser().parse(`value (
+  id "1"
+  label "one"
+)`);
+
+console.log(formatLinks(links)); // (value ((id 1) (label one)))
+```
+
 ## API Reference
 
 ### Classes
@@ -315,5 +344,4 @@ fail the format check.
 ## Package Information
 
 - Package: `links-notation`
-- Version: 0.1.0
-- License: MIT
+- License: Unlicense (see [LICENSE](../LICENSE))

package/README.ru.md

@@ -142,6 +142,35 @@ console.log(group.format());
     внук2
 ```
 
+### Многострочные группы
+
+Скобочная группа открывает _вложенный контекст_: её тело начинается заново с
+нулевого уровня отступа и подчиняется тем же правилам, что и корень документа,
+поэтому перенос строки внутри скобок — это структура, а не оформление.
+
+```lino
+value (
+  id "1"
+  label "one"
+)
+```
+
+Документ выше разбирается в `(value ((id 1) (label one)))` — два потомка,
+каждый из которых сам является связью, — а не в один плоский список, в котором
+граница между `id` и `label` была бы потеряна. Тело, умещающееся в одну строку,
+по-прежнему сворачивается в одну связь, так что `(a b c)` не меняется.
+
+```javascript
+import { Parser, formatLinks } from 'links-notation';
+
+const links = new Parser().parse(`value (
+  id "1"
+  label "one"
+)`);
+
+console.log(formatLinks(links)); // (value ((id 1) (label one)))
+```
+
 ## Справочник API
 
 ### Классы
@@ -186,5 +215,4 @@ console.log(group.format());
 ## Информация о пакете
 
 - Пакет: `links-notation`
-- Версия: 0.1.0
-- Лицензия: MIT
+- Лицензия: Unlicense (см. [LICENSE](../LICENSE))

package/dist/index.js

@@ -149,13 +149,13 @@ class Link {
     if (options.shouldIndentByRefCount(this.values.length)) {
       shouldIndent = true;
     } else {
-      const valuesStr2 = this.values.map((v) => this.formatValue(v)).join(" ");
+      const valuesStr = this.values.map((v) => this.formatValue(v)).join(" ");
       let testLine;
       if (this.id !== null) {
-        const idStr2 = Link.escapeReference(this.id);
-        testLine = options.lessParentheses ? `${idStr2}: ${valuesStr2}` : `(${idStr2}: ${valuesStr2})`;
+        const idStr = Link.escapeReference(this.id);
+        testLine = options.lessParentheses ? `${idStr}: ${valuesStr}` : `(${idStr}: ${valuesStr})`;
       } else {
-        testLine = options.lessParentheses ? valuesStr2 : `(${valuesStr2})`;
+        testLine = options.lessParentheses ? valuesStr : `(${valuesStr})`;
       }
       if (options.shouldIndentByLength(testLine)) {
         shouldIndent = true;
@@ -181,8 +181,8 @@ class Link {
   }
   _formatIndented(options) {
     if (this.id === null) {
-      const lines2 = this.values.map((v) => options.indentString + this.formatValue(v));
-      return lines2.join(`
+      const lines = this.values.map((v) => options.indentString + this.formatValue(v));
+      return lines.join(`
 `);
     }
     const idStr = Link.escapeReference(this.id);
@@ -282,7 +282,7 @@ class peg$SyntaxError extends SyntaxError {
     let str = "Error: " + this.message;
     if (this.location) {
       let src = null;
-      const st = sources.find((s2) => s2.source === this.location.source);
+      const st = sources.find((s) => s.source === this.location.source);
       if (st) {
         src = st.text.split(/\r\n|\n|\r/g);
       }
@@ -345,8 +345,8 @@ class peg$SyntaxError extends SyntaxError {
     function describeExpectation(expectation) {
       return DESCRIBE_EXPECTATION_FNS[expectation.type](expectation);
     }
-    function describeExpected(expected2) {
-      const descriptions = expected2.map(describeExpectation);
+    function describeExpected(expected) {
+      const descriptions = expected.map(describeExpectation);
       descriptions.sort();
       if (descriptions.length > 0) {
         let j = 1;
@@ -367,8 +367,8 @@ class peg$SyntaxError extends SyntaxError {
           return descriptions.slice(0, -1).join(", ") + ", or " + descriptions[descriptions.length - 1];
       }
     }
-    function describeFound(found2) {
-      return found2 ? '"' + literalEscape(found2) + '"' : "end of input";
+    function describeFound(found) {
+      return found ? '"' + literalEscape(found) + '"' : "end of input";
     }
     return "Expected " + describeExpected(expected) + " but " + describeFound(found) + " found.";
   }
@@ -597,13 +597,13 @@ function peg$parse(input, options) {
   function location() {
     return peg$computeLocation(peg$savedPos, peg$currPos);
   }
-  function expected(description, location2) {
-    location2 = location2 !== undefined ? location2 : peg$computeLocation(peg$savedPos, peg$currPos);
-    throw peg$buildStructuredError([peg$otherExpectation(description)], input.substring(peg$savedPos, peg$currPos), location2);
+  function expected(description, location) {
+    location = location !== undefined ? location : peg$computeLocation(peg$savedPos, peg$currPos);
+    throw peg$buildStructuredError([peg$otherExpectation(description)], input.substring(peg$savedPos, peg$currPos), location);
   }
-  function error(message, location2) {
-    location2 = location2 !== undefined ? location2 : peg$computeLocation(peg$savedPos, peg$currPos);
-    throw peg$buildSimpleError(message, location2);
+  function error(message, location) {
+    location = location !== undefined ? location : peg$computeLocation(peg$savedPos, peg$currPos);
+    throw peg$buildSimpleError(message, location);
   }
   function peg$getUnicode(pos = peg$currPos) {
     const cp = input.codePointAt(pos);
@@ -612,8 +612,8 @@ function peg$parse(input, options) {
     }
     return String.fromCodePoint(cp);
   }
-  function peg$literalExpectation(text2, ignoreCase) {
-    return { type: "literal", text: text2, ignoreCase };
+  function peg$literalExpectation(text, ignoreCase) {
+    return { type: "literal", text, ignoreCase };
   }
   function peg$classExpectation(parts, inverted, ignoreCase, unicode) {
     return { type: "class", parts, inverted, ignoreCase, unicode };
@@ -657,7 +657,7 @@ function peg$parse(input, options) {
       return details;
     }
   }
-  function peg$computeLocation(startPos, endPos, offset2) {
+  function peg$computeLocation(startPos, endPos, offset) {
     const startPosDetails = peg$computePosDetails(startPos);
     const endPosDetails = peg$computePosDetails(endPos);
     const res = {
@@ -673,13 +673,13 @@ function peg$parse(input, options) {
         column: endPosDetails.column
       }
     };
-    if (offset2 && peg$source && typeof peg$source.offset === "function") {
+    if (offset && peg$source && typeof peg$source.offset === "function") {
       res.start = peg$source.offset(res.start);
       res.end = peg$source.offset(res.end);
     }
     return res;
   }
-  function peg$fail(expected2) {
+  function peg$fail(expected) {
     if (peg$currPos < peg$maxFailPos) {
       return;
     }
@@ -687,13 +687,13 @@ function peg$parse(input, options) {
       peg$maxFailPos = peg$currPos;
       peg$maxFailExpected = [];
     }
-    peg$maxFailExpected.push(expected2);
+    peg$maxFailExpected.push(expected);
   }
-  function peg$buildSimpleError(message, location2) {
-    return new peg$SyntaxError(message, null, null, location2);
+  function peg$buildSimpleError(message, location) {
+    return new peg$SyntaxError(message, null, null, location);
   }
-  function peg$buildStructuredError(expected2, found, location2) {
-    return new peg$SyntaxError(peg$SyntaxError.buildMessage(expected2, found), expected2, found, location2);
+  function peg$buildStructuredError(expected, found, location) {
+    return new peg$SyntaxError(peg$SyntaxError.buildMessage(expected, found), expected, found, location);
   }
   function peg$parsedocument() {
     let s0, s1, s2, s3, s4, s5;
@@ -2086,9 +2086,9 @@ class Parser {
     if (pathElements.length === 0)
       return current;
     if (pathElements.length === 1) {
-      const combined2 = new Link(null, [pathElements[0], current]);
-      combined2._isFromPathCombination = true;
-      return combined2;
+      const combined = new Link(null, [pathElements[0], current]);
+      combined._isFromPathCombination = true;
+      return combined;
     }
     const parentPath = pathElements.slice(0, -1);
     const lastElement = pathElements[pathElements.length - 1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "links-notation",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "description": "Links Notation parser for JavaScript",
   "main": "dist/index.js",
   "types": "index.d.ts",