@ts-graphviz/ast 3.0.7 → 3.0.8

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @ts-graphviz/ast
 
+## 3.0.8
+
+### Patch Changes
+
+- [#1763](https://github.com/ts-graphviz/ts-graphviz/pull/1763) [`24cc46e`](https://github.com/ts-graphviz/ts-graphviz/commit/24cc46ebf0078440fa498f89b21e7224725c16b6) Thanks [@kamiazya](https://github.com/kamiazya)! - Options are read from their own properties only, and values are always written as DOT text:
+
+  - `toStream` / `toFile`, `parse`, `stringify`, `fromModel` / `toModel`, `fromDot` and `toDot` read only the options their caller set. `toStream` / `toFile` also pass Node.js only the options and environment they set.
+  - Attribute keys and values, IDs, ports, compass points and comments are written so that DOT reads them back as the same text. A string of the form `<…>` is written as an HTML-like label only when it is well-formed; otherwise it is written as a quoted string.
+  - Writing attribute values and reading block comments are faster on large inputs.
+
 ## 3.0.7
 
 ### Patch Changes

package/README.md

@@ -22,7 +22,7 @@ This package contains the module for processing the DOT language at the **A**bst
 
 [![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=GitHub&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
 [![npm](https://img.shields.io/badge/-npm-CB3837?logo=npm&style=flat)](https://www.npmjs.com/package/ts-graphviz)
-[![Reference](https://img.shields.io/badge/-API_Reference-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
+[![Reference](https://img.shields.io/badge/-API_Reference-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/api/)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ts-graphviz/ts-graphviz)
 
 [![Sponsor](https://img.shields.io/badge/-GitHub%20Sponsor-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/ts-graphviz)
@@ -175,6 +175,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="http://www.walterra.dev"><img src="https://avatars.githubusercontent.com/u/230104?v=4?s=100" width="100px;" alt="Walter Rafelsberger"/><br /><sub><b>Walter Rafelsberger</b></sub></a><br /><a href="#question-walterra" title="Answering Questions">💬</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/grsjst"><img src="https://avatars.githubusercontent.com/u/4739018?v=4?s=100" width="100px;" alt="grsjst"/><br /><sub><b>grsjst</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Agrsjst" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/stephenirven"><img src="https://avatars.githubusercontent.com/u/4293560?v=4?s=100" width="100px;" alt="Steve"/><br /><sub><b>Steve</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Astephenirven" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/btomaj"><img src="https://avatars.githubusercontent.com/u/2638986?v=4?s=100" width="100px;" alt="poetry by"/><br /><sub><b>poetry by</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Abtomaj" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

package/lib/ast.js

@@ -1,4 +1,15 @@
 import { isNodeModel, isForwardRefNode, createModelsContext } from "@ts-graphviz/common";
+function ownOptions(options) {
+  const own = /* @__PURE__ */ Object.create(null);
+  if (options != null) {
+    const descriptors = Object.getOwnPropertyDescriptors(options);
+    for (const key of Object.getOwnPropertyNames(descriptors)) {
+      const descriptor = descriptors[key];
+      own[key] = "value" in descriptor ? descriptor.value : descriptor.get?.call(options);
+    }
+  }
+  return own;
+}
 class ASTNodeCountExceededError extends Error {
   /**
    * Constructor
@@ -22,7 +33,8 @@ class Builder {
    */
   constructor(options) {
     this.options = options;
-    this.maxNodes = options?.maxASTNodes ?? DEFAULT_MAX_AST_NODES;
+    this.options = ownOptions(options);
+    this.maxNodes = this.options.maxASTNodes ?? DEFAULT_MAX_AST_NODES;
   }
   nodeCount = 0;
   maxNodes;
@@ -465,7 +477,7 @@ function peg$parse(input, options) {
       "Comment",
       {
         kind: "Block",
-        value: dedent(v.join("").replace(/[ \t]*\*/g, ""))
+        value: dedent(v.join("").replace(/^[ \t]*\*/gm, ""))
       },
       []
     );
@@ -2700,8 +2712,10 @@ function peg$parse(input, options) {
     const matches = str.match(/\n([\t ]+|(?!\s).)/g);
     if (matches) {
       const indentLengths = matches.map((match) => match.match(/[\t ]/g)?.length ?? 0);
+      let indent = Infinity;
+      for (const length of indentLengths) if (length < indent) indent = length;
       const pattern = new RegExp(`
-[	 ]{${Math.min(...indentLengths)}}`, "g");
+[	 ]{${indent}}`, "g");
       return str.replace(pattern, "\n");
     }
     return str;
@@ -2763,7 +2777,7 @@ function parse(input, options) {
     maxEdgeChainDepth,
     maxInputSize,
     maxASTNodes
-  } = options ?? {};
+  } = ownOptions(options);
   const inputSizeLimit = maxInputSize ?? DEFAULT_MAX_INPUT_SIZE;
   if (inputSizeLimit > 0) {
     const inputBytes = new TextEncoder().encode(input).length;
@@ -2830,13 +2844,13 @@ const AttributePrintPlugin = {
 };
 const ZERO_WIDTH_SPACE = "​";
 function escapeComment(value, kind) {
-  let escaped = value.replace(/\0/g, "");
+  let escaped = String(value).replace(/\0/g, "");
   if (kind === "Block") {
     escaped = escaped.replace(/\*\//g, `*${ZERO_WIDTH_SPACE}/`);
   }
   return escaped;
 }
-const EOL_PATTERN = /\r?\n/;
+const EOL_PATTERN = /\r\n|\r|\n/;
 const paddingMap = {
   Block: " * ",
   Macro: "# ",
@@ -2910,14 +2924,27 @@ const GraphPrintPlugin = {
     yield "}";
   }
 };
-const escape = (value) => value.replace(/\0/g, "").replace(/(?<!\\)"|[\r\n]/g, escapeReplacer);
-const escapeMap = {
-  "\r": String.raw`\r`,
-  "\n": String.raw`\n`,
-  '"': String.raw`\"`
-};
-function escapeReplacer(match) {
-  return escapeMap[match];
+function escape(value) {
+  const text = String(value);
+  let out = "";
+  let backslashes = 0;
+  for (const ch of text) {
+    if (ch === "\0") continue;
+    if (ch === "\\") {
+      backslashes++;
+      out += ch;
+      continue;
+    }
+    if (ch === "\n" || ch === "\r") {
+      if (backslashes % 2 === 1) out += "\\";
+      out += ch === "\n" ? String.raw`\n` : String.raw`\r`;
+    } else {
+      if (ch === '"' && backslashes % 2 === 0) out += "\\";
+      out += ch;
+    }
+    backslashes = 0;
+  }
+  return backslashes % 2 === 1 ? `${out}\\` : out;
 }
 const LiteralPrintPlugin = {
   match(ast) {
@@ -2971,11 +2998,11 @@ const NodeRefPrintPlugin = {
   },
   *print(context, ast) {
     yield* context.print(ast.id);
-    if (ast.port) {
+    if (Object.hasOwn(ast, "port") && ast.port) {
       yield ":";
       yield* context.print(ast.port);
     }
-    if (ast.compass) {
+    if (Object.hasOwn(ast, "compass") && ast.compass) {
       yield ":";
       yield* context.print(ast.compass);
     }
@@ -3017,6 +3044,7 @@ class Printer {
    */
   constructor(options = {}) {
     this.options = options;
+    this.options = ownOptions(options);
   }
   /** @internal */
   #plugins = [...defaultPlugins$2];
@@ -3090,15 +3118,32 @@ function stringify(ast, options) {
   }
   return result;
 }
+function isBalancedMarkup(markup) {
+  let depth = 0;
+  for (const ch of markup) {
+    if (ch === "<") depth++;
+    else if (ch === ">" && --depth < 0) return false;
+  }
+  return depth === 0 && !markup.includes("\0");
+}
+function keyLiteral(createElement2, key) {
+  const bare = typeof key === "string" && /^[A-Za-z_][A-Za-z0-9_]*$/.test(key) && !/^(?:node|edge|graph|digraph|subgraph|strict)$/i.test(key);
+  return createElement2(
+    "Literal",
+    { value: key, quoted: !bare },
+    []
+  );
+}
+const NUMERAL = /^-?(?:\.\d+|\d+(?:\.\d*)?)$/;
 function convertAttribute(createElement2, key, value) {
   if (typeof value === "string") {
     const trimmed = value.trim();
-    const isHTMLLike = /^<.+>$/ms.test(trimmed);
+    const isHTMLLike = trimmed.length > 2 && trimmed.startsWith("<") && trimmed.endsWith(">") && isBalancedMarkup(trimmed.slice(1, -1));
     if (isHTMLLike) {
       return createElement2(
         "Attribute",
         {
-          key: createElement2("Literal", { value: key, quoted: false }, []),
+          key: keyLiteral(createElement2, key),
           value: createElement2(
             "Literal",
             { value: trimmed.slice(1, -1), quoted: "html" },
@@ -3111,21 +3156,19 @@ function convertAttribute(createElement2, key, value) {
     return createElement2(
       "Attribute",
       {
-        key: createElement2("Literal", { value: key, quoted: false }, []),
+        key: keyLiteral(createElement2, key),
         value: createElement2("Literal", { value, quoted: true }, [])
       },
       []
     );
   }
+  const text = String(value);
+  const bare = typeof value === "boolean" || typeof value === "number" && NUMERAL.test(text);
   return createElement2(
     "Attribute",
     {
-      key: createElement2("Literal", { value: key, quoted: false }, []),
-      value: createElement2(
-        "Literal",
-        { value: String(value), quoted: false },
-        []
-      )
+      key: keyLiteral(createElement2, key),
+      value: createElement2("Literal", { value: text, quoted: !bare }, [])
     },
     []
   );
@@ -3209,6 +3252,9 @@ const AttributeListPlugin = {
     );
   }
 };
+function ownField(target, field) {
+  return Object.hasOwn(target, field) ? target[field] : void 0;
+}
 const EdgePlugin$1 = {
   match(model) {
     return model.$$type === "Edge";
@@ -3247,18 +3293,18 @@ const EdgePlugin$1 = {
                   },
                   []
                 ),
-                port: target.port ? createElement2(
+                port: ownField(target, "port") ? createElement2(
                   "Literal",
                   {
-                    value: target.port,
+                    value: ownField(target, "port"),
                     quoted: true
                   },
                   []
                 ) : void 0,
-                compass: target.compass ? createElement2(
+                compass: ownField(target, "compass") ? createElement2(
                   "Literal",
                   {
-                    value: target.compass,
+                    value: ownField(target, "compass"),
                     quoted: true
                   },
                   []
@@ -3298,18 +3344,18 @@ const EdgePlugin$1 = {
                     },
                     []
                   ),
-                  port: n.port ? createElement2(
+                  port: ownField(n, "port") ? createElement2(
                     "Literal",
                     {
-                      value: n.port,
+                      value: ownField(n, "port"),
                       quoted: true
                     },
                     []
                   ) : void 0,
-                  compass: n.compass ? createElement2(
+                  compass: ownField(n, "compass") ? createElement2(
                     "Literal",
                     {
-                      value: n.compass,
+                      value: ownField(n, "compass"),
                       quoted: true
                     },
                     []
@@ -3428,6 +3474,7 @@ const defaultPlugins$1 = [
 class FromModelConverter {
   constructor(options = {}) {
     this.options = options;
+    this.options = ownOptions(options);
   }
   /** @hidden */
   #plugins = [...defaultPlugins$1];
@@ -3512,21 +3559,20 @@ function collectAttributes(attrs) {
     return acc;
   }, {});
 }
+function toEdgeTarget(t) {
+  return {
+    id: t.id.value,
+    port: Object.hasOwn(t, "port") ? t.port?.value : void 0,
+    compass: Object.hasOwn(t, "compass") ? t.compass?.value : void 0
+  };
+}
 function convertToEdgeTargetTuple(edge) {
   return edge.targets.map((t) => {
     switch (t.type) {
       case "NodeRef":
-        return {
-          id: t.id.value,
-          port: t.port?.value,
-          compass: t.compass?.value
-        };
+        return toEdgeTarget(t);
       case "NodeRefGroup":
-        return t.children.map((t2) => ({
-          id: t2.id.value,
-          port: t2.port?.value,
-          compass: t2.compass?.value
-        }));
+        return t.children.map(toEdgeTarget);
     }
   });
 }
@@ -3647,6 +3693,7 @@ const defaultPlugins = [
 class ToModelConverter {
   constructor(options = {}) {
     this.options = options;
+    this.options = ownOptions(options);
   }
   /** @hidden */
   plugins = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-graphviz/ast",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "Graphviz AST(Abstract Syntax Tree) Utilities",
   "keywords": [],
   "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",