Buildclassclass BuildOne build: what it reads, what it has made, and what it has found.
| Member | Type | What it is |
|---|---|---|
config | Config | The configuration. |
root | string | The repository's root. |
kit | SpecKit | The spec kit. |
pages | Page[] | The pages made so far. |
found | Finding[] | What has been found. |
files | Map<string, string> | The page that shows each file of the repository, by its path from the root. |
apiFiles | Map<string, string> | The API page of each source file, by its path from the root: where its exports have their anchors. |
declared | Map<string, { readonly path: string; readonly anchor: string; }> | Where each export is shown on the page of the file it is declared in, by file#name (the name it is declared with). |
exports | Map<string, Map<string, { readonly path: string; readonly anchor: string; }>> | Each export's page and anchor, by area and name. |
entityPages | Map<string, string> | The page that shows a model's entity, by its area and export name (arca!party). |
citations | Map<string, Set<string>> | The pages that cite each specification (key 0009-example) and each requirement (key 0009-example FR-001). |
packageTitles | Map<string, string> | The title of each package, by its slug: what the pages of its specifications and the register call it. |
evidence | Evidence | What the tests, the issues and the tickets say, read from the files the configuration names (docs 0001-docs FR-009). |
trace | Trace | undefined | The files that prove each requirement and the files written to it, once the specification pages are made. |
index | LinkIndex | What links can reach. |
md | (text: string, scope: LinkScope) => Block[] | Markdown read with this build's links, for a scope. |
example | (text: string, scope: LinkScope) => Block[] | An example of TSDoc: Markdown where it has a fence, else TypeScript. |
line | (text: string, scope: LinkScope) => Inline[] | A run of Markdown with this build's links, as inlines. |
add | (page: Page) => void | A page made. |
abs | (rel: string) => string | A path of the repository, absolute, from its path from the root. |
exists | (rel: string) => boolean | Whether a path of the repository exists. |
read | (rel: string) => string | The text of a file of the repository. |