ts-graphviz 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.ja.md +15 -8
  2. package/README.md +15 -8
  3. package/lib/ast/index.cjs +543 -527
  4. package/lib/ast/index.d.ts +215 -49
  5. package/lib/ast/index.js +543 -527
  6. package/lib/common/index.cjs +32 -0
  7. package/lib/common/index.d.ts +267 -9
  8. package/lib/common/index.js +32 -0
  9. package/lib/core/index.cjs +149 -178
  10. package/lib/core/index.d.ts +148 -402
  11. package/lib/core/index.js +157 -179
  12. package/media/ts-graphviz.svg +1 -1
  13. package/package.json +3 -3
  14. package/test/__snapshots__/class-base.test.ts.snap +18 -0
  15. package/test/__snapshots__/create-root-graph.spec.ts.snap +200 -0
  16. package/test/__snapshots__/to-dot.test.ts.snap +229 -0
  17. package/test/class-base.test.ts +23 -0
  18. package/test/create-root-graph.spec.ts +292 -0
  19. package/test/to-dot.test.ts +112 -0
  20. package/test/utils/index.ts +1 -0
  21. package/test/utils/to-dot.ts +5 -0
package/README.ja.md CHANGED
@@ -1,19 +1,24 @@
1
1
  [![GitHub Action](https://github.com/kamiazya/ts-graphviz/workflows/NodeCI/badge.svg)](https://github.com/kamiazya/ts-graphviz/actions?workflow=NodeCI)
2
2
  [![npm version](https://badge.fury.io/js/ts-graphviz.svg)](https://badge.fury.io/js/ts-graphviz)
3
3
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
- [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
5
4
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
6
- ![npm](https://img.shields.io/npm/dm/ts-graphviz) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
7
- [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg)](#contributors)
8
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
9
-
10
- [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.ja.md)
5
+ [![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4?logo=prettier&style=flat)](https://github.com/facebook/jest)
6
+ [![test: jest](https://img.shields.io/badge/tested%20with-jest-99424f?logo=jest&style=flat)](https://github.com/facebook/jest)
7
+ ![node version](https://img.shields.io/node/v/ts-graphviz)
8
+ ![npm](https://img.shields.io/npm/dm/ts-graphviz)
9
+ [![All Contributors](https://img.shields.io/github/all-contributors/ts-graphviz/ts-graphviz?color=orange)](#contributors)
11
10
 
12
11
  # ts-graphviz
13
12
 
14
13
  TypeScriptの ための [Graphviz](https://graphviz.gitlab.io/) ライブラリ
15
14
 
16
- > [GitHub](https://github.com/ts-graphviz/ts-graphviz) | [npm](https://www.npmjs.com/package/ts-graphviz)([yarn](https://github.com/ts-graphviz/ts-graphviz)) | [document](https://ts-graphviz.github.io/ts-graphviz/)
15
+ [![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=GitHub&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
16
+ [![npm](https://img.shields.io/badge/-npm-CB3837?logo=npm&style=flat)](https://www.npmjs.com/package/ts-graphviz)
17
+ [![yarn](https://img.shields.io/badge/-yarn-ffffff?logo=Yarn&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
18
+ [![Refarence](https://img.shields.io/badge/-Refarence-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
19
+ [![Suponser](https://img.shields.io/badge/-Suponser-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/kamiazya)
20
+
21
+ > [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.ja.md)
17
22
 
18
23
  ## 主な機能 ✨
19
24
 
@@ -151,7 +156,7 @@ const dot = toDot(g);
151
156
 
152
157
  #### 宣言的な API 😎
153
158
 
154
- `Graph` や `Digraph` を作成する際に、より **DOT** 言語に近い記法を提供するために _Builder Functuion_ を使うことができます。
159
+ `Graph` や `Digraph` を作成する際に、より **DOT** 言語に近い記法を提供するために _Model Factory_ を使うことができます。
155
160
 
156
161
  **Model** にも宣言的な API を用意しており、一貫して宣言的なパラダイムを選択することもできます。
157
162
 
@@ -216,6 +221,8 @@ const dot = toDot(G);
216
221
 
217
222
  ### `ts-graphviz/ast` モジュール 🔢
218
223
 
224
+ > このパッケージのステータスは ![beta](https://img.shields.io/badge/-beta-orange) です。
225
+
219
226
  高度な利用のためにASTを扱うためのAPIを提供しています。
220
227
 
221
228
  ![State Machine](./media/state-machine.svg)
package/README.md CHANGED
@@ -1,19 +1,24 @@
1
1
  [![GitHub Action](https://github.com/kamiazya/ts-graphviz/workflows/NodeCI/badge.svg)](https://github.com/kamiazya/ts-graphviz/actions?workflow=NodeCI)
2
2
  [![npm version](https://badge.fury.io/js/ts-graphviz.svg)](https://badge.fury.io/js/ts-graphviz)
3
3
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
- [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
5
4
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
6
- ![npm](https://img.shields.io/npm/dm/ts-graphviz) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
7
- [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg)](#contributors)
8
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
9
-
10
- > [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.ja.md)
5
+ [![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4?logo=prettier&style=flat)](https://github.com/facebook/jest)
6
+ [![test: jest](https://img.shields.io/badge/tested%20with-jest-99424f?logo=jest&style=flat)](https://github.com/facebook/jest)
7
+ ![node version](https://img.shields.io/node/v/ts-graphviz)
8
+ ![npm](https://img.shields.io/npm/dm/ts-graphviz)
9
+ [![All Contributors](https://img.shields.io/github/all-contributors/ts-graphviz/ts-graphviz?color=orange)](#contributors)
11
10
 
12
11
  # ts-graphviz
13
12
 
14
13
  [Graphviz](https://graphviz.gitlab.io/) library for TypeScript.
15
14
 
16
- > [GitHub](https://github.com/ts-graphviz/ts-graphviz) | [npm](https://www.npmjs.com/package/ts-graphviz)([yarn](https://github.com/ts-graphviz/ts-graphviz)) | [document](https://ts-graphviz.github.io/ts-graphviz/)
15
+ [![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=GitHub&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
16
+ [![npm](https://img.shields.io/badge/-npm-CB3837?logo=npm&style=flat)](https://www.npmjs.com/package/ts-graphviz)
17
+ [![yarn](https://img.shields.io/badge/-yarn-ffffff?logo=Yarn&style=flat)](https://github.com/ts-graphviz/ts-graphviz)
18
+ [![Refarence](https://img.shields.io/badge/-Refarence-3178C6?logo=TypeScript&style=flat&logoColor=fff)](https://ts-graphviz.github.io/ts-graphviz/)
19
+ [![Suponser](https://img.shields.io/badge/-Suponser-fff?logo=GitHub%20Sponsors&style=flat)](https://github.com/sponsors/kamiazya)
20
+
21
+ > [English](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.md) | [日本語](https://github.com/ts-graphviz/ts-graphviz/blob/main/README.ja.md)
17
22
 
18
23
  ## Key Features ✨
19
24
 
@@ -150,7 +155,7 @@ const dot = toDot(g);
150
155
 
151
156
  #### Declarative API 😎
152
157
 
153
- When creating `Graph` or `Digraph`, you can use _Builder Function_ to provide a notation more similar to the **DOT** language.
158
+ When creating `Graph` or `Digraph`, you can use _Model Factory_ to provide a notation more similar to the **DOT** language.
154
159
 
155
160
  **Model** also has a declarative API, so you can consistently choose a declarative paradigm.
156
161
 
@@ -216,6 +221,8 @@ const dot = toDot(G);
216
221
 
217
222
  ### `ts-graphviz/ast` Module 🔢
218
223
 
224
+ > This module status is ![beta](https://img.shields.io/badge/-beta-orange).
225
+
219
226
  An API is provided to handle ASTs for advanced use.
220
227
 
221
228
  ![State Machine](./media/state-machine.svg)