Findinginterfaceno test imports itinterface FindingWhat lint says of one element.
| Member | Type | What it is |
|---|---|---|
rule | string | The rule that found it, <vocabulary>/<name>. |
element | ElementId | |
message | string | One plain sentence. |
severity | Severity |
A vocabulary (commons data 0003-governance FR-008): the annotation kinds a part of governance speaks in, and the lint rules that say where a domain falls short of them. The engine's contribution point governance.vocabulary lets an extension add one; vocabulariesFrom reads those of a composition in its order. A finding is data: the rule, the element, a sentence and a severity.
Findinginterfaceno test imports itinterface FindingWhat lint says of one element.
| Member | Type | What it is |
|---|---|---|
rule | string | The rule that found it, <vocabulary>/<name>. |
element | ElementId | |
message | string | One plain sentence. |
severity | Severity |
findingconstconst finding: (rule: string, element: ElementId, message: string, severity?: Severity) => FindingA finding, made.
LintRuleinterfaceno test imports itinterface LintRuleA lint rule: what it looks for, and how it looks.
| Member | Type | What it is |
|---|---|---|
id | string | <vocabulary>/<name>. |
describe | string | What it looks for, in a sentence. |
check | (domain: Domain) => readonly Finding[] |
Severitytypeno test imports ittype Severity = "error" | "warning";How serious a finding is: an error is a fault in the domain, a warning is a gap.
Vocabularyinterfaceinterface VocabularyA vocabulary: annotation kinds and the rules that hold a domain to them.
| Member | Type | What it is |
|---|---|---|
id | string | |
kinds | readonly AnnotationKind<unknown>[] | |
rules | readonly LintRule[] |
vocabulariesFromfunctionfunction vocabulariesFrom(composition: Composition): readonly Vocabulary[]The vocabularies of a composition, in its order.
| Parameter | What it is |
|---|---|
composition | the project's composition |
Returns: the vocabularies its extensions contribute
vocabularyExtensionfunctionfunction vocabularyExtension(v: Vocabulary, version?: string): Result<Extension, IdError>An extension that contributes a vocabulary, named governance.<id>.
| Parameter | What it is |
|---|---|
v | the vocabulary |
version | the extension's version |
Returns: the extension, or why its identifier is not one
vocabularyPointconstno test imports itconst vocabularyPoint: ContributionPoint<Vocabulary>The contribution point an extension fills to add a vocabulary.