IF Commons GitHub

sources

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 it
interface Area extends AboutArea

An area of a package, with the package it is in.

MemberTypeWhat it is
pkgPackageThe package.
dirstringThe folder of its first entry point, from the root: the files of the area.
titlestringIts name, as a title.
slugstringIts name in the site's addresses: lower-case words joined by hyphens.
entryPointsreadonly string[]Its entry points, relative to about.ts; the first one's module comment is the area's overview.
folder?stringThe 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?AboutSpecThe 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 it
interface Package

A package read: where it is, its About, and the file that holds it, from the root.

MemberTypeWhat it is
dirstringIts folder, from the root: "" for the root itself.
slugstringIts name in the site's addresses.
aboutAboutIts About.
filestringThe file its About is written in, from the root: its about.ts, or the configuration.

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