ts-graphviz 1.4.1-dev.c60d6bfba → 1.4.1-dev.d42db466f

package/README.md

@@ -528,13 +528,16 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <table>
   <tbody>
     <tr>
-      <td align="center"><a href="http://blog.kamiazya.tech/"><img src="https://avatars0.githubusercontent.com/u/35218186?v=4?s=100" width="100px;" alt="Yuki Yamazaki"/><br /><sub><b>Yuki Yamazaki</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Code">💻</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Tests">⚠️</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Documentation">📖</a> <a href="#ideas-kamiazya" title="Ideas, Planning, & Feedback">🤔</a></td>
-      <td align="center"><a href="https://laysent.com"><img src="https://avatars2.githubusercontent.com/u/1191606?v=4?s=100" width="100px;" alt="LaySent"/><br /><sub><b>LaySent</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Alaysent" title="Bug reports">🐛</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=laysent" title="Tests">⚠️</a></td>
-      <td align="center"><a href="https://github.com/elasticdotventures"><img src="https://avatars0.githubusercontent.com/u/35611074?v=4?s=100" width="100px;" alt="elasticdotventures"/><br /><sub><b>elasticdotventures</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=elasticdotventures" title="Documentation">📖</a></td>
-      <td align="center"><a href="https://github.com/ChristianMurphy"><img src="https://avatars.githubusercontent.com/u/3107513?v=4?s=100" width="100px;" alt="Christian Murphy"/><br /><sub><b>Christian Murphy</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Code">💻</a> <a href="#ideas-ChristianMurphy" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Documentation">📖</a></td>
-      <td align="center"><a href="https://github.com/ArtemAdamenko"><img src="https://avatars.githubusercontent.com/u/2178516?v=4?s=100" width="100px;" alt="Artem"/><br /><sub><b>Artem</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3AArtemAdamenko" title="Bug reports">🐛</a></td>
-      <td align="center"><a href="https://github.com/fredericohpandolfo"><img src="https://avatars.githubusercontent.com/u/24229136?v=4?s=100" width="100px;" alt="fredericohpandolfo"/><br /><sub><b>fredericohpandolfo</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Afredericohpandolfo" title="Bug reports">🐛</a></td>
-      <td align="center"><a href="https://github.com/diegoquinteiro"><img src="https://avatars.githubusercontent.com/u/1878108?v=4?s=100" width="100px;" alt="diegoquinteiro"/><br /><sub><b>diegoquinteiro</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Adiegoquinteiro" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://blog.kamiazya.tech/"><img src="https://avatars0.githubusercontent.com/u/35218186?v=4?s=100" width="100px;" alt="Yuki Yamazaki"/><br /><sub><b>Yuki Yamazaki</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Code">💻</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Tests">⚠️</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=kamiazya" title="Documentation">📖</a> <a href="#ideas-kamiazya" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://laysent.com"><img src="https://avatars2.githubusercontent.com/u/1191606?v=4?s=100" width="100px;" alt="LaySent"/><br /><sub><b>LaySent</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Alaysent" title="Bug reports">🐛</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=laysent" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/elasticdotventures"><img src="https://avatars0.githubusercontent.com/u/35611074?v=4?s=100" width="100px;" alt="elasticdotventures"/><br /><sub><b>elasticdotventures</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=elasticdotventures" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ChristianMurphy"><img src="https://avatars.githubusercontent.com/u/3107513?v=4?s=100" width="100px;" alt="Christian Murphy"/><br /><sub><b>Christian Murphy</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Code">💻</a> <a href="#ideas-ChristianMurphy" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ts-graphviz/ts-graphviz/commits?author=ChristianMurphy" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ArtemAdamenko"><img src="https://avatars.githubusercontent.com/u/2178516?v=4?s=100" width="100px;" alt="Artem"/><br /><sub><b>Artem</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3AArtemAdamenko" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/fredericohpandolfo"><img src="https://avatars.githubusercontent.com/u/24229136?v=4?s=100" width="100px;" alt="fredericohpandolfo"/><br /><sub><b>fredericohpandolfo</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Afredericohpandolfo" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/diegoquinteiro"><img src="https://avatars.githubusercontent.com/u/1878108?v=4?s=100" width="100px;" alt="diegoquinteiro"/><br /><sub><b>diegoquinteiro</b></sub></a><br /><a href="https://github.com/ts-graphviz/ts-graphviz/issues?q=author%3Adiegoquinteiro" title="Bug reports">🐛</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robross0606"><img src="https://avatars.githubusercontent.com/u/2965467?v=4?s=100" width="100px;" alt="robross0606"/><br /><sub><b>robross0606</b></sub></a><br /><a href="#ideas-robross0606" title="Ideas, Planning, & Feedback">🤔</a></td>
     </tr>
   </tbody>
 </table>

