Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-001
The packages a site is made from (commons 0011-documentation FR-004, FR-005, FR-027), each read from its about.ts or from the About value its configuration gives, and the findings of holding an about to the code: a folder, an entry point or an example that does not exist, a command that is not a script of the package, a rule enforced by a test, a lint rule or a compiler option that does not exist.
Source: commons/docs/src/sources.ts
0 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.
Areainterfaceno test imports itinterface Area extends AboutArea
An area of a package, with the package it is in.
| Member | Type | What it is |
|---|
pkg | Package | The package. |
dir | string | The folder of its first entry point, from the root: the files of the area. |
title | string | Its name, as a title. |
slug | string | Its name in the site's addresses: lower-case words joined by hyphens. |
entryPoints | readonly string[] | Its entry points, relative to about.ts; the first one's module comment is the area's overview. |
folder? | string | The folder, relative to about.ts, that holds the files of the area; where it is not given, the folder of the first entry point. |
spec? | AboutSpec | The specification it implements, where it has its own. |
phases? | readonly AboutPhase[] | Its phases, where it is built a phase at a time. |
examples? | readonly AboutExample[] | Its examples. |
Packageinterfaceno test imports itinterface Package
A package read: where it is, its About, and the file that holds it, from the root.
| Member | Type | What it is |
|---|
dir | string | Its folder, from the root: "" for the root itself. |
slug | string | Its name in the site's addresses. |
about | About | Its About. |
file | string | The file its About is written in, from the root: its about.ts, or the configuration. |