Skip to content

Build your personal knowledge base with Trilium Notes

test(codemirror): cover every branch of the vendored Mermaid tokenizers

Elian Doran85c6fc9e807c
diff --git a/packages/codemirror/src/languages/mermaid/mermaid.spec.ts b/packages/codemirror/src/languages/mermaid/mermaid.spec.ts
index 9f09fe132c..c22239f66a 100644
--- a/packages/codemirror/src/languages/mermaid/mermaid.spec.ts
+++ b/packages/codemirror/src/languages/mermaid/mermaid.spec.ts
@@ -1,13 +1,14 @@
import { readFileSync } from "node:fs";
import { basename, dirname, join } from "node:path";
-import { LanguageSupport } from "@codemirror/language";
+import { foldable, LanguageSupport } from "@codemirror/language";
+import { EditorState } from "@codemirror/state";
import type { Parser } from "@lezer/common";
import { fileTests } from "@lezer/generator/test";
import { describe, expect, it } from "vitest";
import { buildGrammar, listGrammars } from "../../../scripts/build_mermaid_grammars.mjs";
-import { DIAGRAM_PARSERS, mermaid, mermaidLanguage } from "./index.js";
+import { DIAGRAM_PARSERS, foldByIndent, mermaid, mermaidLanguage } from "./index.js";
const grammars = listGrammars();
const diagrams = grammars.map((grammarPath) => basename(dirname(grammarPath)));
@@ -60,6 +61,14 @@ describe("mermaid", () => {
expect(mermaidLanguage.parser.parse("not a diagram\n").toString())
.toBe("MermaidDiagram(⚠)");
});
+
+ it("parses Windows line endings like Unix ones", () => {
+ // Kept out of the `.txt` fixtures, where Git normalizes CRLF to LF.
+ const tree = (doc: string) => mermaidLanguage.parser.parse(doc).toString();
+ for (const unix of [ "mindmap\n root\n \n child\n", "mindmap\n#x\n \n" ]) {
+ expect(tree(unix.replaceAll("\n", "\r\n")), JSON.stringify(unix)).toBe(tree(unix));
+ }
+ });
});
describe("kanban grammar", () => {
@@ -69,3 +78,29 @@ describe("kanban grammar", () => {
expect(id && doc.slice(id.from, id.to)).toBe("my-card");
});
});
+
+describe("foldByIndent", () => {
+ function foldAt(doc: string, lineNumber: number) {
+ const state = EditorState.create({ doc, extensions: [ foldByIndent() ] });
+ const line = state.doc.line(lineNumber);
+ const range = foldable(state, line.from, line.to);
+ return range && state.sliceDoc(range.from, range.to);
+ }
+
+ it("folds the more deeply indented lines that follow, across blank lines", () => {
+ const doc = "mindmap\n root\n a\n\n b\n next\n";
+ expect(foldAt(doc, 2)).toBe("\n a\n\n b");
+ expect(foldAt(doc, 1)).toBe("\n root\n a\n\n b\n next");
+ });
+
+ it("counts a tab as four spaces", () => {
+ expect(foldAt("root\n\tchild\n sibling\n", 2)).toBeNull();
+ expect(foldAt("root\n\tchild\n grandchild\n", 2)).toBe("\n grandchild");
+ });
+
+ it("does not fold a blank line or a line with nothing nested under it", () => {
+ expect(foldAt("a\n\n b\n", 2)).toBeNull();
+ expect(foldAt("a\nb\n", 1)).toBeNull();
+ expect(foldAt("a", 1)).toBeNull();
+ });
+});
diff --git a/packages/codemirror/src/languages/mermaid/test/architecture.txt b/packages/codemirror/src/languages/mermaid/test/architecture.txt
index 4abc03e7bf..1b04097755 100644
--- a/packages/codemirror/src/languages/mermaid/test/architecture.txt
+++ b/packages/codemirror/src/languages/mermaid/test/architecture.txt
@@ -89,3 +89,50 @@ architecture-beta
==>
ArchitectureDiagram(DiagramName,Group(GroupKeyword,NodeId,Icon,Label),Service(ServiceKeyword,NodeId,Icon,Label,InClause(InKeyword,NodeId)),Service(ServiceKeyword,NodeId,Icon,Label,InClause(InKeyword,NodeId)),Edge(NodeId,Port,Arrow,Port,NodeId))
+
+# Service with a label and no icon
+
+architecture-beta
+ service db[Database]
+
+==>
+
+ArchitectureDiagram(DiagramName,Service(ServiceKeyword,NodeId,Label))
+
+# Service with an icon and no label
+
+architecture-beta
+ service db(database)
+
+
+==>
+
+ArchitectureDiagram(DiagramName,Service(ServiceKeyword,NodeId,Icon))
+
+# Unclosed icon
+
+architecture-beta
+ service db(database
+
+
+==>
+
+ArchitectureDiagram(DiagramName,Service(ServiceKeyword,NodeId,⚠),Edge(NodeId,⚠))
+
+# Unclosed label
+
+architecture-beta
+ service db(database)[Database
+
+
+==>
+
+ArchitectureDiagram(DiagramName,Service(ServiceKeyword,NodeId,Icon,⚠),Edge(NodeId,⚠))
+
+# Unknown diagram name
+
+Architecture2
+
+==>
+
+ArchitectureDiagram(⚠)
diff --git a/packages/codemirror/src/languages/mermaid/test/block.txt b/packages/codemirror/src/languages/mermaid/test/block.txt
index 3ff9ca6276..91e7167c45 100644
--- a/packages/codemirror/src/languages/mermaid/test/block.txt
+++ b/packages/codemirror/src/languages/mermaid/test/block.txt
@@ -104,3 +104,39 @@ block-beta %% comment
==>
BlockDiagram(DiagramName,LineComment,Node(NodeId))
+
+# Unknown diagram name
+
+Block2
+
+==>
+
+BlockDiagram(⚠,Node(NodeId))
+
+# Arrow between nodes without shapes
+
+block-beta
+ a <--> b
+
+==>
+
+BlockDiagram(DiagramName,Node(NodeId),Arrow,Node(NodeId))
+
+# Arrow directly after a shape
+
+block-beta
+ a["A"]<-->b["B"]
+
+==>
+
+BlockDiagram(DiagramName,Node(NodeId,Shape),Arrow,Node(NodeId,Shape))
+
+# Unclosed shape
+
+block-beta
+ a["A"
+
+
+==>
+
+BlockDiagram(DiagramName,Node(NodeId,Shape))
diff --git a/packages/codemirror/src/languages/mermaid/test/c4.txt b/packages/codemirror/src/languages/mermaid/test/c4.txt
index 7ae8c2df18..cd89ea2ccf 100644
--- a/packages/codemirror/src/languages/mermaid/test/c4.txt
+++ b/packages/codemirror/src/languages/mermaid/test/c4.txt
@@ -71,3 +71,12 @@ Container(web, "Web App")
==>
C4Diagram(DiagramName,LineComment,Element(FunctionName,ArgumentList(Value,String)))
+
+# Comment after title
+
+C4Context
+title %% comment
+
+==>
+
+C4Diagram(DiagramName,Title,LineComment,⚠)
diff --git a/packages/codemirror/src/languages/mermaid/test/class.txt b/packages/codemirror/src/languages/mermaid/test/class.txt
index 8a34aa5df8..c48e4622b5 100644
--- a/packages/codemirror/src/languages/mermaid/test/class.txt
+++ b/packages/codemirror/src/languages/mermaid/test/class.txt
@@ -164,3 +164,14 @@ classDiagram
==>
ClassDiagram(DiagramName,Direction(DirectionKw,DirectionValue),ClassDef(Class,ClassName,ClassBody(Member,Member)),AnnotationStatement(Annotation,ClassName),Relation(ClassName,RelationArrow,ClassName,Label(LabelText)),Note(NoteKw,For,ClassName,String))
+
+# Comment in a class body
+
+classDiagram
+class A {
+ %% comment
+}
+
+==>
+
+ClassDiagram(DiagramName,ClassDef(Class,ClassName,ClassBody("{",LineComment,"}")))
diff --git a/packages/codemirror/src/languages/mermaid/test/er.txt b/packages/codemirror/src/languages/mermaid/test/er.txt
index 5fb4fc74d5..bf774a239a 100644
--- a/packages/codemirror/src/languages/mermaid/test/er.txt
+++ b/packages/codemirror/src/languages/mermaid/test/er.txt
@@ -84,3 +84,12 @@ erDiagram
==>
ERDiagram(DiagramName,LineComment,Relationship(EntityName,RelationshipToken,EntityName,LabelText))
+
+# Comment after a relationship colon
+
+erDiagram
+ A ||--o{ B : %% comment
+
+==>
+
+ERDiagram(DiagramName,Relationship(EntityName,RelationshipToken,EntityName,":",LineComment,⚠))
diff --git a/packages/codemirror/src/languages/mermaid/test/flowchart.txt b/packages/codemirror/src/languages/mermaid/test/flowchart.txt
index 3e9365b1a1..c51125b1bc 100644
--- a/packages/codemirror/src/languages/mermaid/test/flowchart.txt
+++ b/packages/codemirror/src/languages/mermaid/test/flowchart.txt
@@ -570,3 +570,12 @@ flowchart LR
==>
FlowchartDiagram(DiagramName,Orientation,NodeId,Link,NodeId,NodeId,Link,NodeId)
+
+# Style without text
+
+flowchart LR
+ style A
+
+==>
+
+FlowchartDiagram(DiagramName,Orientation,StyleKeyword,NodeId,⚠)
diff --git a/packages/codemirror/src/languages/mermaid/test/kanban.txt b/packages/codemirror/src/languages/mermaid/test/kanban.txt
index 4883eb0107..20c72193af 100644
--- a/packages/codemirror/src/languages/mermaid/test/kanban.txt
+++ b/packages/codemirror/src/languages/mermaid/test/kanban.txt
@@ -108,3 +108,23 @@ kanban
==>
KanbanDiagram(DiagramName,Column(ColumnTitle),Card(Node(⚠,CardText,"]")))
+
+# Empty card
+
+kanban
+ todo
+ id1[]
+
+==>
+
+KanbanDiagram(DiagramName,Column(ColumnTitle),Card(NodeId,Node("[","]")))
+
+# Unclosed metadata
+
+kanban
+ todo
+ id1[Task]@{ priority: high
+
+==>
+
+KanbanDiagram(DiagramName,Column(ColumnTitle),Card(NodeId,Node("[",CardText,"]"),Metadata))
diff --git a/packages/codemirror/src/languages/mermaid/test/mindmap.txt b/packages/codemirror/src/languages/mermaid/test/mindmap.txt
index 62731f26a0..9c86c2067b 100644
--- a/packages/codemirror/src/languages/mermaid/test/mindmap.txt
+++ b/packages/codemirror/src/languages/mermaid/test/mindmap.txt
@@ -140,3 +140,41 @@ Root
==>
MindmapDiagram(DiagramName,Line(LineText1),Line(LineText2,ShapedText(LineText2)),Line(ClassLine(LineText2)),Line(LineText2,ShapedText(LineText2)),Line(LineText2))
+
+# Shape at the start of a line
+
+mindmap
+ (root)
+
+==>
+
+MindmapDiagram(DiagramName,Line(ShapedText(LineText3)))
+
+# Tab indentation
+
+mindmap
+ root
+ child
+ grandchild
+
+==>
+
+MindmapDiagram(DiagramName,Line(LineText5),Line(LineText4),Line(LineText4))
+
+# Root on the diagram line (unsupported, parses as empty lines)
+
+mindmap root
+
+==>
+
+MindmapDiagram(DiagramName,Line,Line,Line,Line)
+
+# Lines starting with a hash
+
+mindmap
+ # x
+#x
+
+==>
+
+MindmapDiagram(DiagramName,Line,Line,Line)
diff --git a/packages/codemirror/src/languages/mermaid/test/packet.txt b/packages/codemirror/src/languages/mermaid/test/packet.txt
index 61d3747ab9..8cb1578b64 100644
--- a/packages/codemirror/src/languages/mermaid/test/packet.txt
+++ b/packages/codemirror/src/languages/mermaid/test/packet.txt
@@ -62,3 +62,12 @@ title UDP Packet
==>
PacketDiagram(DiagramName,Title,TitleText,Field(Range(Number,Number),String),LineComment,Field(Range(Number,Number),String))
+
+# Title without text
+
+packet-beta
+title
+
+==>
+
+PacketDiagram(DiagramName,Title,⚠)
diff --git a/packages/codemirror/src/languages/mermaid/test/requirement.txt b/packages/codemirror/src/languages/mermaid/test/requirement.txt
index 5ac3b4e52c..5218194949 100644
--- a/packages/codemirror/src/languages/mermaid/test/requirement.txt
+++ b/packages/codemirror/src/languages/mermaid/test/requirement.txt
@@ -406,3 +406,12 @@ requirementDiagram
==>
RequirementDiagram(DiagramName,SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,ID(PropKeyword),IDNumber,Text(PropKeyword),UnquotedString,Risk(PropKeyword),RiskType(Keyword),VerifyMethod(PropKeyword),VerifyMethodType(Keyword),SubDiagramType,UnquotedString,Type(PropKeyword),UnquotedString,SubDiagramType,UnquotedString,Type(PropKeyword),UnquotedString,DocRef(PropKeyword),UnquotedString,SubDiagramType,UnquotedString,Type(PropKeyword),QuotedString,DocRef(PropKeyword),UnquotedString,RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,Hyphen,RelationshipType(Keyword),ForwardArrow,UnquotedString),RelationshipLine(RelationshipStart,BackArrow,RelationshipType(Keyword),Hyphen,UnquotedString))
+
+# Element name at the end of input
+
+requirementDiagram
+ a
+
+==>
+
+RequirementDiagram(DiagramName,⚠)
diff --git a/packages/codemirror/src/languages/mermaid/test/sankey.txt b/packages/codemirror/src/languages/mermaid/test/sankey.txt
index 0d7230a2c7..c336040f46 100644
--- a/packages/codemirror/src/languages/mermaid/test/sankey.txt
+++ b/packages/codemirror/src/languages/mermaid/test/sankey.txt
@@ -53,3 +53,22 @@ A,B,10
==>
SankeyDiagram(DiagramName,Row(Field,Field,Value))
+
+# Spaces around fields
+
+sankey-beta
+a, b ,1
+
+==>
+
+SankeyDiagram(DiagramName,Row(Field,Field,Value))
+
+# Unclosed quoted field
+
+sankey-beta
+"a,b,1
+c,d,2
+
+==>
+
+SankeyDiagram(DiagramName,Row(Field,⚠),Row(Field,Field,Value))
diff --git a/packages/codemirror/src/languages/mermaid/test/state.txt b/packages/codemirror/src/languages/mermaid/test/state.txt
index 547e10d9f2..2d09f23737 100644
--- a/packages/codemirror/src/languages/mermaid/test/state.txt
+++ b/packages/codemirror/src/languages/mermaid/test/state.txt
@@ -123,3 +123,12 @@ stateDiagram-v2
==>
StateDiagram(DiagramName,Direction(DirectionKw,DirectionValue),Transition(StateRef(StartEnd),Arrow,StateRef(StateName)),Transition(StateRef(StateName),Arrow,StateRef(StateName),Label(LabelText)),StateDecl(State,StateName,Annotation),StateDecl(State,StateName,StateBody(Transition(StateRef(StartEnd),Arrow,StateRef(StateName)))),Note(NoteKw,Position(Right),Of,StateName,Label(LabelText)))
+
+# Comment after a transition colon
+
+stateDiagram-v2
+ A --> B : %% comment
+
+==>
+
+StateDiagram(DiagramName,Transition(StateRef(StateName),Arrow,StateRef(StateName),Label(":",LineComment,⚠)))