ts-graphviz - npm Package Compare versions

Comparing version 1.5.5 to 1.5.6-dev.29eb2444f

lib/adapter/node/index.d.ts

 /// <reference types="node" />
 import { Layout, Options } from '../types/index.js';
-export { Format, Options } from '../types/index.js';
+export { Format, Layout, Options } from '../types/index.js';
 
@@ -5,0 +5,0 @@ /**

lib/adapter/types/index.d.ts

@@ -7,5 +7,15 @@ import {
 } from '../../common/index.js';
+import { $keywords } from '../../utils/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';
+type Format = Format.values;
+declare namespace Format {
+  type values = keyof $values;
+  interface $values extends $keywords<'png' | 'svg' | 'json' | 'jpg' | 'pdf' | 'xdot' | 'dot' | 'plain' | 'dot_json'> {}
+}
+type Layout = Layout.values;
+declare namespace Layout {
+  type values = keyof $values;
+  interface $values
+    extends $keywords<'dot' | 'neato' | 'fdp' | 'sfdp' | 'circo' | 'twopi' | 'nop' | 'nop2' | 'osage' | 'patchwork'> {}
+}
 /**
@@ -12,0 +22,0 @@ * NeatoOptions interface provides options for the neato layout.

lib/index.d.ts

@@ -0,2 +1,3 @@
+export { $keywords } from './utils/index.js';
 export * from './common/index.js';
 export * from './core/index.js';

lib/utils/index.d.ts

@@ -0,1 +1,8 @@
+/**
+ * @hidden
+ */
+type $keywords<T extends string> = {
+  [key in T]: key;
+};
+
 type F<A extends any[], O> = (...args: A) => O;
@@ -22,2 +29,2 @@ type IO<I, O> = F<[I], O>;
 
-export { F, IO, filter, map, pipe };
+export { $keywords, F, IO, filter, map, pipe };

