IF Commons GitHub

check

Check a Mizan folder against the rules Mizan adds to the format (commons 0003-mizan FR-013 to FR-015, 0018-standards-first FR-009).

bun commons/libraries/src/check.ts check commons/spec-kit against commons/spec-kit/mizan.baseline.txt bun commons/libraries/src/check.ts --root DIR check DIR (a folder holding specs/) bun commons/libraries/src/check.ts --register DIR the folder of the registers (and of the baseline, mizan.baseline.txt beside registry.tsv) where it is not the root bun commons/libraries/src/check.ts --defined-by also hold commons' own terms to the requirement-to-term stage (0003-mizan FR-044), which a harness turns on with specTerms.definitions bun commons/libraries/src/check.ts --baseline FILE hold the findings against FILE bun commons/libraries/src/check.ts --write-baseline write the baseline from today's findings (to start it, or to shrink it: never to add a line to pass) bun commons/libraries/src/check.ts --level L0|L1|L2|L3 hold the folder to the rules of that conformance level only (commons 0028-conformance-levels; L3, every rule, where it is not given) bun commons/libraries/src/check.ts --all [--repo DIR] also run the verify of every library a manifest declares, each from its folder (the libraries of DIR, this repository by default); without it nothing inside a library is read bun commons/libraries/src/check.ts --today YYYY-MM-DD count the 90 days of a decision from that day (for a test); commons' own folder also holds its ontologies' terms to 0018-standards-first FR-003 to FR-005

It prints every new finding and every stale baseline line on standard error, writes nothing without --write-baseline, and exits 1 where a finding is new or a baseline line no longer occurs, so that the baseline only shrinks (0003-mizan FR-015). The rules are plugins (rules.ts); this file only reads the folder and judges.

Spec: 0001-libraries FR-008

Source: commons/libraries/src/check.ts

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

termRecordsOffunctionno test imports it
function termRecordsOf(audit: readonly Individual<"mz:OntologyTerm", ValuesOf<{ readonly label: Field<LangString, "one">… (725 characters)
function termRecordsOf(audit: readonly Individual<"mz:OntologyTerm", ValuesOf<{ readonly label: Field<LangString, "one">; readonly termIri: Field<string, "one">; readonly basis: Field<Named<"mz:Basis">, "one">; readonly standardTerm: Field<string, "optional">; readonly mappingRelation: Field<"broadMatch" | "closeMatch" | "exactMatch" | "narrowMatch" | "subClassOf" | "subPropertyOf", "optional">; readonly deprecatedOn: Field<string, "optional">; readonly replacedBy: Field<string, "optional">; readonly justification: Field<string, "optional">; readonly decision: Field<Named<"mz:Decision">, "optional">; readonly addedOn: Field<string, "optional">; readonly definedBy: Field<string, "many">; }>>[]): readonly TermRecord[]

The records of an audit of terms as the rules read them: each term of a vocabulary and the basis it rests on (0018-standards-first FR-003 to FR-005).

mizanTermRecordsfunctionno test imports it
function mizanTermRecords(): readonly TermRecord[]

Mizan's own terms and the packaging ontology's as the rules read them.

deprecatedTermsfunctionno test imports it
function deprecatedTerms(): ReadonlyMap<string, string>

The deprecated terms of commons' own ontologies, by CURIE, with what replaces each (0018-standards-first): a specification that names one is found.

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