package/lib/adapter/deno/mod.d.ts

@@ -1,17 +1,13 @@
-export type Format = 'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'plain' | 'dot_json';
-
-export interface Options {
-  format?: Format;
-  suppressWarnings?: boolean;
-  dotCommand?: string;
-}
+import { Options, Format, Layout } from '../types/index.d.ts';
 
 /**
  * Execute the Graphviz dot command and make a Stream of the results.
  */
-export function toStream(dot: string, options?: Options): Promise<ReadableStream<Uint8Array>>;
+export function toStream<T extends Layout>(dot: string, options?: Options<T>): Promise<ReadableStream<Uint8Array>>;
 
 /**
  * Execute the Graphviz dot command and output the results to a file.
  */
-export function toFile(dot: string, path: string, options?: Options): Promise<void>;
+export function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;
+
+export { Options, Format, Layout };

package/lib/adapter/deno/mod.js

@@ -1,13 +1,4 @@
-function commandBuilder({ dotCommand = 'dot', suppressWarnings = true, format = 'svg' } = {}) {
-  const args = [
-    ...(function* () {
-      if (suppressWarnings) yield '-q';
-      yield `-T${format}`;
-    })(),
-  ];
-  return [dotCommand, args];
-}
-
+import { commandBuilder } from '../utils/index.js';
 /**
  * Execute the Graphviz dot command and make a Stream of the results.
  */

package/lib/adapter/node/index.cjs

@@ -2,39 +2,49 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var node_fs = require('node:fs');
 var node_stream = require('node:stream');
-var node_util = require('node:util');
 var node_child_process = require('node:child_process');
+var index_js = require('../utils/index.cjs');
+var node_util = require('node:util');
+var node_fs = require('node:fs');
 
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-function commandBuilder({ dotCommand = 'dot', suppressWarnings = true, format = 'svg' } = {}) {
-  const args = [
-    ...(function* () {
-      if (suppressWarnings) yield '-q';
-      yield `-T${format}`;
-    })(),
-  ];
-  return [dotCommand, args];
-}
 /**
  * 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] = commandBuilder(options);
-  const p = node_child_process.spawn(command, args, { stdio: 'pipe' });
-  await pipeline(node_stream.Readable.from([dot]), p.stdin);
-  return p.stdout;
+  const [command, args] = index_js.commandBuilder(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}`, {
+          cause: e,
+        }),
+      );
+    });
+    const stderrChunks = [];
+    p.stderr.on('data', (chunk) => stderrChunks.push(chunk));
+    const dist = p.stdout.pipe(new node_stream.PassThrough());
+    p.on('close', async (code, signal) => {
+      if (code === 0) {
+        resolve(dist);
+      } else {
+        const message = Buffer.concat(stderrChunks).toString();
+        reject(new Error(`Command "${command}" failed.\nCODE: ${code}\nSIGNAL: ${signal}\nMESSAGE: ${message}`));
+      }
+    });
+    await pipeline(node_stream.Readable.from([dot]), p.stdin);
+  });
 }
+
 /**
  * Execute the Graphviz dot command and output the results to a file.
  */

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

