sysml-validate 0.15.4 → 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 +7 -7
- package/out/main.js +903 -74
- package/out/main.js.map +4 -4
- package/package.json +1 -1
- package/resources/sysml.dimension-table.json +1 -1
- package/resources/sysml.library.index.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Headless SysML v2 / KerML validation. Runs the same parser, linker, and
|
|
4
4
|
diagnostics as the
|
|
5
5
|
[SysML v2 VS Code extension](https://marketplace.visualstudio.com/items?itemName=voidaliot.vscode-sysml-v2)
|
|
6
|
-
|
|
6
|
+
Problems panel, in a terminal or a CI job. No VS Code, no browser, no
|
|
7
7
|
display server.
|
|
8
8
|
|
|
9
9
|
```bash
|
|
@@ -26,7 +26,7 @@ models/vehicle.sysml
|
|
|
26
26
|
✓ 2 files checked, no problems found
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Colour is used on a terminal and dropped everywhere else
|
|
29
|
+
Colour is used on a terminal and dropped everywhere else, a pipe, a log file,
|
|
30
30
|
or a coding agent's chat window gets exactly the plain text above. `--color` and
|
|
31
31
|
`--no-color` force it either way, and `NO_COLOR` is honoured.
|
|
32
32
|
|
|
@@ -62,7 +62,7 @@ and the rest resolve with nothing else installed.
|
|
|
62
62
|
## Examples
|
|
63
63
|
|
|
64
64
|
**Check one file while you work.** Paths, positions, severity, and the
|
|
65
|
-
diagnostic code
|
|
65
|
+
diagnostic code, everything needed to jump to the problem:
|
|
66
66
|
|
|
67
67
|
```console
|
|
68
68
|
$ sysml-validate models/vehicle.sysml
|
|
@@ -72,7 +72,7 @@ models/vehicle.sysml
|
|
|
72
72
|
✖ 1 problem (1 error) in 1 of 1 file
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
**See the advisory notices too.** Hints and info are out of the way by default
|
|
75
|
+
**See the advisory notices too.** Hints and info are out of the way by default,
|
|
76
76
|
`--all` brings them in:
|
|
77
77
|
|
|
78
78
|
```console
|
|
@@ -99,7 +99,7 @@ Compact prints **nothing at all** on a clean run, so `[ -s report.txt ]` and
|
|
|
99
99
|
**Structured output** for a script or a dashboard:
|
|
100
100
|
|
|
101
101
|
```console
|
|
102
|
-
$ sysml-validate models/ --format json | jq '.counts
|
|
102
|
+
$ sysml-validate models/ --format json | jq '.counts.diagnostics[0].code'
|
|
103
103
|
{
|
|
104
104
|
"error": 2,
|
|
105
105
|
"warning": 0,
|
|
@@ -143,14 +143,14 @@ exit=1
|
|
|
143
143
|
## Your project's configuration is honoured
|
|
144
144
|
|
|
145
145
|
The validator reads the settings your team commits, in the editor's own
|
|
146
|
-
precedence
|
|
146
|
+
precedence, `.vscode/settings.json` first, then `.vscode/sysml/project.json`:
|
|
147
147
|
|
|
148
148
|
| Setting | Effect |
|
|
149
149
|
|---|---|
|
|
150
150
|
| `sysml.lint.profile` | `default` / `quiet` / `strict` style-notice volume |
|
|
151
151
|
| `sysml.validation.severities` | Per-code severity overrides (e.g. `{ "SEM006": "warning" }`) |
|
|
152
152
|
| `sysml.diagnostics.unusedImports` | `off` / `warning` / `error` |
|
|
153
|
-
| `sysml.diagnostics.units` | UNIT001
|
|
153
|
+
| `sysml.diagnostics.units` | UNIT001 to UNIT005 dimensional analysis on/off |
|
|
154
154
|
|
|
155
155
|
`--lint-profile` overrides the profile for one run, and `--no-config` ignores
|
|
156
156
|
both files. Note that `sysml.validation.severities` covers the validator's own
|