Skip to content

Commit 7330a45

Browse files
committed
feat: enhance README to clarify metamodel validation in IDE with ubCode diagnostics
1 parent d428a31 commit 7330a45

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

src/extensions/score_metamodel/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ those rules.
1212
`workflow`, etc.) including their fields, links, and extra options.
1313
2. **Generates `schemas.json`** from the metamodel so that sphinx-needs 6 can
1414
validate needs at parse time (required fields, regex patterns, link
15-
constraints).
15+
constraints). Because ubCode (the VS Code extension for sphinx-needs)
16+
evaluates these schemas during editing, **metamodel violations are shown
17+
as diagnostics directly in the IDE** -- catching errors early with
18+
lightweight, fast rendering, without needing a full Sphinx build.
1619
3. **Runs post-build checks** that go beyond what JSON Schema can express
1720
(graph traversals, prohibited words, ID format rules).
1821

@@ -63,7 +66,7 @@ sphinx-needs evaluates at parse time. Each schema entry has:
6366
because the `items` schema would incorrectly require all linked needs
6467
to match the plain type.
6568

66-
### Post-build Python checks
69+
### Post-build S-Core metamodel checks
6770

6871
Checks in `checks/` run after the Sphinx build and cover rules that
6972
JSON Schema cannot express:

0 commit comments

Comments
 (0)