Merge pull request #49 from JansthcirlU/48-add-editorconfig-and-format-step-in-pipeline

Author: JansthcirlU

.editorconfig

@@ -4,7 +4,7 @@ root = true
 # Basic formatting
 indent_style = space
 indent_size = 4
-end_of_line = crlf
+end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 

.github/workflows/build-and-test.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - "main"
+
   pull_request:
     branches:
       - "main"
@@ -17,14 +18,22 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - name: Checkout code
+      uses: actions/checkout@v4
+
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.0.x
+
+    - name: Check formatter rules
+      run: dotnet format --verify-no-changes --verbosity diagnostic
+
     - name: Restore dependencies
       run: dotnet restore
+
     - name: Build
       run: dotnet build --no-restore
+
     - name: Test
       run: dotnet test --no-build --verbosity normal

src/Mermaid.Flowcharts/Flowchart.cs

@@ -30,7 +30,10 @@ public Flowchart(FlowchartTitle title, FlowchartDirection? direction = null) : t
 
     public Flowchart AddNode(INode node)
     {
-        if (node is Node nd && Nodes.Any(nd.Equals)) return this;
+        if (node is Node nd && Nodes.Any(nd.Equals))
+        {
+            return this;
+        }
 
         _nodes.Add(node);
         return this;
@@ -60,12 +63,20 @@ public string ToMermaidString(int indentations = 0, string indentationText = "
         {
             flowchartStringBuilder.AppendLine(node.ToMermaidString(indentations + 1, indentationText));
         }
-        if (Subgraphs.Any()) flowchartStringBuilder.AppendLine();
+        if (Subgraphs.Any())
+        {
+            flowchartStringBuilder.AppendLine();
+        }
+
         foreach (Subgraph subgraph in Subgraphs)
         {
             flowchartStringBuilder.AppendLine(subgraph.ToMermaidString(indentations + 1, indentationText));
         }
-        if (_links.Any()) flowchartStringBuilder.AppendLine();
+        if (_links.Any())
+        {
+            flowchartStringBuilder.AppendLine();
+        }
+
         foreach (Link link in _links)
         {
             flowchartStringBuilder.AppendLine(link.ToMermaidString(indentations + 1, indentationText));
@@ -75,15 +86,27 @@ public string ToMermaidString(int indentations = 0, string indentationText = "
         Dictionary<NodeStyle, HashSet<NodeIdentifier>> distinctNodeStyles = [];
         foreach (Node node in AllNodes)
         {
-            if (node.NodeStyle is null) continue;
+            if (node.NodeStyle is null)
+            {
+                continue;
+            }
 
             // Add node style declaration
-            if (!distinctNodeStyles.ContainsKey(node.NodeStyle)) distinctNodeStyles[node.NodeStyle] = [];
-            distinctNodeStyles[node.NodeStyle].Add(node.Id);
+            if (!distinctNodeStyles.TryGetValue(node.NodeStyle, out HashSet<NodeIdentifier>? value))
+            {
+                value = [];
+                distinctNodeStyles[node.NodeStyle] = value;
+            }
+
+            value.Add(node.Id);
         }
 
         // Add node style declarations and assignments
-        if (distinctNodeStyles.Any()) flowchartStringBuilder.AppendLine();
+        if (distinctNodeStyles.Any())
+        {
+            flowchartStringBuilder.AppendLine();
+        }
+
         foreach ((NodeStyle nodeStyle, HashSet<NodeIdentifier> nodeIds) in distinctNodeStyles)
         {
             flowchartStringBuilder.AppendLine(nodeStyle.ToMermaidString(indentations + 1, indentationText));
@@ -94,20 +117,32 @@ public string ToMermaidString(int indentations = 0, string indentationText = "
         Dictionary<StyleClass, HashSet<int>> distinctLinkStyles = [];
         foreach ((Link link, int index) in AllLinks.Select((l, i) => (l, i)))
         {
-            if (link.LinkStyle is null) continue;
+            if (link.LinkStyle is null)
+            {
+                continue;
+            }
 
             // Add link style declaration
-            if (!distinctLinkStyles.ContainsKey(link.LinkStyle)) distinctLinkStyles[link.LinkStyle] = [];
-            distinctLinkStyles[link.LinkStyle].Add(index);
+            if (!distinctLinkStyles.TryGetValue(link.LinkStyle, out HashSet<int>? value))
+            {
+                value = [];
+                distinctLinkStyles[link.LinkStyle] = value;
+            }
+
+            value.Add(index);
         }
 
         // Add link style declarations and assignments
-        if (distinctLinkStyles.Any()) flowchartStringBuilder.AppendLine();
+        if (distinctLinkStyles.Any())
+        {
+            flowchartStringBuilder.AppendLine();
+        }
+
         foreach ((StyleClass styleClass, HashSet<int> indices) in distinctLinkStyles)
         {
             flowchartStringBuilder.AppendLine($"{indentationText.Repeat(indentations + 1)}linkStyle {string.Join(',', indices)} {styleClass.ToMermaidString()}");
         }
 
         return flowchartStringBuilder.ToString();
     }
-}
+}

src/Mermaid.Flowcharts/FlowchartDirection.cs

@@ -22,4 +22,4 @@ public enum FlowchartDirection
     /// Left to right
     /// </summary>
     LR
-}
+}

src/Mermaid.Flowcharts/FlowchartTitle.cs

@@ -15,10 +15,21 @@ private FlowchartTitle(string text)
 
     public static FlowchartTitle FromString(string text)
     {
-        if (string.IsNullOrEmpty(text)) throw new ArgumentException("Flowchart title must not be null or empty.", nameof(text));
-        if (text.Contains('\n') || text.Contains('\r')) throw new ArgumentException("Flowchart title must not contain new lines.", nameof(text));
-        if (string.IsNullOrEmpty(text.Trim())) throw new ArgumentException("Flowchart title must not be whitespace.", nameof(text));
-        
+        if (string.IsNullOrEmpty(text))
+        {
+            throw new ArgumentException("Flowchart title must not be null or empty.", nameof(text));
+        }
+
+        if (text.Contains('\n') || text.Contains('\r'))
+        {
+            throw new ArgumentException("Flowchart title must not contain new lines.", nameof(text));
+        }
+
+        if (string.IsNullOrEmpty(text.Trim()))
+        {
+            throw new ArgumentException("Flowchart title must not be whitespace.", nameof(text));
+        }
+
         return new(
         $"""
         ---

src/Mermaid.Flowcharts/IMermaidPrintable.cs

@@ -3,4 +3,4 @@ namespace Mermaid.Flowcharts;
 public interface IMermaidPrintable
 {
     string ToMermaidString(int indentations = 0, string indentationText = "  ");
-}
+}

src/Mermaid.Flowcharts/Links/LinkDirection.cs

@@ -6,4 +6,4 @@ public enum LinkDirection
     FromTo,
     ToFrom,
     Both
-}
+}

src/Mermaid.Flowcharts/Links/LinkText.cs

@@ -17,10 +17,22 @@ private LinkText(string text)
 
     public static LinkText FromString(string value)
     {
-        if (string.IsNullOrEmpty(value)) throw new ArgumentException("Link text must not be null or empty.", nameof(value));
-        if (value.Contains('\n') || value.Contains('\r')) throw new ArgumentException("Link text must not contain new lines.", nameof(value));
+        if (string.IsNullOrEmpty(value))
+        {
+            throw new ArgumentException("Link text must not be null or empty.", nameof(value));
+        }
+
+        if (value.Contains('\n') || value.Contains('\r'))
+        {
+            throw new ArgumentException("Link text must not contain new lines.", nameof(value));
+        }
+
         int illegalCharacterIndex = value.AsSpan().IndexOfAny(IllegalCharacters);
-        if (illegalCharacterIndex > -1) throw new ArgumentException($"Link text must not contain illegal character \"{value[illegalCharacterIndex]}\".", nameof(value));
+        if (illegalCharacterIndex > -1)
+        {
+            throw new ArgumentException($"Link text must not contain illegal character \"{value[illegalCharacterIndex]}\".", nameof(value));
+        }
+
         return new(value);
     }
 
@@ -29,4 +41,4 @@ public override string ToString()
 
     public string ToMermaidString(int indentations = 0, string indentationText = "  ")
         => $"{indentationText.Repeat(indentations)}{Value}";
-}
+}

src/Mermaid.Flowcharts/Links/LinkType.cs

@@ -33,7 +33,10 @@ public string ToMermaidString(int indentations = 0, string indentationText = "
             LinkThickness.Invisible => "~~~",
             _ => "---"
         };
-        if (Thickness is LinkThickness.Invisible) return thickness;
+        if (Thickness is LinkThickness.Invisible)
+        {
+            return thickness;
+        }
 
         string arrowLeft = (ArrowType, Direction) switch
         {

src/Mermaid.Flowcharts/Nodes/INode.cs

@@ -8,5 +8,5 @@ public interface INode : IMermaidPrintable
 public interface INode<TNode> : INode, IEquatable<TNode>
     where TNode : INode<TNode>
 {
-    
-}
+
+}