ts-graphviz 1.5.5-dev.bdbba8a60 → 1.5.5

package/README.md

@@ -545,6 +545,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/murawakimitsuhiro"><img src="https://avatars.githubusercontent.com/u/13833242?v=4?s=100" width="100px;" alt="mrwk"/><br /><sub><b>mrwk</b></sub></a><br /><a href="#question-murawakimitsuhiro" title="Answering Questions">💬</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/svdvonde"><img src="https://avatars.githubusercontent.com/u/2751783?v=4?s=100" width="100px;" alt="svdvonde"/><br /><sub><b>svdvonde</b></sub></a><br /><a href="#question-svdvonde" title="Answering Questions">💬</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/seethroughdev"><img src="https://avatars.githubusercontent.com/u/203779?v=4?s=100" width="100px;" alt="Adam"/><br /><sub><b>Adam</b></sub></a><br /><a href="#question-seethroughdev" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trevor-scheer"><img src="https://avatars.githubusercontent.com/u/29644393?v=4?s=100" width="100px;" alt="Trevor Scheer"/><br /><sub><b>Trevor Scheer</b></sub></a><br /><a href="#a11y-trevor-scheer" title="Accessibility">️️️️♿️</a></td>
     </tr>
   </tbody>
 </table>

package/lib/adapter/browser/index.cjs

@@ -1,20 +1,9 @@
 'use strict';
 
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */
 const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 function toStream(dot, options) {
   throw new Error(ERROR_MESSAGE);
 }
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 function toFile(dot, path, options) {
   throw new Error(ERROR_MESSAGE);
 }

package/lib/adapter/browser/index.js

@@ -1,18 +1,7 @@
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */
 const ERROR_MESSAGE = 'This module cannot be run in a browser.';
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 function toStream(dot, options) {
   throw new Error(ERROR_MESSAGE);
 }
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 function toFile(dot, path, options) {
   throw new Error(ERROR_MESSAGE);
 }

package/lib/adapter/deno/mod.js

