IF Commons GitHub

Kanon

The pattern of a library built in three layers, Governance, Logical and Physical (commons 0033-kanon): the type of a library's table of layers, read from the field kanon of its manifest; the import check that holds the table (one finding code for each way an import can break it); the check that no annotation of Governance is dropped, made for each instance (dialect) of a host, and the matrix of requirement by instance; the instances, plugins and family of a host and the check of the packages that extend it; and the types-only contract LayeredModel, the shape of the layered model the documentation generator reads. A utility library of a single level: it is not itself built in layers. Published to npm as compiled modules with their declarations; it depends on Core, the formats and the system.

FactValue
Version0.3.5
Conformance levelL1
Distributedgithub, npm
LicensePolyForm-Noncommercial-1.0.0, source-available: free for noncommercial use, commercial use needs a license from the owner (see Licensing in Start here)
Import it as@intellectual-frontiers/kanon

Areas

Imports

Core, Crypto, Formats, System

Imported by

Headless, Libraries

Specifications

NumberSpecificationRequirements
0001Kanon checker14
0002Kanon content checks11

Folders

FolderWhat it isMay import
spec-kit/The library's own specifications, numbered from 0001.nothing: Markdown and TSV
src/The table (table.ts), the import check (imports.ts), the check of dropped annotations (dropped.ts, account.ts), the matrix (matrix.ts), the family and its names (family.ts), the check of an extension (extensions.ts), the types of the model (model.ts), the host side that reads a library's folder (host.ts) and the command (check.ts)., the checks of a model's vocabulary and relations (vocabulary.ts), the bundle of a model and its verification (bundle.ts)core, crypto, the formats and the system, by package name
suite/The tests: every requirement of the specification, each code of the check found from a table.src/; fast-check; the test module of commons, by package name
tools/The trace check and the packer bun run verify runs.the kernel, the runtime and the packer of commons, by package name

Quality

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

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