IF Commons GitHub

Kanon

Quality: 64 tests: 64 passed, 0 failed, 0 skipped, 24 of 25 requirements proved, 0 open issues, 1 open ticket. The tests and issues of the library

Kanon, the pattern of a library built in three layers (commons 0033-kanon): Governance says what a thing is and what it may do, Logical is made from it, Physical carries it out; one rule, projected down, nothing lost. This package holds the type of the table of a library's layers, the import check that holds the table, the check that no annotation of Governance is dropped, the relations and the vocabulary of a model with their findings (modelFindings), the members of a family that are of another scope, the bundle of a model and its pure verification (makeBundle, verifyBundle), and the types-only contract LayeredModel that a Kanon library gives to be documented and traced. It is a utility library of a single level and is not itself built in layers.

Entry points

Modules

Examples

import { decodeTable, importFindings } from "@intellectual-frontiers/kanon";
const t = decodeTable({ package: "@intellectual-frontiers/x", units: [{ folder: "src/governance/", layer: "governance" }] });
if (t.kind === "ok") importFindings(t.value, [], {}); // []

Limits

What the modules of this area do not do, or do only in part, as each module's @limits says.

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