@jpeakai/mermaidjs-lint 0.4.2 → 0.5.0

package/src/rules/contrast-directive-unauditable.ts

@@ -2,7 +2,8 @@ import { CONTRAST_OPTIONS, contrastOf, fileLine, profileOf } from "./shared.ts";
 import { type Finding, RULE, type Rule } from "./types.ts";
 
 // A directive the profile requires to be scoreable but cannot be: a github fill
-// with no color:, or a colour that will not parse. Reporting it as an
+// with no color:, a colour that will not parse, or a sequence diagram config
+// the audit does not model, such as themeCSS or a theme outside the five. Reporting it as an
 // informational skip is how a gate exits clean on a diagram it never checked,
 // so it is a failure to audit.
 export const contrastDirectiveUnauditable: Rule = {
@@ -10,11 +11,11 @@ export const contrastDirectiveUnauditable: Rule = {
   category: "contrast",
   summary: "a style directive whose contrast cannot be audited",
   options: CONTRAST_OPTIONS,
-  check: (ctx) => {
+  check: async (ctx) => {
     const profile = profileOf(ctx);
     const found: Finding[] = [];
     for (const diagram of ctx.doc.diagrams) {
-      for (const s of contrastOf(diagram, profile).skipped) {
+      for (const s of (await contrastOf(diagram, profile)).skipped) {
         if (!s.blocking) continue;
         const line = fileLine(diagram, s.line);
         found.push({
@@ -23,7 +24,8 @@ export const contrastDirectiveUnauditable: Rule = {
           endLine: line,
           rule: RULE.UNAUDITABLE,
           message: `${s.selector}: unaudited, ${s.reason}`,
-          remediation: "Declare the missing property or fix the colour so the pair can be scored.",
+          remediation:
+            "Declare the missing property, fix the colour, or remove the config the audit cannot model, so the pair can be scored.",
         });
       }
     }

package/src/rules/contrast-text-below-aa.ts

@@ -19,11 +19,11 @@ export const contrastTextBelowAa: Rule = {
   category: "contrast",
   summary: "label text below 4.5:1 against its fill",
   options: CONTRAST_OPTIONS,
-  check: (ctx) => {
+  check: async (ctx) => {
     const profile = profileOf(ctx);
     const found: Finding[] = [];
     for (const diagram of ctx.doc.diagrams) {
-      for (const p of contrastOf(diagram, profile).pairs) {
+      for (const p of (await contrastOf(diagram, profile)).pairs) {
         if (p.kind !== "text" || p.passes) continue;
         const where = [p.theme, p.row].filter(Boolean).join("/");
         const line = fileLine(diagram, p.line);
@@ -38,21 +38,23 @@ export const contrastTextBelowAa: Rule = {
           remediation:
             profile === "mkdocs-material"
               ? "The host theme forces the label text, so change the fill until the host text reads on it in both themes."
-              : p.directive.kind === "linkStyle"
-                ? "An edge label sits on Mermaid's own label box, light in one theme and grey in the other, and no one colour reads on both, so drop color: from the linkStyle and let the theme set the label text."
-                : "Darken or lighten the fill, or change color:, until the ratio reaches 4.5:1 in every theme.",
+              : p.directive.kind === "themeVariables"
+                ? "A sequence diagram colour is a theme variable, and text with no box of its own sits on the page, so set the variable to a colour that reads on its background in both themes, or remove it and let the theme set it."
+                : p.directive.kind === "linkStyle"
+                  ? "An edge label sits on Mermaid's own label box, light in one theme and grey in the other, and no one colour reads on both, so drop color: from the linkStyle and let the theme set the label text."
+                  : "Darken or lighten the fill, or change color:, until the ratio reaches 4.5:1 in every theme.",
         });
       }
     }
     return found;
   },
-  fix: (ctx) => {
+  fix: async (ctx) => {
     const profile = profileOf(ctx);
     // Under a host profile color: is ignored, so there is nothing to rewrite.
     if (profile === "mkdocs-material") return [];
     const edits: Edit[] = [];
     for (const diagram of ctx.doc.diagrams) {
-      const { pairs } = contrastOf(diagram, profile);
+      const { pairs } = await contrastOf(diagram, profile);
       const failing = new Set(pairs.filter((p) => p.kind === "text" && !p.passes).map((p) => p.directive));
       for (const directive of failing) {
         const span = directive.spans.color;

package/src/rules/shared.ts

@@ -3,7 +3,7 @@
 // disagree about what the same diagram holds.
 
 import type { Diagram } from "../model.ts";
-import { type ContrastResult, detectProfile, PROFILES, type Profile, scoreForProfile } from "../parse/contrast.ts";
+import { type ContrastResult, detectProfile, PROFILES, type Profile, scoreDiagram } from "../parse/contrast.ts";
 import { type ComplexityMetrics, calculateComplexity, parseFailed, type ThresholdConfig } from "../parse/metrics.ts";
 import type { DiagramStats } from "../parse/stats.ts";
 import type { Finding, OptionSpec, RuleContext, RuleId } from "./types.ts";
@@ -77,9 +77,11 @@ export const profileOf = (ctx: RuleContext): Profile => {
   return wanted === "auto" ? detectProfile(ctx.file) : (wanted as Profile);
 };
 
-const scored = new WeakMap<Diagram, Map<Profile, ContrastResult>>();
+const scored = new WeakMap<Diagram, Map<Profile, Promise<ContrastResult>>>();
 
-export const contrastOf = (diagram: Diagram, profile: Profile): ContrastResult => {
+// Scored once per diagram and profile. A sequence diagram is scored by its
+// theme variables, which Mermaid resolves asynchronously.
+export const contrastOf = (diagram: Diagram, profile: Profile): Promise<ContrastResult> => {
   let byProfile = scored.get(diagram);
   if (!byProfile) {
     byProfile = new Map();
@@ -87,7 +89,7 @@ export const contrastOf = (diagram: Diagram, profile: Profile): ContrastResult =
   }
   let result = byProfile.get(profile);
   if (!result) {
-    result = scoreForProfile(diagram.directives, profile, diagram.keyword);
+    result = scoreDiagram(diagram.source, diagram.directives, profile, diagram.keyword);
     byProfile.set(profile, result);
   }
   return result;