@miragon/design-iq-validator 5.3.0 → 5.4.0

package/README.md

@@ -5,7 +5,8 @@ structural checks (flow soundness, complete BPMNDI coverage), DMN structure and
 the generic cross-model reference rule (every required reference — `callActivity` calls,
 `businessRuleTask` decides — must resolve in the repo), and a per-mediaKind parse baseline for
 every other registered notation (a broken `.tt`/`.vc.json` is an ERROR; DSL notations are
-lenient by design). Every finding carries a stable `ruleId` (e.g. `bpmn/flow`, `dmn/di`,
+lenient by design; a Mermaid diagram that does not start with a diagram type such as
+`flowchart` or `sequenceDiagram` is a WARN, `mermaid/diagram-type`). Every finding carries a stable `ruleId` (e.g. `bpmn/flow`, `dmn/di`,
 `refs/dangling`). It treats the target repo as pure data — it never executes content-repo code.
 Exit code 0 = no errors (warnings allowed), 1 = errors.
 

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as runCli } from "./validate-D5Lo0E8X.js";
+import { a as runCli } from "./validate-Dy2lNoBR.js";
 //#region src/cli.ts
 /**
 * CLI entry for the platform validator. A dedicated entry file (instead of an

package/dist/{content-Bsv9ZLFd.js → content-DJ1x-ykR.js}

@@ -126,6 +126,18 @@ const NOTATIONS = [
 		mediaKind: "markdown",
 		docShape: "text",
 		monacoLanguage: "markdown"
+	},
+	{
+		id: "mermaid",
+		label: "Mermaid",
+		noun: {
+			singular: "diagram",
+			plural: "diagrams"
+		},
+		extensions: [".mmd", ".mermaid"],
+		mediaKind: "dsl",
+		docShape: "text",
+		monacoLanguage: "plaintext"
 	}
 ];
 function byId(id) {

package/dist/content-Dld6ZUbs.js

@@ -0,0 +1 @@
+export { t as CONTENT_CONFIG_FILE, i as contentConfigConflict, a as discoverModels, o as legacyContentConfigFile, s as loadContentConfig } from "./content-DJ1x-ykR.js";

package/dist/{validate-D5Lo0E8X.js → validate-Dy2lNoBR.js}

@@ -1,4 +1,4 @@
-import { _ as byId, c as resolveContentConfigFile, d as extractModelGraph, f as parseXml, g as byExtension, h as kindOf, l as XMLValidator, m as requirementHref, p as readBpmn, r as CONTENT_CONFIG_NAMES, u as asArray } from "./content-Bsv9ZLFd.js";
+import { _ as byId, c as resolveContentConfigFile, d as extractModelGraph, f as parseXml, g as byExtension, h as kindOf, l as XMLValidator, m as requirementHref, p as readBpmn, r as CONTENT_CONFIG_NAMES, u as asArray } from "./content-DJ1x-ykR.js";
 import { readFileSync } from "node:fs";
 import { relative, resolve } from "node:path";
 //#region ../notations/refs.ts
@@ -84,6 +84,120 @@ const notContentRepoError = (root) => {
 	return found === void 0 ? `[ERROR] ${root}: no ${CONTENT_CONFIG_NAMES} at the root — not a content repo (or wrong --root)` : `[ERROR] ${root}: ${found} at the root names no models folder — not a content repo (or wrong --root)`;
 };
 //#endregion
+//#region ../notations/mermaid.ts
+/**
+* Every diagram type MERMAID_VERSION renders, spelled as its header keyword
+* (its diagram detectors, minus the spellings the detector matches but the
+* grammar then refuses: a bare `architecture` or `requirement`). zenuml is
+* an external plugin mermaid does not bundle, so it is not here.
+*/
+const MERMAID_DIAGRAM_TYPES = [
+	"flowchart",
+	"flowchart-elk",
+	"graph",
+	"sequenceDiagram",
+	"classDiagram",
+	"classDiagram-v2",
+	"stateDiagram",
+	"stateDiagram-v2",
+	"erDiagram",
+	"journey",
+	"gantt",
+	"pie",
+	"quadrantChart",
+	"requirementDiagram",
+	"gitGraph",
+	"C4Context",
+	"C4Container",
+	"C4Component",
+	"C4Dynamic",
+	"C4Deployment",
+	"mindmap",
+	"timeline",
+	"sankey",
+	"sankey-beta",
+	"xychart",
+	"xychart-beta",
+	"block",
+	"block-beta",
+	"packet",
+	"packet-beta",
+	"kanban",
+	"architecture-beta",
+	"radar-beta",
+	"treemap",
+	"treemap-beta",
+	"info",
+	"swimlane-beta",
+	"treeView-beta",
+	"eventmodeling",
+	"ishikawa",
+	"ishikawa-beta",
+	"venn-beta",
+	"wardley-beta",
+	"cynefin-beta",
+	"railroad-beta",
+	"railroad-ebnf-beta",
+	"railroad-abnf-beta",
+	"railroad-peg-beta"
+];
+const FRONT_MATTER = /^([^\S\n\r]*)-{3}\s*[\n\r](.*?)[\n\r]\1-{3}\s*[\n\r]+/s;
+const DIRECTIVE = /%{2}{\s*(?:(\w+)\s*:|(\w+))\s*(?:(\w+)|((?:(?!}%{2}).|\r?\n)*))?\s*(?:}%{2})?/gi;
+const COMMENT_LINE = /^\s*%%(?!{)[^\n]+\n?/gm;
+/** a header keyword, followed by the end of the line, a space, ":" or ";" */
+const HEADER = new RegExp(`^(?:${MERMAID_DIAGRAM_TYPES.map((t) => t.replace(/[.*+?^${}()|[\]\\-]/g, "\\$&")).join("|")})(?=$|[\\s:;])`);
+/** mermaid's cleanupText: line breaks to \n, tag attributes single-quoted;
+*  the line structure stays, so the source lines can be matched against it */
+function cleanup(source) {
+	return source.replace(/\r\n?/g, "\n").replace(/<(\w+)([^>]*)>/g, (_tag, name, attrs) => `<${name}${attrs.replace(/="([^"]*)"/g, "='$1'")}>`);
+}
+/** The text mermaid's diagram parser reads: the source after mermaid's
+*  preprocess (front matter, directives and comment lines removed, leading
+*  whitespace trimmed). */
+function mermaidCode(source) {
+	return cleanup(source).replace(FRONT_MATTER, "").replace(DIRECTIVE, "").replace(COMMENT_LINE, "").trimStart();
+}
+/**
+* The 1-based source line of the 1-based line `codeLine` of mermaidCode(source).
+* The preprocess only removes lines (and joins the two ends of a directive
+* that spans lines), so the code is the source's lines in order: each code
+* line is matched to the next source line with the same text. A line the
+* preprocess rewrote matches nothing and takes the next line; a line past the
+* end clamps to the last one.
+*/
+function mermaidSourceLine(source, codeLine) {
+	const cleaned = cleanup(source);
+	const sourceLines = cleaned.split("\n").map((l) => l.trim());
+	const codeLines = mermaidCode(source).split("\n");
+	let next = (cleaned.match(FRONT_MATTER)?.[0] ?? "").split("\n").length - 1;
+	let at = next;
+	for (let i = 0; i < Math.min(codeLine, codeLines.length); i++) {
+		const text = codeLines[i].trim();
+		let k = next;
+		while (k < sourceLines.length && sourceLines[k] !== text) k++;
+		at = k < sourceLines.length ? k : next;
+		next = at + 1;
+	}
+	return Math.min(at, sourceLines.length - 1) + 1;
+}
+/**
+* The line that names the diagram type: the first line of mermaidCode that
+* is neither blank nor a bare `%%` comment (mermaid's type detection skips
+* those too). undefined when there is none: the source is empty, or nothing
+* but front matter, directives and comments.
+*/
+function mermaidHeader(source) {
+	const lines = mermaidCode(source).split("\n");
+	const index = lines.findIndex((l) => l.trim() !== "" && !l.trim().startsWith("%%"));
+	if (index < 0) return void 0;
+	const text = lines[index].trim();
+	return {
+		line: mermaidSourceLine(source, index + 1),
+		text,
+		diagramType: HEADER.exec(text)?.[0]
+	};
+}
+//#endregion
 //#region src/validate.ts
 /**
 * Deterministic validation of a content repository (the slim contract).
@@ -335,6 +449,31 @@ function checkDmnXml(raw, opts = {}) {
 	else for (const id of diRequired) if (!di.has(id)) err("dmn/di", `${id} has no DMNDI shape (breaks the visual editor)`);
 	return { findings };
 }
+/** the Mermaid types the header message names: the common ones, not every one */
+const COMMON_MERMAID_TYPES = "flowchart, sequenceDiagram, classDiagram, stateDiagram-v2, erDiagram, gantt, pie, mindmap";
+/**
+* Mermaid's own first step (its type detection, @designiq/notations/mermaid
+* mirrors it): after the front matter, directives and comments, the first
+* line must start with a diagram type. Light on purpose: the grammar itself
+* needs mermaid and a DOM, which the validator never loads; the web viewer
+* shows those errors live. A WARN, not an ERROR: .mmd files a content repo
+* already keeps (snippets, a zenuml diagram mermaid does not bundle) turn
+* up as models with this notation, and must neither fail its CI nor block a
+* save.
+*/
+function mermaidHeaderProblem(raw) {
+	const header = mermaidHeader(raw);
+	if (!header) return `empty Mermaid diagram: the first line must name a diagram type (${COMMON_MERMAID_TYPES}, …)`;
+	if (header.diagramType) return void 0;
+	const word = header.text.split(/[\s:;]/, 1)[0];
+	return `line ${header.line}: '${word}' is not a Mermaid diagram type (${COMMON_MERMAID_TYPES}, …)`;
+}
+/** notation id → the check of its DSL's header line (a WARN under its own
+*  rule id); a DSL without one stays as lenient as its extractor */
+const DSL_HEADER_CHECKS = { mermaid: {
+	ruleId: "mermaid/diagram-type",
+	problem: mermaidHeaderProblem
+} };
 /**
 * Baseline parse gate for models WITHOUT a dedicated checker (any registered
 * notation that is not .bpmn/.dmn): a discovered model must at minimum parse
@@ -368,10 +507,21 @@ function checkModelBaseline(raw, opts) {
 			if (wf !== true) err(`not well-formed XML: ${wf.err.msg}`);
 			break;
 		}
-		case "dsl": try {
-			extractModelGraph(opts.notation, raw);
-		} catch (e) {
-			err(`not parseable: ${e.message}`);
+		case "dsl": {
+			try {
+				extractModelGraph(opts.notation, raw);
+			} catch (e) {
+				err(`not parseable: ${e.message}`);
+			}
+			const header = DSL_HEADER_CHECKS[opts.notation];
+			const problem = header?.problem(raw);
+			if (header && problem) findings.push({
+				severity: "WARN",
+				ruleId: header.ruleId,
+				file,
+				message: problem
+			});
+			break;
 		}
 	}
 	return findings;
@@ -436,7 +586,7 @@ async function runCli() {
 	/** optional single-model filter (a model file stem) */
 	const only = argv[0];
 	const rel = (p) => p.startsWith("/") ? relative(ROOT, p) : p;
-	const { CONTENT_CONFIG_FILE, contentConfigConflict, discoverModels, legacyContentConfigFile, loadContentConfig } = await import("./content-DgyuLYdD.js");
+	const { CONTENT_CONFIG_FILE, contentConfigConflict, discoverModels, legacyContentConfigFile, loadContentConfig } = await import("./content-Dld6ZUbs.js");
 	const cfg = loadContentConfig(ROOT);
 	if (!cfg) {
 		console.error(notContentRepoError(ROOT));

package/dist/validate.js

@@ -1,2 +1 @@
-import { a as runCli, i as checkModelBaseline, n as checkDmnXml, r as checkModel, t as checkBpmnXml } from "./validate-D5Lo0E8X.js";
-export { checkBpmnXml, checkDmnXml, checkModel, checkModelBaseline, runCli };
+export { t as checkBpmnXml, n as checkDmnXml, r as checkModel, i as checkModelBaseline, a as runCli } from "./validate-Dy2lNoBR.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miragon/design-iq-validator",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "type": "module",
   "description": "Platform-owned validator for designIQ content repos — designiq.yml discovery, BPMN/DMN structure and diagram coverage, cross-model references, and a parse check for every other notation. Runs against any checkout via --root; never executes content-repo code.",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "yaml": "2.9.1"
   },
   "devDependencies": {
-    "tsdown": "0.23.0",
+    "tsdown": "0.23.1",
     "@designiq/notations": "0.1.0"
   },
   "scripts": {

package/dist/content-DgyuLYdD.js

@@ -1,2 +0,0 @@
-import { a as discoverModels, i as contentConfigConflict, o as legacyContentConfigFile, s as loadContentConfig, t as CONTENT_CONFIG_FILE } from "./content-Bsv9ZLFd.js";
-export { CONTENT_CONFIG_FILE, contentConfigConflict, discoverModels, legacyContentConfigFile, loadContentConfig };