IF Commons GitHub

lens/program

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

The program lens (commons 0011-documentation FR-030): the command-line, tool and route programs of a library built on commons headless, as pages for a person and an agent and as a Markdown twin and a JSON file for each. It is given a function that makes LayeredModel values (headless's own describe, which gives one model for each tier of a program) and knows nothing of headless: what a program says is read from the values. The models of the tiers of one program have the same element ids, so each model is read by itself and never merged with another, and every tier has its own pages.

Pages: the programs and their tiers; for each tier its verbs (what each does, its effect, and which surfaces draw it or why one does not), the problem codes and exit statuses it can give, the plugins that contribute verbs and the findings of the builder; and for each verb its action as governance says it, its options and operands, examples, and the command, tool and route it becomes.

Source: commons/docs/src/lens/program.ts

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

ProgramLensOptionsinterfaceno test imports it
interface ProgramLensOptions

What the lens is given.

MemberTypeWhat it is
namestringIts name, which the build reports it by.
group?stringThe group of the section the pages are in.
source() => Promise<readonly LayeredModel[]> | readonly LayeredModel[]Makes the models of the programs: one for each tier of each program.
programLensfunction
function programLens(options: ProgramLensOptions): Lens

The program lens.

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

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