@@ -1,17 +1,15 @@
 /// <reference types="node" />
-type Format = 'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'plain' | 'dot_json';
-interface Options {
-  format?: Format;
-  suppressWarnings?: boolean;
-  dotCommand?: string;
-}
+import { Layout, Options } from '../types/index.js';
+export { Format, Options } from '../types/index.js';
+
 /**
  * Execute the Graphviz dot command and make a Stream of the results.
  */
-declare function toStream(dot: string, options?: Options): Promise<NodeJS.ReadableStream>;
+declare function toStream<T extends Layout>(dot: string, options?: Options<T>): Promise<NodeJS.ReadableStream>;
+
 /**
  * Execute the Graphviz dot command and output the results to a file.
  */
-declare function toFile(dot: string, path: string, options?: Options): Promise<void>;
+declare function toFile<T extends Layout>(dot: string, path: string, options?: Options<T>): Promise<void>;
 
-export { Format, Options, toFile, toStream };
+export { toFile, toStream };

package/lib/adapter/node/index.js

@@ -1,36 +1,46 @@
-import { createWriteStream } from 'node:fs';
-import { pipeline as pipeline$1, Readable } from 'node:stream';
-import { promisify } from 'node:util';
+import { pipeline as pipeline$1, PassThrough, Readable } from 'node:stream';
 import { spawn } from 'node:child_process';
+import { commandBuilder } from '../utils/index.js';
+import { promisify } from 'node:util';
+import { createWriteStream } from 'node:fs';
 
-/**
- * @module ts-graphviz/adapter
- * @beta
- */
-function commandBuilder({ dotCommand = 'dot', suppressWarnings = true, format = 'svg' } = {}) {
-  const args = [
-    ...(function* () {
-      if (suppressWarnings) yield '-q';
-      yield `-T${format}`;
-    })(),
-  ];
-  return [dotCommand, args];
-}
 /**
  * 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 p = spawn(command, args, { stdio: 'pipe' });
-  await pipeline(Readable.from([dot]), p.stdin);
-  return p.stdout;
+  const [command, args] = commandBuilder(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}`, {
+          cause: e,
+        }),
+      );
+    });
+    const stderrChunks = [];
+    p.stderr.on('data', (chunk) => stderrChunks.push(chunk));
+    const dist = p.stdout.pipe(new PassThrough());
+    p.on('close', async (code, signal) => {
+      if (code === 0) {
+        resolve(dist);
+      } else {
+        const message = Buffer.concat(stderrChunks).toString();
+        reject(new Error(`Command "${command}" failed.\nCODE: ${code}\nSIGNAL: ${signal}\nMESSAGE: ${message}`));
+      }
+    });
+    await pipeline(Readable.from([dot]), p.stdin);
+  });
 }
+
 /**
  * Execute the Graphviz dot command and output the results to a file.
  */

package/lib/adapter/types/index.cjs

@@ -0,0 +1 @@
+'use strict';

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

