Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-001
The spec kits read for the site (commons 0011-documentation FR-015, FR-024), in either of their two layouts. Commons' layout: the register of numbers, the register of what enforces each requirement, and each specification in force with its header (title, status, owner, domain, part), its **Input:** line, its requirements, success criteria and open questions, and its text; it reads what commons/tools/mizan-check.ts checks, and assumes the folder passes that check. The plain layout of Spec Kit: every folder of the specifications that holds a spec.md, its title, status and input where it has them, its requirements in either form (- **FR-001** text or - **FR-001**: text), the reviewed.tsv beside it, and the constitution.
Source: commons/docs/src/extract/specs.ts
0 of 4 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.
Constitutioninterfaceno test imports itinterface Constitution
A constitution: its file, its title and its text after the title.
| Member | Type | What it is |
|---|
file | string | Its file, from the root. |
title | string | Its title, from its first heading. |
body | string | Its text after the title, as Markdown. |
Enforcementinterfaceno test imports itinterface Enforcement
A row of enforcement.tsv, or of a reviewed.tsv.
| Member | Type | What it is |
|---|
requirement | string | The requirement, as 0009-example FR-001. |
mechanism | Mechanism | How. |
by | string | Who: <repository>: <command>, a requirement that defines the review, or -. |
note | string | The note, or the reason of a review. |
Specinterfaceno test imports itinterface Spec
A specification in force.
| Member | Type | What it is |
|---|
id | string | Its folder's name: 0009-example. |
file | string | Its spec.md, from the root. |
layout | "commons" | "spec-kit" | The layout of its spec kit. |
title | string | Its title, after # Feature Specification: (or, in the plain layout, after # NNN: ). |
status | string | Draft, Adopted, Superseded, or what a plain specification says; empty where it says nothing. |
owner | string | Its owner, where it says. |
domain | string | Its domain, where it says. |
partOf? | string | The specification it is part of, where it says. |
input | string | Its **Input:** line, as Markdown; empty where it has none. |
body | string | Its text after the header and the input, as Markdown. |
requirements | readonly SpecItem[] | Its requirements, in order. |
SpecKitinterfaceno test imports itinterface SpecKit
The spec kits: their specifications in force, in order, the enforcement of each requirement, where they come from, and a constitution.
| Member | Type | What it is |
|---|
specs | readonly Spec[] | The specifications in force. |
enforcement | ReadonlyMap<string, Enforcement> | The rows of enforcement.tsv and of every reviewed.tsv, by requirement. |
sources | readonly KitSource[] | The kits read, in order. |
constitution? | Constitution | The constitution of a plain kit, where it has one. |