Version 1.0.0

 - Keep the graph in the buffer until next header or scope end
 - Update README
 - Refactor, cleanup

Author: A9G-Data-Droid

README.md

@@ -19,13 +19,22 @@ Usage:
   mermaid-graph [options]
 
 Options:
-  --path <path>   Full path to the solution (*.sln) or project (*.csproj) file that will be mapped.
-  --version       Show version information
-  -?, -h, --help  Show help and usage information
-  ```
+  --path <path>         Full path to the solution (*.sln) or project (*.csproj) file that will be mapped.
+  --type <Class|Graph>  The type of diagram to generate (e.g., Graph or Class). [default: Graph]
+  --version             Show version information
+  -?, -h, --help        Show help and usage information
+```
 
 ## Example output from this solution
 
+You can run the following command to generate a class diagram for this solution:
+
+```powershell
+.\mermaid-graph.exe --path "MermaidGraph.NET.sln" --type Class
+```
+
+This will generate a mermaid graph in the console output, which can be piped to a file and used in a markdown document.
+
 ```mermaid
 ---
 title: MermaidGraph.NET.sln
@@ -78,6 +87,16 @@ classDiagram
         version 6.0.4
     }
     MermaidGraphTests ..> coverlet.msbuild
+    class Microsoft.ClearScript.V8{
+        type NuGet
+        version 7.4.5
+    }
+    MermaidGraphTests ..> Microsoft.ClearScript.V8
+    class Microsoft.ClearScript.V8.Native.win-x64{
+        type NuGet
+        version 7.4.5
+    }
+    MermaidGraphTests ..> Microsoft.ClearScript.V8.Native.win-x64
     class Microsoft.NET.Test.Sdk{
         type NuGet
         version 17.13.0

mermaid-graph/Commands.cs

@@ -1,26 +1,9 @@
-using System.Diagnostics;
-using MermaidGraph.Diagrams;
+using MermaidGraph.Diagrams;
 
 namespace MermaidGraph;
 
 /// <summary>
-/// Specifies the type of mermaid diagram to generate.
-/// </summary>
-public enum DiagramType
-{
-    /// <summary>
-    /// Represents a general dependency graph.
-    /// </summary>
-    Graph,
-
-    /// <summary>
-    /// Represents a class diagram.
-    /// </summary>
-    Class
-}
-
-/// <summary>
-/// The commands that can be run by `mermaid-graph`
+/// The commands that can be run by `mermaid-graph`.
 /// </summary>
 public class Commands
 {
@@ -48,7 +31,7 @@ public static string Solution(FileInfo file, DiagramType diagramType = DiagramTy
         return graph.Solution(file);
     }
 
-    private static Diagram GetGraphType(DiagramType diagramType) => diagramType switch
+    private static IMermaidDiagram GetGraphType(DiagramType diagramType) => diagramType switch
     {
         DiagramType.Class => new ClassDiagram(),
         DiagramType.Graph => new GraphDiagram(),

mermaid-graph/Diagrams/ClassDiagram.cs

@@ -3,7 +3,7 @@
 
 namespace MermaidGraph.Diagrams;
 
-internal class ClassDiagram : Diagram
+internal class ClassDiagram : MermaidDiagram
 {
     /// <inheritdoc />
     public override void Header(string title)
@@ -23,13 +23,10 @@ public override string Project(FileInfo file)
         var project = projectCollection.LoadProject(file.FullName);
         GraphProject(project);
         Graph.AppendLine(Fence);
-        var graph = Graph.ToString();
 
-        // Cleanup
-        Graph.Clear();
         projectCollection.UnloadAllProjects();
 
-        return graph;
+        return Graph.ToString();
     }
 
     /// <summary>
@@ -66,13 +63,10 @@ type solution
         }
 
         Graph.AppendLine(Fence);
-        var graph = Graph.ToString();
-        
-        // Cleanup
-        Graph.Clear();
+
         projectCollection.UnloadAllProjects();
 
-        return graph;
+        return Graph.ToString();
     }
 
     private void GraphProject(Project project)

mermaid-graph/Diagrams/DiagramType.cs

@@ -0,0 +1,17 @@
+namespace MermaidGraph.Diagrams;
+
+/// <summary>
+/// Specifies the type of mermaid diagram to generate.
+/// </summary>
+public enum DiagramType
+{
+    /// <summary>
+    /// Represents a general dependency graph.
+    /// </summary>
+    Graph,
+
+    /// <summary>
+    /// Represents a class diagram.
+    /// </summary>
+    Class
+}

mermaid-graph/Diagrams/GraphDiagram.cs

@@ -3,7 +3,7 @@
 
 namespace MermaidGraph.Diagrams;
 
-internal class GraphDiagram : Diagram
+internal class GraphDiagram : MermaidDiagram
 {
     /// <inheritdoc />
     public override void Header(string title)
@@ -23,13 +23,10 @@ public override string Project(FileInfo file)
         var project = projectCollection.LoadProject(file.FullName);
         GraphProject(project);
         Graph.AppendLine(Fence);
-        var graph = Graph.ToString();
 
-        // Cleanup
-        Graph.Clear();
         projectCollection.UnloadAllProjects();
 
-        return graph;
+        return Graph.ToString();
     }
 
     /// <summary>
@@ -66,13 +63,10 @@ type solution
         }
 
         Graph.AppendLine(Fence);
-        var graph = Graph.ToString();
-        
-        // Cleanup
-        Graph.Clear();
+
         projectCollection.UnloadAllProjects();
 
-        return graph;
+        return Graph.ToString();
     }
 
     private void GraphProject(Project project)

mermaid-graph/Diagrams/IMermaidDiagram.cs

@@ -1,7 +1,7 @@
 namespace MermaidGraph.Diagrams;
 
 /// <summary>
-/// This file defines the IMermaidDiagram interface and the Diagram abstract class.
+/// This file defines the IMermaidDiagram interface and the MermaidDiagram abstract class.
 /// The IMermaidDiagram interface provides methods for generating Mermaid diagrams
 /// from Visual Studio project (*.csproj) and solution (*.sln) files.
 /// </summary>

mermaid-graph/Diagrams/Diagram.cs mermaid-graph/Diagrams/MermaidDiagram.csmermaid-graph/Diagrams/Diagram.cs renamed to mermaid-graph/Diagrams/MermaidDiagram.cs

@@ -4,27 +4,27 @@
 namespace MermaidGraph.Diagrams;
 
 /// <summary>
-/// The Diagram abstract class implements shared functionality for Mermaid diagram generation,
+/// The MermaidDiagram abstract class implements shared functionality for Mermaid diagram generation,
 /// including initializing the graph output and managing the graph buffer.
 /// </summary>
-public abstract class Diagram : IMermaidDiagram
+public abstract class MermaidDiagram : IMermaidDiagram
 {
     /// <summary>
-    /// Code block fence
+    /// Code block fence.
     /// </summary>
     public const string Fence = "```";
 
     /// <summary>