@@ -0,0 +1,107 @@
+import {
+  EdgeAttributesObject,
+  NodeAttributesObject,
+  GraphAttributesObject,
+  SubgraphAttributesObject,
+} from '../../common/index.js';
+
+type Format = 'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'dot' | 'plain' | 'dot_json';
+type Layout = 'dot' | 'neato' | 'fdp' | 'sfdp' | 'circo' | 'twopi' | 'nop' | 'nop2' | 'osage' | 'patchwork';
+interface NeatoOptions {
+  layout: 'neato';
+  /**
+   * Sets no-op flag in neato.
+   */
+  noop?: number;
+  /**
+   * Reduce graph.
+   */
+  reduce?: boolean;
+}
+interface FdpOptions {
+  layout: 'fdp';
+  /**
+   * Use grid.
+   *
+   * @default true
+   */
+  grid?: boolean;
+  /**
+   * Use old attractive force
+   *
+   * @default true
+   */
+  oldAttractive?: boolean;
+  /**
+   * Set number of iterations.
+   */
+  iterations?: number;
+  /**
+   * Set unscaled factor
+   */
+  unscaledFactor?: number;
+  /**
+   * Set overlap expansion factor.
+   */
+  overlapExpansionFactor?: number;
+  /**
+   * Set temperature.
+   */
+  temperature?: number;
+}
+interface OtherOptions {
+  /**
+   * Set layout engine.
+   *
+   * @default 'dot'
+   */
+  layout?: Exclude<Layout, 'neato' | 'fdp'>;
+}
+interface CommonOptions {
+  /**
+   * Set output format.
+   *
+   * @default 'svg'
+   */
+  format?: Format;
+  /**
+   * If true, set level of message suppression (=1).
+   *
+   * @default true
+   */
+  suppressWarnings?: boolean;
+  /**
+   * Path of graphviz dot command.
+   */
+  dotCommand?: string;
+  attributes?: {
+    /**
+     * Set edge attribute.
+     */
+    edge?: EdgeAttributesObject;
+    /**
+     * Set node attribute.
+     */
+    node?: NodeAttributesObject;
+    /**
+     * Set graph attribute.
+     */
+    graph?: GraphAttributesObject & SubgraphAttributesObject;
+  };
+  /**
+   * Scale input
+   */
+  scale?: number;
+  /**
+   * Use external library.
+   */
+  library?: string[];
+  /**
+   * Invert y coordinate in output.
+   */
+  y?: boolean;
+}
+type Options<T extends Layout = Layout> = CommonOptions &
+  (T extends 'neato' ? NeatoOptions : T extends 'fdp' ? FdpOptions : OtherOptions);
+
+export { CommonOptions, FdpOptions, Format, Layout, NeatoOptions, Options, OtherOptions };

package/lib/adapter/utils/index.cjs

@@ -0,0 +1,52 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function* args(options) {
+  const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
+  if (suppressWarnings) yield '-q';
+  yield `-T${format}`;
+  if (attributes.graph) {
+    for (const [key, value] of Object.entries(attributes.graph)) {
+      if (value === true) yield `-G${key}`;
+      else yield `-G${key}="${value}"`;
+    }
+  }
+  if (attributes.node) {
+    for (const [key, value] of Object.entries(attributes.node)) {
+      if (value === true) yield `-N${key}`;
+      else yield `-N${key}="${value}"`;
+    }
+  }
+  if (attributes.edge) {
+    for (const [key, value] of Object.entries(attributes.edge)) {
+      if (value === true) yield `-E${key}`;
+      else yield `-E${key}="${value}"`;
+    }
+  }
+  if (typeof scale === 'number' && !Number.isNaN(scale)) yield `-s${scale}`;
+  if (Array.isArray(library)) for (const lib of library) yield `-l${lib}`;
+  if (y === true) yield `-y`;
+  if (typeof options.layout === 'string') {
+    yield `-K${options.layout}`;
+    switch (options.layout) {
+      case 'neato':
+        const { reduce, noop } = options;
+        if (reduce === true) yield '-x';
+        if (typeof noop === 'number') yield `-n${noop}`;
+        break;
+      case 'fdp':
+        const { grid, oldAttractive, iterations, unscaledFactor, overlapExpansionFactor, temperature } = options;
+        yield ['-L', grid ? '' : 'g', oldAttractive ? 'O' : ''].join('');
+        if (typeof iterations === 'number') yield `-Ln${iterations}`;
+        if (typeof unscaledFactor === 'number') yield `-LU${unscaledFactor}`;
+        if (typeof overlapExpansionFactor === 'number') yield `-LC${overlapExpansionFactor}`;
+        if (typeof temperature === 'number') yield `-LT${temperature}`;
+    }
+  }
+}
+function commandBuilder(options) {
+  return [options.dotCommand ?? 'dot', Array.from(args(options))];
+}
+
+exports.commandBuilder = commandBuilder;

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

