Add legend to D2 diagrams

rrousselGit · Jul 24, 2023 · b8c5031 · b8c5031
1 parent c325887
commit b8c5031
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/packages/riverpod_graph/lib/src/analyze.dart b/packages/riverpod_graph/lib/src/analyze.dart
@@ -115,7 +115,19 @@ String _buildD2(ProviderGraph providerGraph) {
   const _watchLineStyle = '{style.stroke-width: 4}';
   const _readLineStyle = '{style.stroke-dash: 4}';
 
-  final buffer = StringBuffer();
+  final buffer = StringBuffer('''
+Legend: {
+  Type: {
+    Widget.shape: circle
+    Provider
+  }
+  Arrows: {
+    "." -> "..": read: {style.stroke-dash: 4}
+    "." -> "..": listen
+    "." -> "..": watch: {style.stroke-width: 4}
+  }
+}
+''');
 
   for (final node in providerGraph.consumerWidgets) {
     buffer.writeln('${node.definition.name}.shape: Circle');