IF Commons GitHub

re-exports

What Documentation generator exports from elsewhere, so that its users need import nothing else.

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

Aboutinterfaceno test imports it
interface About

Declared in commons/core/src/about.ts

The typed facts of a package, or of a repository as a whole.

MemberTypeWhat it is
titlestringIts name, as a title.
summarystringWhat it is, in a paragraph of Markdown: the first thing a reader sees.
spec?AboutSpecThe specification it implements, where one does.
folders?readonly AboutFolder[]Its folders and what each may import.
commands?readonly AboutCommand[]The commands that work on it, run from the folder of its about.ts.
rules?readonly AboutRule[]The rules it keeps.
areas?readonly AboutArea[]Its areas.
examples?readonly AboutExample[]Its examples that belong to no one area.
facts?readonly AboutFact[]Facts its page shows in a small table beside the summary: a label and its value, as a version or a conformance level.
layers?readonly AboutLayer[]The folders of a library built in layers, each with the layer it is in and what it may import of the others: its page shows them as bands.
AboutAreainterfaceno test imports it
interface AboutArea

Declared in commons/core/src/about.ts

An area of a package: a part with an entry point, whose exports are its API and whose entry point's module comment is its overview.

MemberTypeWhat it is
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.
AboutCommandinterfaceno test imports it
interface AboutCommand

Declared in commons/core/src/about.ts

A command that works on the part, run from the folder of its about.ts.

MemberTypeWhat it is
runstringThe command line, as a person types it.
doesstringWhat it does, in a sentence.
AboutEnforcertypeno test imports it
type AboutEnforcer =
  | { readonly kind: "test"; readonly file: string }
  | { readonly kind: "lint"; readonly rule: string }
  | { readonly kind: "compiler"; readonly option: string }
  | { readonly kind: "review" };

Declared in commons/core/src/about.ts

What enforces a rule: a test file, a rule of the lint plugin, an option of the compiler, or a person's review.

AboutExampleinterfaceno test imports it
interface AboutExample

Declared in commons/core/src/about.ts

An example: a file the compiler checks and a suite runs, and the committed outputs it makes.

MemberTypeWhat it is
filestringThe file, relative to the about.ts that names it.
whatstringWhat it shows, in a sentence.
outputs?readonly string[]The committed files it makes, relative to the same folder, shown beside it.
AboutFolderinterfaceno test imports it
interface AboutFolder

Declared in commons/core/src/about.ts

A folder of the part, with what it is and what its files may import.

MemberTypeWhat it is
pathstringThe folder (or file), relative to the about.ts that names it, as kernel/ or runtime/test.ts.
whatstringWhat it holds, in a sentence of Markdown.
mayImportreadonly string[]What its files may import, each in a few words (kernel/ only, node: builtins).
AboutPhaseinterfaceno test imports it
interface AboutPhase

Declared in commons/core/src/about.ts

A phase of a library that is built a phase at a time.

MemberTypeWhat it is
nnumberIts number.
whatstringWhat it brings, in a line.
stateAboutPhaseStateWhether it is done.
AboutPhaseStatetypeno test imports it
type AboutPhaseState = "here" | "not yet";

Declared in commons/core/src/about.ts

Whether a phase of the work is done.

AboutRuleinterfaceno test imports it
interface AboutRule

Declared in commons/core/src/about.ts

A rule the part keeps, and what enforces it.

MemberTypeWhat it is
rulestringThe rule, in a sentence of Markdown.
enforcedByreadonly AboutEnforcer[]What enforces it.
AboutSpecinterfaceno test imports it
interface AboutSpec

Declared in commons/core/src/about.ts

A specification, by its repository and its folder's name (commons, 0009-example). Only the repository's own become links.

MemberTypeWhat it is
repostringThe repository whose spec kit holds it.
idstringThe specification's folder: its number and its slug.

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