package.json

 {
-  "name": "ts-graphviz",
-  "version": "1.5.5",
-  "author": "kamiazya <[e-mail]>",
-  "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": {
-    ".": {
-      "require": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.cjs"
-      },
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      }
+    "name": "ts-graphviz",
+    "version": "1.5.6-dev.29eb2444f",
+    "author": "kamiazya <[e-mail]>",
+    "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": {
-      "require": {
-        "types": "./lib/ast/index.d.ts",
-        "default": "./lib/ast/index.cjs"
-      },
-      "import": {
-        "types": "./lib/ast/index.d.ts",
-        "default": "./lib/ast/index.js"
-      }
+    "keywords": [
+        "graphviz",
+        "dot"
+    ],
+    "bugs": {
+        "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
     },
-    "./adapter": {
-      "browser": {
-        "require": "./lib/adapter/browser/index.cjs",
-        "import": "./lib/adapter/browser/index.js",
-        "types": "./lib/adapter/browser/index.d.ts"
-      },
-      "deno": {
-        "types": "./lib/adapter/deno/mod.d.ts",
-        "default": "./lib/adapter/deno/mod.js"
-      },
-      "node": {
-        "require": "./lib/adapter/node/index.cjs",
-        "import": "./lib/adapter/node/index.js",
-        "types": "./lib/adapter/node/index.d.ts"
-      },
-      "default": {
-        "types": "./lib/adapter/node/index.d.ts",
-        "require": "./lib/adapter/node/index.cjs",
-        "import": "./lib/adapter/node/index.js"
-      }
+    "funding": {
+        "type": "github",
+        "url": "https://github.com/sponsors/kamiazya"
     },
-    "./package.json": "./package.json"
-  },
-  "typesVersions": {
-    "*": {
-      "ast": [
-        "lib/ast"
-      ],
-      "adapter": [
-        "lib/adapter/node"
-      ]
+    "main": "./lib/index.cjs",
+    "module": "./lib/index.js",
+    "types": "lib/index.d.ts",
+    "exports": {
+        ".": {
+            "require": {
+                "types": "./lib/index.d.ts",
+                "default": "./lib/index.cjs"
+            },
+            "import": {
+                "types": "./lib/index.d.ts",
+                "default": "./lib/index.js"
+            }
+        },
+        "./ast": {
+            "require": {
+                "types": "./lib/ast/index.d.ts",
+                "default": "./lib/ast/index.cjs"
+            },
+            "import": {
+                "types": "./lib/ast/index.d.ts",
+                "default": "./lib/ast/index.js"
+            }
+        },
+        "./adapter": {
+            "browser": {
+                "require": "./lib/adapter/browser/index.cjs",
+                "import": "./lib/adapter/browser/index.js",
+                "types": "./lib/adapter/browser/index.d.ts"
+            },
+            "deno": {
+                "types": "./lib/adapter/deno/mod.d.ts",
+                "default": "./lib/adapter/deno/mod.js"
+            },
+            "node": {
+                "require": "./lib/adapter/node/index.cjs",
+                "import": "./lib/adapter/node/index.js",
+                "types": "./lib/adapter/node/index.d.ts"
+            },
+            "default": {
+                "types": "./lib/adapter/node/index.d.ts",
+                "require": "./lib/adapter/node/index.cjs",
+                "import": "./lib/adapter/node/index.js"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "typesVersions": {
+        "*": {
+            "ast": [
+                "lib/ast"
+            ],
+            "adapter": [
+                "lib/adapter/node"
+            ]
+        }
+    },
+    "license": "MIT",
+    "engines": {
+        "node": ">=14.16"
+    },
+    "runkitExampleFilename": "example/runkit.cjs",
+    "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": "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 --declaration && tsc -p tsconfig.build.json --removeComments && rollup -c",
+        "build": "yarn build:node && yarn build:deno",
+        "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'",
+        "lint": "eslint --ext ts src",
+        "predoc": "yarn build:peggy",
+        "doc": "typedoc"
+    },
+    "devDependencies": {
+        "@rollup/plugin-replace": "^5.0.2",
+        "@types/jest": "^29.4.0",
+        "@types/jest-specific-snapshot": "^0.5.6",
+        "@typescript-eslint/eslint-plugin": "^5.49.0",
+        "@typescript-eslint/parser": "^5.49.0",
+        "eslint": "^8.32.0",
+        "eslint-config-prettier": "^8.6.0",
+        "eslint-plugin-import": "^2.27.5",
+        "eslint-plugin-jest": "^27.2.1",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jest": "^29.4.1",
+        "jest-snapshot-serializer-raw": "^1.2.0",
+        "jest-specific-snapshot": "^7.0.0",
+        "peggy": "^2.0.1",
+        "prettier": "^2.8.3",
+        "prettier-plugin-pegjs": "^0.5.0",
+        "rollup": "^3.11.0",
+        "rollup-plugin-delete": "^2.0.0",
+        "rollup-plugin-dts": "5.1.1",
+        "svgo": "^3.0.2",
+        "ts-jest": "^29.0.5",
+        "ts-pegjs": "^3.0.0",
+        "typedoc": "^0.23.15",
+        "typescript": "^4.7.4"
     }
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=14.16"
-  },
-  "runkitExampleFilename": "example/runkit.cjs",
-  "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": "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 --declaration && tsc -p tsconfig.build.json --removeComments && rollup -c",
-    "build": "yarn build:node && yarn build:deno",
-    "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'",
-    "lint": "eslint --ext ts src",
-    "predoc": "yarn build:peggy",
-    "doc": "typedoc"
-  },
-  "devDependencies": {
-    "@rollup/plugin-replace": "^5.0.2",
-    "@types/jest": "^29.4.0",
-    "@types/jest-specific-snapshot": "^0.5.6",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
-    "eslint": "^8.32.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.4.1",
-    "jest-snapshot-serializer-raw": "^1.2.0",
-    "jest-specific-snapshot": "^7.0.0",
-    "peggy": "^2.0.1",
-    "prettier": "^2.8.3",
-    "prettier-plugin-pegjs": "^0.5.0",
-    "rollup": "^3.11.0",
-    "rollup-plugin-delete": "^2.0.0",
-    "rollup-plugin-dts": "5.1.1",
-    "svgo": "^3.0.2",
-    "ts-jest": "^29.0.5",
-    "ts-pegjs": "^3.0.0",
-    "typedoc": "^0.23.15",
-    "typescript": "^4.7.4"
-  }
-}
+}

README.md

@@ -506,2 +506,76 @@ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d6485f9858ed4b3e8ef76611a2896bc4)](https://app.codacy.com/gh/ts-graphviz/ts-graphviz?utm_source=github.com&utm_medium=referral&utm_content=ts-graphviz/ts-graphviz&utm_campaign=Badge_Grade_Settings)
 
+### Extending the Type System 🧰
+
+> The status of this feature is ![beta](https://img.shields.io/badge/-beta-orange).
+
+With ts-graphviz, you can extend the library's type system to customize graph visualization solutions to meet specific needs.
+
+> **Note** To allow for customization, types are named with the `$` symbol.
+>
+> If you want to extend a type definition in cases not listed below, check the source code to see if you can extend it with `$...`.
+>
+> If not, please create an issue or pull request.
+
+#### Use Case: Specifying Custom Graph Layout and Output Formats
+
+```ts
+import { $keywords } from 'ts-graphviz';
+import { toFile } from 'ts-graphviz/adapter';
+
+// 1. Declare the 'ts-graphviz/adapter' module.
+declare module 'ts-graphviz/adapter' {
+  export namespace Layout {
+    // 2. Define the $values interface in the Layout namespace.
+    // 3. Inherit from $keywords<'my-custom-algorithm'> and specify the name of the new layout engine in <...>.
+    export interface $values extends $keywords<'my-custom-algorithm'> {}
+  }
+
+  export namespace Format {
+    // 4. Define the $values interface in the Format namespace.
+    // 5. Inherit from $keywords<'mp4'> and specify the name of the new output format in <...>.
+    export interface $values extends $keywords<'mp4'> {}
+  }
+}
+
+toFile('digraph { a -> b }', '/path/to/file', {
+  layout: 'my-custom-algorithm',
+  format: 'mp4',
+});
+```
+
+#### Use Case: Adding Custom Attributes
+
+```ts
+import { digraph, toDot, attribute as _, $keywords } from 'ts-graphviz';
+
+// 1. Declare the 'ts-graphviz' module.
+declare module 'ts-graphviz' {
+  export namespace GraphAttributeKey {
+    // 2. Define the $values interface in the GraphAttributeKey namespace.
+    // 3. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
+    export interface $values extends $keywords<'hoge'> {}
+  }
+
+  export namespace Attribute {
+    // 4. Define the $keys interface in the Attribute namespace.
+    // 5. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
+    export interface $keys extends $keywords<'hoge'> {}
+
+    // 6. Define the $types interface in the Attribute namespace.
+    // 7. Specify the new attribute in the key and define its corresponding value in the value.
+    export interface $types {
+      hoge: string;
+    }
+  }
+}
+
+console.log(
+  toDot(
+    digraph((g) => {
+      g.set(_.hoge, 'fuga');
+    }),
+  ),
+);
+```
+
 ## Who's using `ts-graphviz` 📜
@@ -508,0 +582,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

594185

2.41%

Lines of code

19105

0.63%

Number of lines in readme file

660

12.63%

Worsened metrics

Number of low quality alerts

1

Infinity%

No dependency changes