IF Commons GitHub

build

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-001

The state of one build of the site (commons 0011-documentation FR-003, FR-023): the configuration and the repository it reads, its spec kit, the pages made so far, the findings, and what links can reach (the specifications and their requirements, the page that shows each file, and each export's page), with every citation that became a link, so that a specification's page can say which pages cite it.

Source: commons/docs/src/build.ts

1 of 1 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

Buildclass
class Build

One build: what it reads, what it has made, and what it has found.

MemberTypeWhat it is
configConfigThe configuration.
rootstringThe repository's root.
kitSpecKitThe spec kit.
pagesPage[]The pages made so far.
foundFinding[]What has been found.
filesMap<string, string>The page that shows each file of the repository, by its path from the root.
apiFilesMap<string, string>The API page of each source file, by its path from the root: where its exports have their anchors.
declaredMap<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).
exportsMap<string, Map<string, { readonly path: string; readonly anchor: string; }>>Each export's page and anchor, by area and name.
entityPagesMap<string, string>The page that shows a model's entity, by its area and export name (arca!party).
citationsMap<string, Set<string>>The pages that cite each specification (key 0009-example) and each requirement (key 0009-example FR-001).
packageTitlesMap<string, string>The title of each package, by its slug: what the pages of its specifications and the register call it.
evidenceEvidenceWhat the tests, the issues and the tickets say, read from the files the configuration names (docs 0001-docs FR-009).
traceTrace | undefinedThe files that prove each requirement and the files written to it, once the specification pages are made.
indexLinkIndexWhat 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) => voidA page made.
abs(rel: string) => stringA path of the repository, absolute, from its path from the root.
exists(rel: string) => booleanWhether a path of the repository exists.
read(rel: string) => stringThe text of a file of the repository.

Imported by 4 tests of the run (4 passed, 0 failed): the library's results

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