-    /// Mermaid code block
+    /// Mermaid code block.
     /// </summary>
     public const string MermaidBegin = Fence + "mermaid";
 
     internal readonly StringBuilder Graph = new();
 
     /// <summary>
-    /// Initialize the Diagram class and ensure MSBuild is registered.
+    /// Initialize the MermaidDiagram class and ensure MSBuild is registered.
     /// </summary>
-    protected Diagram()
+    protected MermaidDiagram()
     {
         if (!MSBuildLocator.IsRegistered)
         {
@@ -33,10 +33,11 @@ protected Diagram()
     }
 
     /// <summary>
-    /// Initialize the graph output
+    /// Initialize the graph output.
     /// </summary>
     public virtual void Header(string title)
     {
+        Graph.Clear();
         Graph.AppendLine(MermaidBegin);
         Graph.AppendLine($"""
                            ---

mermaid-graph/Program.cs

@@ -1,4 +1,6 @@
-namespace MermaidGraph;
+using MermaidGraph.Diagrams;
+
+namespace MermaidGraph;
 
 /// <summary>
 /// mermaid-graph.exe
@@ -9,9 +11,9 @@ public sealed class Program
     /// Outputs a mermaid graph of the dependency diagram for a project, or whole solution.
     /// </summary>
     /// <param name="path">Full path to the solution (*.sln) or project (*.csproj) file that will be mapped.</param>
-    /// <param name="diagramType">The type of diagram to generate (e.g., Graph or Class).</param>
+    /// <param name="type">The type of diagram to generate (e.g., Graph or Class).</param>
     /// <returns>HResult</returns>
-    public static int Main(string? path, DiagramType diagramType = DiagramType.Graph)
+    public static int Main(string? path, DiagramType type = DiagramType.Graph)
     {
         if (path is null)
         {
@@ -32,13 +34,13 @@ public static int Main(string? path, DiagramType diagramType = DiagramType.Graph
         {
             if (path.EndsWith(".csproj"))
             {
-                Console.WriteLine(Commands.Project(file, diagramType));
+                Console.WriteLine(Commands.Project(file, type));
                 return 0;
             }
 
             if (path.EndsWith(".sln"))
             {
-                Console.WriteLine(Commands.Solution(file, diagramType));
+                Console.WriteLine(Commands.Solution(file, type));
                 return 0;
             }
         }

mermaid-graphTests/CommandsTests.cs

@@ -55,7 +55,7 @@ public void DogFoodSolutionTest(DiagramType type, string typeName)
 
     [Test]
     [TestCaseSource(nameof(DiagramTypeTestCases))]
-    public void DogFoodProjectTestAsync(DiagramType type, string typeName)
+    public void DogFoodProjectTest(DiagramType type, string typeName)
     {
         var filePath = FindFileDownTree("*.csproj");
         Assert.That(filePath, Is.Not.Null);
@@ -100,11 +100,11 @@ public void CommandLineFailTests(string? file, int hResult)
 
     private static string ExtractMermaid(string? markup)
     {
-        Assert.That(markup, Does.StartWith(Diagram.MermaidBegin));
-        markup = markup.Substring(Diagram.MermaidBegin.Length + Environment.NewLine.Length);
+        Assert.That(markup, Does.StartWith(MermaidDiagram.MermaidBegin));
+        markup = markup.Substring(MermaidDiagram.MermaidBegin.Length + Environment.NewLine.Length);
 
-        Assert.That(markup, Does.EndWith(Diagram.Fence + Environment.NewLine));
-        return markup.Substring(0, markup.Length - Diagram.MermaidBegin.Length + Environment.NewLine.Length);
+        Assert.That(markup, Does.EndWith(MermaidDiagram.Fence + Environment.NewLine));
+        return markup.Substring(0, markup.Length - MermaidDiagram.MermaidBegin.Length + Environment.NewLine.Length);
     }
 
     private string? DetectType(string markup)