Checks
11 pages filed under Quality › checks. A term is a word of the business with its definition, its aliases and the words it relates to.
| Term | aliases | First line | Links |
|---|---|---|---|
| Check | control, rule of consistency | A pure function that reads the model and returns findings. Checks live in one registry shared by the build and the linter, so both report the same thing on the same repository. Each check has an identifier, a default severity, a description, a remediation and a documentation page, and belongs to a check family. | 139 |
| Check family | family | The grouping of the checks in their documentation: every check page states its family, and the list of the checks is laid out by family, source checks, link checks, identifier and type checks, document checks, vocabulary and filing checks, contract checks and plugin checks. The family says which step of the pipeline raises the finding and which note or file it points at. | 73 |
| Contract checks | contracts family | The check family of the APIs and their contracts: W-CONTRACT-UNREACHABLE, a contract the contract import could not fetch, read or parse; W-OPERATION-AMBIGUOUS, two operation notes claiming one imported operation, or one note matching several; W-API-NOCONSUMER, an API nothing consumes; W-API-CONSUMER-MISMATCH, a declared consumer that never cites the API, or a citing note the API does not list. | 16 |
| Document checks | documents family | The check family of the documents that are not notes: W-CONV-FAILED, an office document the converter could not turn into a PDF; W-CONV-SUSPECT, a converted PDF without extractable text although the document is large; W-DOC-NOMD, a document without a markdown representation, which the to-do page lists; W-DUP-CANDIDATE, two resources that look like twin resources without reaching the merge score. | 22 |
| Global check | GLOBAL_CHECKS, global scope check | A check the linter computes on one repository against the published model of the whole wiki, without rebuilding it: a markdown link into another source, a frontmatter reference whose relation the profile must allow between the two types, or a title shared with an entity of another type. The lint package lists them as GLOBAL_CHECKS (E-LINK-BROKEN, E-META-REL, I-TERM-HOMONYM, W-LINK-CROSS-SOURCE). The model is fetched once and kept in a local cache for a configurable number of hours; when it cannot be read, the linter says so and falls back to the local checks instead of failing. Each finding names the remote entity and the build timestamp of the model it was compared with. | 29 |
| Identifier and type checks | identifiers and types family | The check family of the reading and typing of a file: E-ENCODING, a file that is not UTF-8; E-FM-INVALID, a frontmatter that does not parse; E-ID-INVALID and E-ID-DUP, an identifier that breaks the pattern or that two files share; E-TYPE-CONFLICT, a frontmatter type contradicting the suffix; E-META-REL, a declared relation the profile forbids between two types; W-TYPE-UNKNOWN, a type the profile does not declare; W-ATTRIBUTE-UNKNOWN, a frontmatter key neither the type nor the common attributes declare. | 19 |
| Link checks | links family | The check family of what a note points at: E-LINK-BROKEN, a markdown link to a file that does not exist in its source; W-LINK-CROSS-SOURCE, a link into another source while inference.cross_source_links is off; W-REF-UNRESOLVED, a frontmatter reference that matches no note, or several by title. The first is a local check, the first two are also computed in the global scope of the linter. | 25 |
| Local check | LOCAL_CHECKS, local scope check | A check the linter computes on one repository alone, without the network and without the rest of the model: encoding, frontmatter, identifiers and internal links. The lint package lists them as LOCAL_CHECKS. For these checks the linter and the build produce the same findings on the same repository, wording included; a parity test on the golden corpus and on the faulty corpus holds them to it, and the JSON report of the linter repeats the list so that a forge report says what was checked. | 42 |
| Plugin checks | plugins family | The check family of the plugins: W-PLUGIN-DISABLED, a declared plugin whose system tool is not installed, so that it was not registered and the build went on without its contributions; info when the tool is optional and the plugin stays registered. | 17 |
| Source checks | sources family | The check family of the ingestion of a source: W-SOURCE-UNREACHABLE, raised when a declared repository or folder cannot be fetched or read, so that the build goes on without it and nothing of it enters the model until it comes back. | 21 |
| Vocabulary and filing checks | vocabulary and filing family | The check family of the words and of the containers: W-TERM-UNDEFINED, a candidate expression used across files without a note; W-TERM-UNUSED, a term never cited; I-TERM-HOMONYM, two entities sharing a form; W-DOMAIN-UNCLASSIFIED and W-DOMAIN-UNKNOWN, a note outside every domain or naming an undeclared one; W-APP-MISSING and W-APP-UNKNOWN, the same for the application; W-STALE, a source or a note past the staleness threshold; I-REL-AMBIGUOUS, a link left on the generic relation; I-PII-DETECTED, a personal name found in a transcript outside the pseudonymisation dictionary. | 31 |
11 checks of 11 — pagination by twenty. The Links column counts the related pages, which brings the most central checks of the journey to the top.