IF Commons GitHub

about

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

The typed facts of a package of commons that its documentation shows (commons 0011-documentation FR-005, FR-008): what the package is, the specification it implements, its folders and what each may import, the commands that work on it, the rules it keeps and what enforces each, its areas (each with its entry points, its specification, its phases and its examples), its layers and its facts. Each package keeps one About value in an about.ts at its root, which no entry point exports; prose is TSDoc, and only what has a shape is here, so that a test can hold it to the code. Types only: nothing here runs.

import type { About } from "@intellectual-frontiers/core/about";
export const about: About = {
  title: "Example",
  summary: "What the example is, in a sentence.",
  spec: { repo: "commons", id: "0009-example" },
};

Source: commons/core/src/about.ts

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

AboutSpecinterfaceno test imports it
interface AboutSpec

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.
AboutFolderinterface
interface AboutFolder

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).

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

AboutCommandinterfaceno test imports it
interface AboutCommand

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" };

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

AboutRuleinterfaceno test imports it
interface AboutRule

A rule the part keeps, and what enforces it.

MemberTypeWhat it is
rulestringThe rule, in a sentence of Markdown.
enforcedByreadonly AboutEnforcer[]What enforces it.
AboutPhaseStatetypeno test imports it
type AboutPhaseState = "here" | "not yet";

Whether a phase of the work is done.

AboutPhaseinterfaceno test imports it
interface AboutPhase

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.
AboutExampleinterfaceno test imports it
interface AboutExample

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.
AboutAreainterface
interface AboutArea

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.

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

Aboutinterface
interface About

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.

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

AboutLayerinterfaceno test imports it
interface AboutLayer

A folder of a library built in layers.

MemberTypeWhat it is
folderstringThe folder, relative to the library.
layerstringThe layer it is in: governance, logical or physical.
mayImport?readonly string[]The folders of the library that its files may import, where it names them.
AboutFactinterfaceno test imports it
interface AboutFact

One fact of a package: a label and its value.

MemberTypeWhat it is
labelstringWhat it is: Version.
valuestringIts value, in Markdown: 0.9.0.

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