IF Commons GitHub

Kanon

2 specifications, 25 requirements. All libraries

0001 Kanon checker

RequirementMechanismWhoNote
FR-001checkbun run verifytable.test.ts: a table is decoded and every malformed table is refused with a sentence naming the unit
FR-002checkbun run verifyimports.test.ts: a file is placed in the most specific unit, instances one unit each, none where no unit holds it
FR-003checkbun run verifyimports.test.ts: static, side-effect, re-export and dynamic imports are read with their lines and comments are skipped
FR-004checkbun run verifyimports.test.ts: every code of the check is found from a table, a file set and an exports map, and an own unit is exempt
FR-005checkbun run verifydropped.test.ts: an annotation no disposition accounts for, a missing target and an unexplained unexpressed are kanon/dropped
FR-006checkbun run verifymodel.test.ts: the ids are built as agreed, and a model is assignable to the shape of the documentation generator's layered model
FR-007checkbun run verifyhost.test.ts: the table, the exports and the files are read from a folder, and the command judges against a baseline with exit 0, 1 and 2
FR-008checkbun run verifypacking: bun tools/pack.ts --check compiles the package, inspects its declarations and packs it
FR-009checkbun run verifytable.test.ts, model.test.ts, host.test.ts: smart constructors refuse what is not a folder, a package or an id, a unit is a sum, the codes are a closed union with a registry, a failure of the host is a value, and the host reads through a port; the compiler holds the exhaustive matches
FR-010checkbun run verifyextensions.test.ts: the family, instances, plugins and extends are decoded, each malformed form is refused with a sentence, and any JSON value is a table or a sentence
FR-011checkbun run verifyextensions.test.ts: a package is read as host, dialect or plugin by the rule, and a name made from any name or noun reads back as it (property test)
FR-012checkbun run verifyextensions.test.ts: the fixture host with two dialects and two plugins passes, and each new code is found from a table, files and exports
FR-013checkbun run verifymatrix.test.ts: the check of dropped annotations is made for each instance, with the instance in the key
FR-014checkbun run verifymatrix.test.ts: the matrix of the fixture, its Markdown and JSON, and for any dispositions the dropped cells are the findings (property test)

0002 Kanon content checks

RequirementMechanismWhoNote
FR-001checkbun run verifycontent.test.ts: a vocabulary and relations are optional on the model, and a model without them is as it was
FR-002checkbun run verifycontent.test.ts: duplicate ids, dangling relations, relations between layers, and the kinds and annotations a vocabulary does not list
FR-003checkbun run verifycontent.test.ts: each finding has its code in the closed union with a summary and a group (the compiler holds the switches)
FR-004checkbun run verifycontent.test.ts: a role with no extends and a host with a role are refused; the scope is read from the family
FR-005checkbun run verifycontent.test.ts: classify reads a package of another scope where the family takes any, and not where it takes its own
FR-006checkbun run verifycontent.test.ts: an extension of another scope is judged as any member, and refused for scope, role, name or unit
FR-007checkbun run verifycontent.test.ts: the table of a package with no library.ts is read from kanon.ts, and library.ts wins where both are there
FR-008checkbun run verifycontent.test.ts: a model is made into a bundle the same bytes twice, with the manifest of every file and not of itself
FR-009checkbun run verifycontent.test.ts: a bundle with a file changed, missing and extra is refused whole with each fault named, and a bad manifest is refused
FR-010checkbun run verifycontent.test.ts: a verified bundle loads equal to its model, and a verified file that is not of the form is the fault form
FR-011checkbun run verifytools/check.ts and the layers of the manifest: the bundle code imports core and crypto only; host.test.ts reads a folder as a bundle

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