@@ -1,9 +1,9 @@
-import { commandBuilder } from '../utils/index.js';
+import { createCommandAndArgs } from '../utils/index.js';
 /**
  * Execute the Graphviz dot command and make a Stream of the results.
  */
 export async function toStream(dot, options) {
-  const [command, args] = commandBuilder(options);
+  const [command, args] = createCommandAndArgs(options);
   const cp = new Deno.Command(command, {
     args: args,
     stdin: 'piped',

package/lib/adapter/node/index.cjs

@@ -6,21 +6,12 @@ var index_js = require('../utils/index.cjs');
 var node_util = require('node:util');
 var node_fs = require('node:fs');
 
-/**
- * NOTE:
- * The node:stream/promises standard module is not provided in Node 14.
- * Fix Node 14 to use node:stream/promises after LTS ends.
- */
 const pipeline = node_util.promisify(node_stream.pipeline);
 
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 async function toStream(dot, options) {
-  const [command, args] = index_js.commandBuilder(options ?? {});
+  const [command, args] = index_js.createCommandAndArgs(options ?? {});
   return new Promise(async function toStreamInternal(resolve, reject) {
     const p = node_child_process.spawn(command, args, { stdio: 'pipe' });
-    // error handling
     p.on('error', (e) => {
       reject(
         new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
@@ -45,9 +36,6 @@ async function toStream(dot, options) {
   });
 }
 
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 async function toFile(dot, path, options) {
   const stream = await toStream(dot, options);
   await pipeline(stream, node_fs.createWriteStream(path));

package/lib/adapter/node/index.js

@@ -1,24 +1,15 @@
 import { pipeline as pipeline$1, PassThrough, Readable } from 'node:stream';
 import { spawn } from 'node:child_process';
-import { commandBuilder } from '../utils/index.js';
+import { createCommandAndArgs } from '../utils/index.js';
 import { promisify } from 'node:util';
 import { createWriteStream } from 'node:fs';
 
-/**
- * NOTE:
- * The node:stream/promises standard module is not provided in Node 14.
- * Fix Node 14 to use node:stream/promises after LTS ends.
- */
 const pipeline = promisify(pipeline$1);
 
-/**
- * Execute the Graphviz dot command and make a Stream of the results.
- */
 async function toStream(dot, options) {
-  const [command, args] = commandBuilder(options ?? {});
+  const [command, args] = createCommandAndArgs(options ?? {});
   return new Promise(async function toStreamInternal(resolve, reject) {
     const p = spawn(command, args, { stdio: 'pipe' });
-    // error handling
     p.on('error', (e) => {
       reject(
         new Error(`Command "${command}" failed.\nMESSAGE:${e.message}`, {
@@ -43,9 +34,6 @@ async function toStream(dot, options) {
   });
 }
 
-/**
- * Execute the Graphviz dot command and output the results to a file.
- */
 async function toFile(dot, path, options) {
   const stream = await toStream(dot, options);
   await pipeline(stream, createWriteStream(path));

package/lib/adapter/types/index.d.ts

@@ -7,6 +7,9 @@ import {
 
 type Format = 'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'dot' | 'plain' | 'dot_json';
 type Layout = 'dot' | 'neato' | 'fdp' | 'sfdp' | 'circo' | 'twopi' | 'nop' | 'nop2' | 'osage' | 'patchwork';
+/**
+ * NeatoOptions interface provides options for the neato layout.
+ */
 interface NeatoOptions {
   layout: 'neato';
   /**
@@ -18,6 +21,9 @@ interface NeatoOptions {
    */
   reduce?: boolean;
 }
+/**
+ * FdpOptions interface provides options for the fdp layout.
+ */
 interface FdpOptions {
   layout: 'fdp';
   /**
@@ -49,6 +55,12 @@ interface FdpOptions {
    */
   temperature?: number;
 }
+/**
+ * @description
+ * This interface describes an optional parameter called "layout" which is used to set a layout engine.
+ * The default value for this parameter is 'dot', and it must be an option of the Layout type,
+ * excluding 'neato' and 'fdp'.
+ */
 interface OtherOptions {
   /**
    * Set layout engine.
@@ -57,6 +69,9 @@ interface OtherOptions {
    */
   layout?: Exclude<Layout, 'neato' | 'fdp'>;
 }
+/**
+ * This interface represents the CommonOptions for setting output format.
+ */
 interface CommonOptions {
   /**
    * Set output format.

package/lib/adapter/utils/index.cjs

@@ -10,7 +10,7 @@ function escapeValue(value) {
   }
   return '';
 }
-function* args(options) {
+function* createCommandArgs(options) {
   const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
   if (suppressWarnings) yield '-q';
   yield `-T${format}`;
@@ -50,8 +50,9 @@ function* args(options) {
     }
   }
 }
-function commandBuilder(options) {
-  return [options.dotCommand ?? 'dot', Array.from(args(options))];
+
+function createCommandAndArgs(options) {
+  return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
 }
 
-exports.commandBuilder = commandBuilder;
+exports.createCommandAndArgs = createCommandAndArgs;

package/lib/adapter/utils/index.d.ts

@@ -1,5 +1,11 @@
 import { Layout, Options } from '../types/index.js';
 
-declare function commandBuilder<T extends Layout>(options: Options<T>): [command: string, args: string[]];
+/**
+ * createCommandAndArgs creates a command and an array of arguments, based on the given {@link Options}.
+ *
+ * @param options Options to create the command and args from.
+ * @returns A tuple containing the command and an array of arguments.
+ */
+declare function createCommandAndArgs<T extends Layout>(options: Options<T>): [command: string, args: string[]];
 
-export { commandBuilder };
+export { createCommandAndArgs };

package/lib/adapter/utils/index.js

@@ -8,7 +8,7 @@ function escapeValue(value) {
   }
   return '';
 }
-function* args(options) {
+function* createCommandArgs(options) {
   const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
   if (suppressWarnings) yield '-q';
   yield `-T${format}`;
@@ -48,8 +48,9 @@ function* args(options) {
     }
   }
 }
-function commandBuilder(options) {
-  return [options.dotCommand ?? 'dot', Array.from(args(options))];
+
+function createCommandAndArgs(options) {
+  return [options.dotCommand ?? 'dot', Array.from(createCommandArgs(options))];
 }
 
-export { commandBuilder };
+export { createCommandAndArgs };

package/lib/ast/index.cjs

@@ -3,19 +3,14 @@
 var index_js = require('../utils/index.cjs');
 var index_js$1 = require('../common/index.cjs');
 
-/**
- * @group Create AST
- */
 class Builder {
   options;
-  /** @internal */
   getLocation() {
     return this.options?.locationFunction?.() ?? null;
   }
   constructor(options) {
     this.options = options;
   }
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   createElement(type, props, children) {
     return {
       ...props,
@@ -26,9 +21,6 @@ class Builder {
   }
 }
 
-/**
- * @group Create AST
- */
 const createElement = Builder.prototype.createElement.bind(new Builder());
 
 const EOL = /\r?\n/;
@@ -265,12 +257,8 @@ const defaultPlugins$2 = [
   SubgraphPrintPlugin,
 ];
 
-/**
- * @group Convert AST to DOT
- */
 class Printer {
   options;
-  /** @internal */
   #plugins = [...defaultPlugins$2];
   constructor(options = {}) {
     this.options = options;
@@ -296,13 +284,6 @@ class Printer {
   }
 }
 
-/**
- * Stringify Graphviz AST Node.
- *
- * @param ast Graphviz AST node.
- * @returns DOT language string.
- * @group Convert AST to DOT
- */
 function stringify(ast, options) {
   const result = new Printer(options).print(ast);
   if (!result) {
@@ -311,7 +292,6 @@ function stringify(ast, options) {
   return result;
 }
 
-/* eslint-disable */
 function peg$padEnd(str, targetLength, padString) {
   padString = padString || ' ';
   if (str.length > targetLength) {
@@ -541,9 +521,7 @@ function peg$parse(input, options) {
     );
   };
   const peg$c21 = function (id, rhs, _children) {
-    // @ts-ignore
     return b.createElement(
-      // @ts-ignore
       'Edge',
       {
         targets: [id, ...rhs],
@@ -5254,9 +5232,6 @@ const parse$1 = peg$parse;
 function parse(input, options) {
   return parse$1(input, options);
 }
-/**
- * @group Convert DOT to AST
- */
 const DotSyntaxError = DotSyntaxError$1;
 
 function convertAttribute(key, value) {
@@ -5562,12 +5537,8 @@ const SubgraphPlugin$1 = {
 
 const defaultPlugins$1 = [AttributeListPlugin, EdgePlugin$1, NodePlugin$1, GraphPlugin$1, SubgraphPlugin$1];
 
-/**
- * @group Convert Model to AST
- */
 class FromModelConverter {
   options;
-  /** @hidden */
   #plugins = [...defaultPlugins$1];
   constructor(options = {}) {
     this.options = options;
@@ -5590,9 +5561,6 @@ class FromModelConverter {
   }
 }
 
-/**
- * @group Convert Model to AST
- */
 function fromModel(model, options) {
   return new FromModelConverter(options).convert(model);
 }
@@ -5768,23 +5736,12 @@ const NodePlugin = {
 
 const defaultPlugins = [NodePlugin, EdgePlugin, SubgraphPlugin, GraphPlugin, DotPlugin];
 
-/**
- * @group Convert AST to Model
- * @alpha
- */
 class ToModelConverter {
   options;
-  /** @hidden */
   plugins = [...defaultPlugins];
   constructor(options = {}) {
     this.options = options;
   }
-  /**
-   * Convert AST to Model.
-   *
-   * @param ast AST node.
-   * @alpha
-   */
   convert(ast) {
     const plugins = [...this.plugins];
     const context = {
@@ -5802,10 +5759,6 @@ class ToModelConverter {
   }
 }
 
-/**
- * @group Convert AST to Model
- * @beta
- */
 function toModel(ast, options) {
   return new ToModelConverter(options).convert(ast);
 }