Generate Provisions

Name#

litespec-maintain provisions writes the provision index and its data file, resolving every identifier to its page, conformance level, and checked share.

Synopsis#

litespec-maintain provisions [--root <path>] [--check] [--help]

Description#

This command rebuilds docs/reference/provisions.md and docs/reference/provisions.json from the active standards, so a citation reaches its heading in one step. The page and the data file carry each provision with its scope, conformance level, strength, and the mark and evidence from its inline verification line, with the conformance level right after the artifact. The page also states the checked share of rules for each page: the provisions at strength rule that carry a Checked by line, as a share of the provisions at strength rule on that page. Each provision takes the conformance level of its page folder, or the level its conformance field states when that level differs, as the Provision Scopes page states.

Run it after adding, renaming, or removing a provision. The next run overwrites a hand edit, so never edit the page or the data file directly.

Arguments#

None.

Options#

Exit Codes#

Examples#

Rebuild the page and the data file after a provision change:

litespec-maintain provisions

Compare without writing, which is what continuous integration runs:

litespec-maintain provisions --check

Underneath#

litespec-maintain validate reads the same builder and reports a stale page or data file as PROVISIONS_STALE. Nothing beneath this command is separately runnable.