Findinginterfaceinterface FindingA problem and where it is.
| Member | Type | What it is |
|---|---|---|
where | string | The file, page or export it is found in. |
problem | Problem | What is wrong there. |
What check finds (commons 0011-documentation FR-018), as a tagged union with one sentence for each case, and the place each is found: a file of the repository, a page of the site or an export. The generator gathers findings while it builds; check prints them and fails where there is one.
Findinginterfaceinterface FindingA problem and where it is.
| Member | Type | What it is |
|---|---|---|
where | string | The file, page or export it is found in. |
problem | Problem | What is wrong there. |
messagefunctionfunction message(p: Problem): stringThe sentence a finding is printed with.
Problemtypeno test imports ittype Problem =
| { readonly kind: "undocumented"; readonly name: string }
| { readonly kind: "no-about" }
| { read… (1330 characters)type Problem =
| { readonly kind: "undocumented"; readonly name: string }
| { readonly kind: "no-about" }
| { readonly kind: "folder-missing"; readonly folder: string }
| { readonly kind: "command-missing"; readonly command: string }
| { readonly kind: "enforcer-missing"; readonly enforcer: string }
| { readonly kind: "entry-point-missing"; readonly file: string }
| { readonly kind: "example-missing"; readonly file: string }
| { readonly kind: "unknown-spec"; readonly cite: string }
| { readonly kind: "unknown-requirement"; readonly cite: string }
| { readonly kind: "unknown-link"; readonly name: string }
| { readonly kind: "undescribed"; readonly entity: string }
| { readonly kind: "import-failed"; readonly error: string }
| { readonly kind: "broken-link"; readonly href: string }
| { readonly kind: "duplicate-spec"; readonly id: string }
| { readonly kind: "diagram-undrawable"; readonly first: string }
| { readonly kind: "book-part-empty"; readonly volume: string; readonly part: string }
| { readonly kind: "evidence-unreadable"; readonly why: string }
| { readonly kind: "test-requirement-unknown"; readonly requirement: string; readonly test: string }
| { readonly kind: "retired-name"; readonly name: string }
| { readonly kind: "forbidden-word"; readonly word: string };What is wrong.
reportfunctionfunction report(found: readonly Finding[]): string[]The findings as the lines check prints, sorted and each once.