sysml-diagram 0.15.6 → 0.15.7
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 +8 -8
- package/out/main.js +960 -68
- package/out/main.js.map +4 -4
- package/package.json +1 -1
- package/resources/sysml.dimension-table.json +1 -1
package/README.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Headless SysML v2 / KerML diagram export. Renders the same views the
|
|
4
4
|
[SysML v2 VS Code extension](https://marketplace.visualstudio.com/items?itemName=voidaliot.vscode-sysml-v2)
|
|
5
|
-
draws
|
|
6
|
-
Geometry, and the Grid table
|
|
5
|
+
draws (General, Interconnection, Action Flow, State Transition, Sequence, Case,
|
|
6
|
+
Geometry, and the Grid table) from a terminal or a CI job. No VS Code, no
|
|
7
7
|
browser, no display server.
|
|
8
8
|
|
|
9
9
|
```bash
|
|
@@ -63,7 +63,7 @@ docs/vehicle.grv.csv
|
|
|
63
63
|
The Grid View is a table in the editor too, so it lands as CSV. Views with no
|
|
64
64
|
content for the anchor are skipped rather than written empty.
|
|
65
65
|
|
|
66
|
-
**A model with problems** still renders
|
|
66
|
+
**A model with problems** still renders. You get the artifact *and* the failure,
|
|
67
67
|
which is what you want when a pipeline goes red:
|
|
68
68
|
|
|
69
69
|
```console
|
|
@@ -75,7 +75,7 @@ exit=1
|
|
|
75
75
|
```
|
|
76
76
|
|
|
77
77
|
Diagnostics are one line each, `file:line:col: severity [CODE]: message`, on
|
|
78
|
-
stderr
|
|
78
|
+
stderr, so `sysml-diagram … 2>/dev/null` leaves only the written paths. Only
|
|
79
79
|
errors and warnings are shown; for the advisory notices use
|
|
80
80
|
[`sysml-validate --all`](https://www.npmjs.com/package/sysml-validate).
|
|
81
81
|
|
|
@@ -102,12 +102,12 @@ $ for model in models/*.sysml; do sysml-diagram export --file "$model" --all --o
|
|
|
102
102
|
## Your project's configuration is honoured
|
|
103
103
|
|
|
104
104
|
The CLI reads the same two files the editor writes, so a rendered diagram is the
|
|
105
|
-
diagram your team arranged
|
|
105
|
+
diagram your team arranged, not a fresh automatic layout of the same model:
|
|
106
106
|
|
|
107
|
-
- **`.vscode/sysml/project.json
|
|
107
|
+
- **`.vscode/sysml/project.json`**, project-scoped `sysml.preview.diagrams.*`
|
|
108
108
|
settings: default view, port labels, multiplicities, connector line style,
|
|
109
109
|
connect-point spacing, Case View subject boundary.
|
|
110
|
-
- **`.vscode/sysml/diagrams/<source>.json
|
|
110
|
+
- **`.vscode/sysml/diagrams/<source>.json`**, the per-anchor, per-view side-car:
|
|
111
111
|
node positions and sizes, port placements, connector waypoints and docking
|
|
112
112
|
anchors, layout direction, General View mode and quick filters, Interconnection
|
|
113
113
|
View compartment collapse, Grid preset and column order.
|
|
@@ -155,7 +155,7 @@ Render diagrams into build artifacts, or fail the build when the model breaks:
|
|
|
155
155
|
```
|
|
156
156
|
|
|
157
157
|
`sysml-diagram` writes the diagram even when the model has errors, and still
|
|
158
|
-
exits `1
|
|
158
|
+
exits `1`, so the artifact is there to look at when the gate fails.
|
|
159
159
|
|
|
160
160
|
## License
|
|
161
161
|
|