@yalehwang/plantuml-js 0.4.0 → 0.4.1
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.
- package/README.md +20 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -6,9 +6,28 @@ default, `@viz-js/viz` (WASM Graphviz) as an option.
|
|
|
6
6
|
|
|
7
7
|
> **Engine status** — `'viz'` is **experimental**. It reaches only a fraction
|
|
8
8
|
> of `'elk'`'s area utilization and still routes a few edges through unrelated
|
|
9
|
-
> nodes on large package diagrams. See
|
|
9
|
+
> nodes on large package diagrams. See
|
|
10
|
+
> [`docs/viz-decision.md`](https://github.com/yaleh/plantuml-js/blob/author/docs/viz-decision.md)
|
|
10
11
|
> for the measured comparison. Use `'elk'` (the default) for production diagrams.
|
|
11
12
|
|
|
13
|
+
## What it renders
|
|
14
|
+
|
|
15
|
+
`@yalehwang/plantuml-js` turns a PlantUML class diagram into a styled SVG. Here
|
|
16
|
+
is a minimal diagram through the default `'elk'` engine — three-compartment
|
|
17
|
+
class/interface boxes, a package, and implementation / composition / dependency
|
|
18
|
+
edges:
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
The same pipeline on a real medium-size architecture graph (package grouping,
|
|
23
|
+
orthogonal edge routing, bundled arrowheads):
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
See the [gallery](https://github.com/yaleh/plantuml-js/blob/author/docs/gallery.md)
|
|
28
|
+
for every figure's source `.puml`, its SVG output, and the `elk` vs `viz`
|
|
29
|
+
comparison.
|
|
30
|
+
|
|
12
31
|
## Install
|
|
13
32
|
|
|
14
33
|
```bash
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yalehwang/plantuml-js",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "Pure-TypeScript PlantUML class diagram renderer (MIT)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -39,6 +39,8 @@
|
|
|
39
39
|
"typecheck": "tsc -p tsconfig.test.json",
|
|
40
40
|
"test": "vitest run",
|
|
41
41
|
"demo:build": "node scripts/build-demo.mjs",
|
|
42
|
+
"docs": "node scripts/render-docs.mjs",
|
|
43
|
+
"docs:check": "node scripts/render-docs.mjs --check",
|
|
42
44
|
"release": "node scripts/release.mjs",
|
|
43
45
|
"prepublishOnly": "npm run typecheck && npm run build && node scripts/check-dist-clean.mjs"
|
|
44
46
|
},
|