@intentset/core 0.4.0 → 0.6.0

package/src/validate.ts

@@ -112,6 +112,7 @@ export function validate(
   const graph = buildGraph(artifacts);
   const context: Context = { graph, registries, unreadable, locators, diagnostics, levelIndex: LEVELS.indexOf(level) };
   checkRelationships(context);
+  checkTips(context);
   checkCycles(context);
   checkLifecycle(context);
   checkAttachment(context);
@@ -262,6 +263,24 @@ function checkRelationships(context: Context): void {
   }
 }
 
+/** Core §9: every tip on a knowledge record is keyed by an ID the record explains (CORE003). */
+function checkTips(context: Context): void {
+  for (const artifact of sortedArtifacts(context.graph)) {
+    const { meta } = artifact;
+    if (meta.tips === undefined) continue;
+    const explained = new Set(meta.links.explains ?? []);
+    for (const key of Object.keys(meta.tips).sort(compareStrings)) {
+      if (explained.has(key)) continue;
+      reportOn(context, artifact, {
+        code: "CORE003",
+        field: `/intentset/tips/${key}`,
+        message: `${meta.id} tips ${key}, which it does not explain.`,
+        remediation: `Add ${key} to links.explains, or key the tip by an ID the knowledge explains (Core §9).`,
+      });
+    }
+  }
+}
+
 /** Core §5: cycles in `parent`, `replacedBy` and `requires`, a self-reference being the shortest. */
 function checkCycles(context: Context): void {
   const { graph } = context;
@@ -395,6 +414,18 @@ function checkLifecycle(context: Context): void {
         });
       }
     }
+    if (meta.measure !== undefined) {
+      if (registries.evidenceSources.length === 0) use("evidenceSources");
+      else if (!registries.evidenceSources.includes(meta.measure.source)) {
+        reportOn(context, artifact, {
+          code: "CORE005",
+          field: "/intentset/measure/source",
+          message: `measure source ${meta.measure.source} is not in the evidenceSources registry.`,
+          remediation:
+            "Add the analytics product, study or survey to registries.yaml evidenceSources, or name a registered source.",
+        });
+      }
+    }
     meta.slice?.usesResources.forEach((resource, i) => {
       if (registries.resources.length === 0) use("resources");
       else if (!resourceIds.has(resource)) {
@@ -446,12 +477,22 @@ interface Requirement {
   remediation: string;
   /** Core §5 names no active obligation for this type; only the draft warning applies. */
   draftOnly?: boolean;
+  /** Only edges from these types count: an outcome is judged by its measures, not by the capabilities under it. */
+  fromTypes?: readonly ArtifactType[];
 }
 
 function requirement(artifact: Artifact): Requirement | null {
   const { meta } = artifact;
   const id = meta.id;
   switch (meta.type) {
+    case "outcome":
+      return {
+        kinds: ["parent"],
+        direction: "in",
+        fromTypes: ["measure"],
+        message: "no measure names it as parent, so nothing says how it will be judged",
+        remediation: `Add a measure record with \`parent: ${id}\` carrying metric, baseline, target, window and source (Core §6).`,
+      };
     case "rule":
       return {
         kinds: ["governedBy"],
@@ -510,18 +551,27 @@ function requirement(artifact: Artifact): Requirement | null {
 }
 
 /**
- * Core §5 and VSA §3: active rules, scenarios, verifications, knowledge and
- * product slices are attached (CORE003). Their drafts, and draft contracts
- * and decisions nothing refers to, are unattached drafts (CORE009, warning).
+ * Core §5, §6 and VSA §3: active rules, scenarios, verifications, knowledge and
+ * product slices are attached, and an active outcome has a measure (CORE003).
+ * Their drafts, and draft contracts and decisions nothing refers to, are
+ * unattached drafts (CORE009, warning).
  */
 function checkAttachment(context: Context): void {
   const { graph } = context;
   for (const artifact of sortedArtifacts(graph)) {
     const need = requirement(artifact);
     if (need === null || artifact.meta.status === "retired") continue;
-    const edges = need.kinds.flatMap((kind) =>
-      need.direction === "in" ? incomingEdges(graph, artifact.meta.id, kind) : outgoing(graph, artifact.meta.id, kind),
-    );
+    const edges = need.kinds
+      .flatMap((kind) =>
+        need.direction === "in"
+          ? incomingEdges(graph, artifact.meta.id, kind)
+          : outgoing(graph, artifact.meta.id, kind),
+      )
+      .filter((edge) => {
+        if (need.fromTypes === undefined) return true;
+        const from = graph.artifacts.get(edge.from);
+        return from !== undefined && need.fromTypes.includes(from.meta.type);
+      });
     if (edges.length > 0) continue;
     const field = need.direction === "out" ? `/intentset/links/${need.kinds[0]}` : undefined;
     if (artifact.meta.status === "draft") {
@@ -553,7 +603,7 @@ export function patternProblem(pattern: string): string | null {
   return null;
 }
 
-/** VSA §3 and Core §8: type-specific blocks on their own type only; technical slices give a rationale and implement nothing; patterns are plain. */
+/** VSA §3, Core §6 and §8: type-specific blocks on their own type only; technical slices give a rationale and implement nothing; patterns are plain. */
 function checkSlices(context: Context): void {
   const { graph } = context;
   for (const artifact of sortedArtifacts(graph)) {
@@ -567,6 +617,13 @@ function checkSlices(context: Context): void {
         "Remove the verification block, or change the type (Core §8).",
       );
     }
+    if (artifact.meta.measure !== undefined && artifact.meta.type !== "measure") {
+      profile(
+        "/intentset/measure",
+        `${id} is ${aType(artifact.meta.type)} and carries measure metadata, which only a measure has.`,
+        "Remove the measure block, or change the type (Core §6).",
+      );
+    }
     const slice = artifact.meta.slice;
     if (slice === undefined) continue;
     if (artifact.meta.type !== "slice") {