ts-graphviz 1.2.3 → 1.2.4-dev.0c498aa20

package/README.md

@@ -6,6 +6,7 @@
 [![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4?logo=prettier&style=flat)](https://github.com/facebook/jest)
 [![test: jest](https://img.shields.io/badge/tested%20with-jest-99424f?logo=jest&style=flat)](https://github.com/facebook/jest)
 ![node version](https://img.shields.io/node/v/ts-graphviz)
+[![deno version](https://img.shields.io/badge/deno-^1.28.0-black?logo=deno)](https://github.com/denoland/deno)
 ![npm](https://img.shields.io/npm/dm/ts-graphviz)
 [![All Contributors](https://img.shields.io/github/all-contributors/ts-graphviz/ts-graphviz?color=orange)](#contributors)
 
@@ -19,7 +20,7 @@
 [![Refarence](https://img.shields.io/badge/-Refarence-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
 [![Suponser](https://img.shields.io/badge/-Suponser-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/kamiazya)
 
-> [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.ja.md)
+> [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README_ja.md)
 
 ## Key Features ✨
 
@@ -34,6 +35,8 @@
 
 ## Installation 💽
 
+### Node.js
+
 This package can then be installed using a package manager.
 
 ```bash
@@ -45,6 +48,16 @@ $ yarn add ts-graphviz
 $ pnpm add ts-graphviz
 ```
 
+### Deno 🦕
+
+[Deno v1.28 and above supports npm](https://deno.land/manual/node/npm_specifiers).
+
+You can install and use the package by specifying the following:
+
+```ts
+import { toDot } from 'npm:ts-graphviz';
+```
+
 ## Usage 📑
 
 This section provides an overview of the package.
@@ -322,6 +335,56 @@ const dot = toDot(g);
 
 </details>
 
+### `ts-graphviz/adapter` Module 🔌
+
+> This module status is ![beta](https://img.shields.io/badge/-beta-orange).
+
+
+Provides an interface to run Graphviz dot commands.
+
+[Graphviz](https://graphviz.gitlab.io/) must be installed so that the dot command can be executed.
+
+Execute the dot command to output a DOT language string to a stream or file.
+
+![Adapter State Machine](./media/adapter-state-machine.svg)
+
+This module provides the following functions.
+
+- The `toStream` function converts **DOT** to **Stream**.
+    ```ts
+    import { toStream } from 'ts-graphviz/adapter';
+
+    const dot = `
+      digraph example {
+        node1 [
+          label = "My Node",
+        ]
+      }
+    `;
+
+    const stream = await toStream(dot, { format: 'svg' });
+    // Node.js
+    stream.pipe(process.stdout);
+    // Deno
+    await stream.pipeTo(Deno.stdout.writable);
+    ```
+- Writes **DOT** to a file at the specified path `toFile` function
+    ```ts
+    import { toFile } from 'ts-graphviz/adapter';
+
+    const dot = `
+      digraph example {
+        node1 [
+          label = "My Node",
+        ]
+      }
+    `;
+
+    await toFile(dot, './result.svg', { format: 'svg' });
+    ```
+
+> **Note** Designed to work with Node.js and Deno, Stream is runtime native.
+
 ### `ts-graphviz/ast` Module 🔢
 
 > This module status is ![beta](https://img.shields.io/badge/-beta-orange).
@@ -454,12 +517,13 @@ 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=""/><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=""/><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=""/><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=""/><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="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>
     </tr>
-  </tobdy>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

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

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

package/lib/adapter/deno/mod.js

@@ -0,0 +1,33 @@
+function commandBuilder({ dotCommand = 'dot', suppressWarnings = true, format = 'svg' } = {}) {
+  const args = [
+    ...(function* () {
+      if (suppressWarnings) yield '-q';
+      yield `-T${format}`;
+    })(),
+  ];
+  return [dotCommand, args];
+}
+
+/**
+ * Execute the Graphviz dot command and make a Stream of the results.
+ */
+export async function toStream(dot, options) {
+  const [command, args] = commandBuilder(options);
+  const cp = new Deno.Command(command, {
+    args: args,
+    stdin: 'piped',
+  }).spawn();
+  const stdin = cp.stdin.getWriter();
+  await stdin.write(new TextEncoder().encode(dot));
+  await stdin.close();
+  return cp.stdout;
+}
+
+/**
+ * Execute the Graphviz dot command and output the results to a file.
+ */
+export async function toFile(dot, path, options) {
+  const output = await Deno.open(path, { write: true });
+  const stream = await toStream(dot, options);
+  await stream.pipeTo(output.writable);
+}

package/lib/adapter/index.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+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');
+
+/**
+ * @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;
+}
+/**
+ * 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));
+}
+
+exports.toFile = toFile;
+exports.toStream = toStream;

package/lib/adapter/index.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+declare type Format = 'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'plain' | 'dot_json';
+interface Options {
+  format?: Format;
+  suppressWarnings?: boolean;
+  dotCommand?: string;
+}
+/**
+ * Execute the Graphviz dot command and make a Stream of the results.
+ */
+declare function toStream(dot: string, options?: Options): 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>;
+
+export { Format, Options, toFile, toStream };

package/lib/adapter/index.js

@@ -0,0 +1,42 @@
+import { createWriteStream } from 'node:fs';
+import { pipeline as pipeline$1, Readable } from 'node:stream';
+import { promisify } from 'node:util';
+import { spawn } from 'node:child_process';
+
+/**
+ * @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;
+}
+/**
+ * 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));
+}
+
+export { toFile, toStream };

package/media/adapter-state-machine.svg

@@ -0,0 +1 @@
+<svg width="172pt" height="211pt" viewBox="0 0 172.44 211.09" xmlns="http://www.w3.org/2000/svg"><g class="graph" transform="translate(4 207.09)"><path fill="#fff" stroke="transparent" d="M-4 4v-211.09h172.44V4H-4z"/><g class="node"><circle fill="none" stroke="#000" cx="89.85" cy="-171.89" r="31.4"/><text text-anchor="middle" x="89.85" y="-168.19" font-family="Times,serif" font-size="14">DOT</text></g><g class="node"><circle fill="none" stroke="#000" cx="44.85" cy="-44.85" r="44.69"/><text text-anchor="middle" x="44.85" y="-41.15" font-family="Times,serif" font-size="14">Stream</text></g><g class="edge"><path fill="none" stroke="#000" d="M66.46-151.09c-7.72 7.95-15.4 17.76-19.61 28.4-2.87 7.24-4.54 15.17-5.4 23.11"/><path stroke="#000" d="m44.94-99.32-4.18 9.73-2.8-10.21 6.98.48z"/><text text-anchor="middle" x="80.35" y="-111.49" font-family="Times,serif" font-size="14">toStream</text></g><g class="node"><circle fill="none" stroke="#000" cx="135.85" cy="-44.85" r="28.7"/><text text-anchor="middle" x="135.85" y="-41.15" font-family="Times,serif" font-size="14">File</text></g><g class="edge"><path fill="none" stroke="#000" d="M104.32-144.01c3.38 6.84 6.79 14.26 9.53 21.32 4.95 12.76 9.35 27.09 12.89 39.89"/><path stroke="#000" d="m130.18-83.48-.79 10.56-5.97-8.75 6.76-1.81z"/><text text-anchor="middle" x="139.85" y="-111.49" font-family="Times,serif" font-size="14">toFile</text></g></g></svg>

package/package.json

@@ -1,87 +1,114 @@
 {
-  "name": "ts-graphviz",
-  "version": "1.2.3",
-  "author": "kamiazya <yuki@kamiazya.tech>",
-  "description": "Graphviz library for TypeScript.",
-  "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ts-graphviz/ts-graphviz.git"
-  },
-  "keywords": [
-    "graphviz",
-    "dot"
-  ],
-  "bugs": {
-    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
-  },
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/kamiazya"
-  },
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
-  "types": "lib/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./lib/index.js",
-      "require": "./lib/index.cjs",
-      "types": "./lib/index.d.ts"
+    "name": "ts-graphviz",
+    "version": "1.2.4-dev.0c498aa20",
+    "author": "kamiazya <yuki@kamiazya.tech>",
+    "description": "Graphviz library for TypeScript.",
+    "homepage": "https://ts-graphviz.github.io/ts-graphviz/",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/ts-graphviz/ts-graphviz.git"
     },
-    "./ast": {
-      "import": "./lib/ast/index.js",
-      "require": "./lib/ast/index.cjs",
-      "types": "./lib/ast/index.d.ts"
-    }
-  },
-  "imports": {
-    "#lib/*": {
-      "import": "./lib/*/index.js",
-      "require": "./lib/*/index.cjs",
-      "types": "./lib/*/index.d.ts"
+    "keywords": [
+        "graphviz",
+        "dot"
+    ],
+    "bugs": {
+        "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
+    },
+    "funding": {
+        "type": "github",
+        "url": "https://github.com/sponsors/kamiazya"
+    },
+    "main": "./lib/index.cjs",
+    "module": "./lib/index.js",
+    "types": "lib/index.d.ts",
+    "exports": {
+        ".": {
+            "require": {
+                "default": "./lib/index.cjs",
+                "types": "./lib/index.d.ts"
+            },
+            "import": {
+                "default": "./lib/index.js",
+                "types": "./lib/index.d.ts"
+            }
+        },
+        "./ast": {
+            "require": {
+                "default": "./lib/ast/index.cjs",
+                "types": "./lib/ast/index.d.ts"
+            },
+            "import": {
+                "default": "./lib/ast/index.js",
+                "types": "./lib/ast/index.d.ts"
+            }
+        },
+        "./adapter": {
+            "deno": {
+                "default": "./lib/adapter/deno/mod.js",
+                "types": "./lib/adapter/deno/mod.d.ts"
+            },
+            "node": {
+                "require": "./lib/adapter/index.cjs",
+                "import": "./lib/adapter/index.js",
+                "types": "./lib/adapter/index.d.ts"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "typesVersions": {
+        "*": {
+            "ast": [
+                "lib/ast"
+            ],
+            "adapter": [
+                "lib/adapter"
+            ]
+        }
+    },
+    "license": "MIT",
+    "engines": {
+        "node": ">=14.16"
+    },
+    "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:node": "tsc -p tsconfig.build.json && rollup -c",
+        "build": "yarn build:node && yarn build:deno",
+        "postbuild": "prettier --write ./lib/**/index.{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'",
+        "lint": "eslint --ext ts src",
+        "predoc": "yarn build:peggy",
+        "doc": "typedoc"
+    },
+    "devDependencies": {
+        "@rollup/plugin-replace": "^4.0.0",
+        "@types/jest": "^28.1.6",
+        "@types/jest-specific-snapshot": "^0.5.6",
+        "@typescript-eslint/eslint-plugin": "^5.33.0",
+        "@typescript-eslint/parser": "^5.33.0",
+        "eslint": "^8.22.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-jest": "^26.8.2",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jest": "^28.1.3",
+        "jest-snapshot-serializer-raw": "^1.2.0",
+        "jest-specific-snapshot": "^5.0.0",
+        "peggy": "^2.0.1",
+        "prettier": "^2.7.1",
+        "prettier-plugin-pegjs": "^0.5.0",
+        "rollup": "^2.77.3",
+        "rollup-plugin-delete": "^2.0.0",
+        "rollup-plugin-dts": "^4.2.2",
+        "svgo": "^2.8.0",
+        "ts-jest": "^28.0.7",
+        "ts-pegjs": "^2.1.0",
+        "typedoc": "^0.23.15",
+        "typescript": "^4.7.4"
     }
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=14.16"
-  },
-  "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": "tsc -p tsconfig.build.json && rollup -c",
-    "postbuild": "prettier --write ./lib/**/index.{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'",
-    "lint": "eslint --ext ts src",
-    "predoc": "yarn build:peggy",
-    "doc": "typedoc"
-  },
-  "devDependencies": {
-    "@rollup/plugin-replace": "^4.0.0",
-    "@types/jest": "^28.1.6",
-    "@types/jest-specific-snapshot": "^0.5.6",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "@typescript-eslint/parser": "^5.33.0",
-    "eslint": "^8.22.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^26.8.2",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^28.1.3",
-    "jest-snapshot-serializer-raw": "^1.2.0",
-    "jest-specific-snapshot": "^5.0.0",
-    "peggy": "^2.0.1",
-    "prettier": "^2.7.1",
-    "prettier-plugin-pegjs": "^0.5.0",
-    "rollup": "^2.77.3",
-    "rollup-plugin-delete": "^2.0.0",
-    "rollup-plugin-dts": "^4.2.2",
-    "svgo": "^2.8.0",
-    "ts-jest": "^28.0.7",
-    "ts-pegjs": "^2.1.0",
-    "typedoc": "^0.23.15",
-    "typescript": "^4.7.4"
-  }
-}
+}