IF Commons GitHub

extract/specs

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 it
interface Constitution

A constitution: its file, its title and its text after the title.

MemberTypeWhat it is
filestringIts file, from the root.
titlestringIts title, from its first heading.
bodystringIts text after the title, as Markdown.
Enforcementinterfaceno test imports it
interface Enforcement

A row of enforcement.tsv, or of a reviewed.tsv.

MemberTypeWhat it is
requirementstringThe requirement, as 0009-example FR-001.
mechanismMechanismHow.
bystringWho: <repository>: <command>, a requirement that defines the review, or -.
notestringThe note, or the reason of a review.
Specinterfaceno test imports it
interface Spec

A specification in force.

MemberTypeWhat it is
idstringIts folder's name: 0009-example.
filestringIts spec.md, from the root.
layout"commons" | "spec-kit"The layout of its spec kit.
titlestringIts title, after # Feature Specification: (or, in the plain layout, after # NNN: ).
statusstringDraft, Adopted, Superseded, or what a plain specification says; empty where it says nothing.
ownerstringIts owner, where it says.
domainstringIts domain, where it says.
partOf?stringThe specification it is part of, where it says.
inputstringIts **Input:** line, as Markdown; empty where it has none.
bodystringIts text after the header and the input, as Markdown.
requirementsreadonly SpecItem[]Its requirements, in order.
SpecKitinterfaceno test imports it
interface SpecKit

The spec kits: their specifications in force, in order, the enforcement of each requirement, where they come from, and a constitution.

MemberTypeWhat it is
specsreadonly Spec[]The specifications in force.
enforcementReadonlyMap<string, Enforcement>The rows of enforcement.tsv and of every reviewed.tsv, by requirement.
sourcesreadonly KitSource[]The kits read, in order.
constitution?ConstitutionThe constitution of a plain kit, where it has one.

Titles, headings, exports, tables, columns and requirements. Esc closes.