proschi 0.2.0 → 0.3.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.
- package/README.md +11 -2
- package/dist/cli.cjs +1850 -83
- package/dist/render.cjs +224 -192
- package/dist/server.cjs +1840 -161
- package/grammar/proschi.tmLanguage.json +110 -0
- package/package.json +1 -1
- package/schema/proschi-diagram.schema.json +656 -0
package/README.md
CHANGED
|
@@ -10,7 +10,9 @@ proschi check docs/ # validate every *.proschi file below docs/
|
|
|
10
10
|
proschi check --strict --openapi orders=specs/orders.yaml docs/ # also against an OpenAPI spec
|
|
11
11
|
proschi parse checkout.proschi # the parsed diagram as JSON
|
|
12
12
|
proschi fmt docs/ # format files in place (--check: only report, exit 1 for CI)
|
|
13
|
-
proschi render checkout.proschi --out diagrams # SVG diagrams (also --format md|html)
|
|
13
|
+
proschi render checkout.proschi --out diagrams # SVG diagrams (also --format md|html|hld-md|hld-html)
|
|
14
|
+
proschi test docs/ # run requirements and tests (exit 1 on a failure)
|
|
15
|
+
proschi analyze shortener.proschi # load, latency, availability and cost per node
|
|
14
16
|
proschi-language-server --stdio # for any editor with an LSP client
|
|
15
17
|
```
|
|
16
18
|
|
|
@@ -24,10 +26,17 @@ OpenAPI 3.0/3.1 specs of the services they call (endpoints, status codes,
|
|
|
24
26
|
JSON payloads), mapped in a `proschi.json` or with `--openapi`: see
|
|
25
27
|
[Checking against OpenAPI](https://github.com/gvart/proschi/blob/main/docs/EDITORS.md#checking-against-openapi).
|
|
26
28
|
|
|
29
|
+
`test` runs the `requirements { … }` and `test "…" { … }` blocks of each file
|
|
30
|
+
against a capacity model of its `traffic { … }` (`--format text|github|json`);
|
|
31
|
+
`analyze` prints that model as a table (`--format text|json`). The language
|
|
32
|
+
server reports failing requirements and tests as warnings and adds load to
|
|
33
|
+
node hovers. The model and its default numbers:
|
|
34
|
+
[Simulation and tests](https://github.com/gvart/proschi/blob/main/docs/EDITORS.md#simulation-and-tests).
|
|
35
|
+
|
|
27
36
|
## Rendering
|
|
28
37
|
|
|
29
38
|
```
|
|
30
|
-
proschi render [--out <dir>] [--format svg|md|html] <file>
|
|
39
|
+
proschi render [--out <dir>] [--format svg|md|html|hld-md|hld-html] <file>
|
|
31
40
|
```
|
|
32
41
|
|
|
33
42
|
- `svg` (default): `architecture.svg`, plus `<usecase>--<scenario>.svg` with a
|