Browse pages
Validate Standards
Name#
litespec-maintain validate checks the LiteSpec repository against its own authoring contract.
Synopsis#
litespec-maintain validate [--root <path>] [--warnings] [--format json] [--help]Description#
This command is the repository gate for every page, template, and identifier under docs/. It checks page contracts and section order, atomic Standards and Convention blocks, provision identity, inline verification lines, pattern pages and their wireframes, normative-language placement, heading capitalization, and ASCII prose. It also checks internal links, manifest paths, extension declarations, and the generated provision index.
Run it after changing any page, any template, or any authoring rule.
Arguments#
None.
Options#
| Option | Default | Effect |
|---|---|---|
--root <path> | the LiteSpec checkout | Selects the LiteSpec repository to read. |
--warnings | off | Lists every occurrence of the rules that report warnings. |
--format json | off | Writes one JSON object on standard output, with the errors and warnings as arrays. |
--help | off | Prints the synopsis, the options, and the exit codes, then exits zero. |
Exit Codes#
| Code | Meaning |
|---|---|
0 | Every authoring check passed. |
1 | At least one check reported a defect. |
2 | The usage is invalid, or an input file is unreadable. |
Examples#
Validate the repository from its root:
litespec-maintain validateValidate another checkout and list every warning occurrence:
litespec-maintain validate --root ../standards --warningsUnderneath#
The provision-index comparison is separately runnable, and reports the same defect this command reports as PROVISIONS_STALE:
litespec-maintain provisions --checkThe remaining checks have no separate entry point. They run only as part of this command.