@@ -0,0 +1,5 @@
+import { Layout, Options } from '../types/index.js';
+
+declare function commandBuilder<T extends Layout>(options: Options<T>): [command: string, args: string[]];
+
+export { commandBuilder };

package/lib/adapter/utils/index.js

@@ -0,0 +1,48 @@
+function* args(options) {
+  const { suppressWarnings = true, format = 'svg', attributes = {}, library = [], y = false, scale } = options;
+  if (suppressWarnings) yield '-q';
+  yield `-T${format}`;
+  if (attributes.graph) {
+    for (const [key, value] of Object.entries(attributes.graph)) {
+      if (value === true) yield `-G${key}`;
+      else yield `-G${key}="${value}"`;
+    }
+  }
+  if (attributes.node) {
+    for (const [key, value] of Object.entries(attributes.node)) {
+      if (value === true) yield `-N${key}`;
+      else yield `-N${key}="${value}"`;
+    }
+  }
+  if (attributes.edge) {
+    for (const [key, value] of Object.entries(attributes.edge)) {
+      if (value === true) yield `-E${key}`;
+      else yield `-E${key}="${value}"`;
+    }
+  }
+  if (typeof scale === 'number' && !Number.isNaN(scale)) yield `-s${scale}`;
+  if (Array.isArray(library)) for (const lib of library) yield `-l${lib}`;
+  if (y === true) yield `-y`;
+  if (typeof options.layout === 'string') {
+    yield `-K${options.layout}`;
+    switch (options.layout) {
+      case 'neato':
+        const { reduce, noop } = options;
+        if (reduce === true) yield '-x';
+        if (typeof noop === 'number') yield `-n${noop}`;
+        break;
+      case 'fdp':
+        const { grid, oldAttractive, iterations, unscaledFactor, overlapExpansionFactor, temperature } = options;
+        yield ['-L', grid ? '' : 'g', oldAttractive ? 'O' : ''].join('');
+        if (typeof iterations === 'number') yield `-Ln${iterations}`;
+        if (typeof unscaledFactor === 'number') yield `-LU${unscaledFactor}`;
+        if (typeof overlapExpansionFactor === 'number') yield `-LC${overlapExpansionFactor}`;
+        if (typeof temperature === 'number') yield `-LT${temperature}`;
+    }
+  }
+}
+function commandBuilder(options) {
+  return [options.dotCommand ?? 'dot', Array.from(args(options))];
+}
+
+export { commandBuilder };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-graphviz",
-    "version": "1.4.1-dev.c60d6bfba",
+    "version": "1.4.1-dev.d42db466f",
     "author": "kamiazya <yuki@kamiazya.tech>",
     "description": "Graphviz library for TypeScript.",
     "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
@@ -84,10 +84,10 @@
     "scripts": {
         "build:peggy": "peggy --plugin ts-pegjs --extra-options-file src/ast/dot-shim/parser/peggy.options.json -o src/ast/dot-shim/parser/_parse.ts src/ast/dot-shim/parser/dot.peggy",
         "prebuild": "yarn build:peggy",
-        "build:deno": "cp -r src/adapter/deno lib/adapter/deno",
+        "build:deno": "mkdir -p lib/adapter/deno && cp -r src/adapter/deno/* lib/adapter/deno && sed -i \"s/index.ts/index.js/g\" lib/adapter/deno/mod.js && sed -i \"s/index.ts/index.d.ts/g\" lib/adapter/deno/mod.d.ts",
         "build:node": "tsc -p tsconfig.build.json && rollup -c",
         "build": "yarn build:node && yarn build:deno",
-        "postbuild": "prettier --write ./lib/**/index.{js,cjs,d.ts}",
+        "postbuild": "prettier --write ./lib/**/*.{js,cjs,d.ts}",
         "pretest": "yarn build:peggy",
         "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest",
         "format": "eslint --ext ts src --fix && prettier --write './**/*.{ts,js,json,yaml}' '!lib'",