update document generation

coenm · Sep 9, 2024 · bac0ee4 · bac0ee4
1 parent c3b3965
commit bac0ee4
Show file tree

Hide file tree

Showing 13 changed files with 257 additions and 183 deletions.
diff --git a/src/RepoM.ActionMenu.CodeGen/Constants.cs b/src/RepoM.ActionMenu.CodeGen/Constants.cs
@@ -0,0 +1,57 @@
+namespace RepoM.ActionMenu.CodeGen;
+
+using System.Collections.Generic;
+using RepoM.ActionMenu.CodeGen.Models;
+
+internal static class Constants
+{
+    internal static readonly Dictionary<string, TypeInfoDescriptor> TypeInfos = new()
+    {
+        {
+            typeof(Interface.YamlModel.Templating.Text).FullName!,
+            new TypeInfoDescriptor(nameof(Text), typeof(Interface.YamlModel.Templating.Text).FullName!)
+                {
+                    Link = "repository_action_types.md#text",
+                }
+        },
+        {
+            typeof(Interface.YamlModel.Templating.Predicate).FullName!,
+            new TypeInfoDescriptor(nameof(Interface.YamlModel.Templating.Predicate), typeof(Interface.YamlModel.Templating.Predicate).FullName!)
+                {
+                    Link = "repository_action_types.md#predicate",
+                }
+        },
+        {
+            typeof(Interface.YamlModel.ActionMenus.Context).FullName!,
+            new TypeInfoDescriptor(nameof(Interface.YamlModel.ActionMenus.Context), typeof(Interface.YamlModel.ActionMenus.Context).FullName!)
+                {
+                    Link = "repository_action_types.md#context",
+                }
+        },
+        {
+            typeof(Interface.YamlModel.ActionMenus.Context).FullName! + "?",
+            new TypeInfoDescriptor(nameof(Interface.YamlModel.ActionMenus.Context), typeof(Interface.YamlModel.ActionMenus.Context).FullName! + "?")
+                {
+                    Link = "repository_action_types.md#context",
+                }
+        },
+    };
+
+    /// <summary>
+    /// Project names of all the projects that are used in the code generation.
+    /// </summary>
+    public static readonly List<string> Projects =
+    [
+        "RepoM.ActionMenu.Interface", // this is for the description of the interface types and its members.
+        "RepoM.ActionMenu.Core",
+
+        "RepoM.Plugin.AzureDevOps",
+        "RepoM.Plugin.Clipboard",
+        "RepoM.Plugin.Heidi",
+        "RepoM.Plugin.LuceneQueryParser",
+        "RepoM.Plugin.SonarCloud",
+        "RepoM.Plugin.Statistics",
+        "RepoM.Plugin.WebBrowser",
+        "RepoM.Plugin.WindowsExplorerGitInfo",
+    ];
+}
diff --git a/src/RepoM.ActionMenu.CodeGen/Misc/FileSystemHelper.cs b/src/RepoM.ActionMenu.CodeGen/Misc/FileSystemHelper.cs
@@ -3,9 +3,9 @@ namespace RepoM.ActionMenu.CodeGen.Misc;
 using System;
 using System.IO;
 
-public static class FileSystemHelper
+internal static class FileSystemHelper
 {
-    public static void DeleteFileIsExist(string pathToGeneratedCode)
+    public static void DeleteFileIfExist(string pathToGeneratedCode)
     {
         if (!File.Exists(pathToGeneratedCode))
         {
@@ -23,15 +23,15 @@ public static void DeleteFileIsExist(string pathToGeneratedCode)
         }
     }
 
-    public static void CheckDirectory(string path)
+    public static void CheckDirectoryExists(string path)
     {
         if (!Directory.Exists(path))
         {
             throw new Exception($"Folder '{path}' does not exist");
         }
     }
 
-    public static void CheckFile(string path)
+    public static void CheckFileExists(string path)
     {
         if (!File.Exists(path))
         {

diff --git a/src/RepoM.ActionMenu.CodeGen/Models/ActionMenuClassDescriptor.cs b/src/RepoM.ActionMenu.CodeGen/Models/ActionMenuClassDescriptor.cs
@@ -9,7 +9,7 @@ public class ActionMenuClassDescriptor : ClassDescriptor
     /// <summary>
     /// Properties
     /// </summary>
-    public List<ActionMenuMemberDescriptor> ActionMenuProperties { get; set; } = new List<ActionMenuMemberDescriptor>();
+    public List<ActionMenuMemberDescriptor> ActionMenuProperties { get; } = [];
 
     public string RepositoryActionName => Name;
 

diff --git a/src/RepoM.ActionMenu.CodeGen/Models/ClassDescriptor.cs b/src/RepoM.ActionMenu.CodeGen/Models/ClassDescriptor.cs
@@ -20,7 +20,7 @@ public class ClassDescriptor : IXmlDocsExtended
     /// <summary>
     /// Properties, Functions, fields etc. etc.
     /// </summary>
-    public List<MemberDescriptor> Members { get; set; } = [];
+    public List<MemberDescriptor> Members { get; } = [];
 
     /// <summary>
     /// Friendly name
@@ -31,6 +31,8 @@ public class ClassDescriptor : IXmlDocsExtended
 
     public string Namespace { get; set; } = null!;
 
+    public string FullName => $"{Namespace}.{ClassName}";
+
     public bool IsEnum => _symbolType == SymbolType.Enum;
 
     public bool IsClass => _symbolType == SymbolType.Class;

diff --git a/src/RepoM.ActionMenu.CodeGen/Models/MemberDescriptor.cs b/src/RepoM.ActionMenu.CodeGen/Models/MemberDescriptor.cs
@@ -8,13 +8,13 @@ public static class TypeInfoDescriptorFactory
     public static TypeInfoDescriptor Create(ITypeSymbol typeSymbol)
     {
         var displayString = typeSymbol.ToDisplayString();
-        if (Program.TypeInfos.TryGetValue(displayString, out TypeInfoDescriptor? typeInfoDescriptor))
+        if (Constants.TypeInfos.TryGetValue(displayString, out TypeInfoDescriptor? typeInfoDescriptor))
         {
             return typeInfoDescriptor;
         }
 
         var result = new TypeInfoDescriptor(typeSymbol);
-        Program.TypeInfos.Add(displayString, result);
+        Constants.TypeInfos.Add(displayString, result);
         return result;
     }
 }

diff --git a/src/RepoM.ActionMenu.CodeGen/Models/ProjectDescriptor.cs b/src/RepoM.ActionMenu.CodeGen/Models/ProjectDescriptor.cs
@@ -11,27 +11,37 @@ public sealed class ProjectDescriptor
     /// <summary>
     /// Assembly Name
     /// </summary>
-    public string AssemblyName { get; set; } = null!;
+    public required string AssemblyName { get; init; }
 
     /// <summary>
     /// Project name
     /// </summary>
-    public string ProjectName { get; set; } = null!;
+    public required string ProjectName { get; init; }
+
+    /// <summary>
+    /// Full filename of the sln or csproj.
+    /// </summary>
+    public required string FullFilename { get; init; }
+
+    /// <summary>
+    /// The directory of the project.
+    /// </summary>
+    public required string Directory { get; init; }
 
     /// <summary>
     /// List of class descriptors for repository actions.
     /// </summary>
-    public List<ActionMenuClassDescriptor> ActionMenus { get; } = new();
+    public List<ActionMenuClassDescriptor> ActionMenus { get; } = [];
 
     /// <summary>
     /// List of class descriptors for context (ie scriban methods, properties)
     /// </summary>
-    public List<ActionMenuContextClassDescriptor> ActionContextMenus { get; } = new();
+    public List<ActionMenuContextClassDescriptor> ActionContextMenus { get; } = [];
 
     /// <summary>
-    /// Regular types (to be used when action type has sub type property)
+    /// Regular types (to be used when action type has subtype property)
     /// </summary>
-    public List<ClassDescriptor> Types { get; } = new();
+    public List<ClassDescriptor> Types { get; } = [];
 
     /// <summary>
     /// when project is plugin, the pluginname.
@@ -51,8 +61,8 @@ public sealed class ProjectDescriptor
     /// <summary>
     /// is plugin or not.
     /// </summary>
-    public bool IsPlugin { get; private set; } = false;
-
+    public bool IsPlugin { get; private set; }
+    
     [ScriptMemberIgnore]
     public void SetPackageInformation(PackageAttribute attribute)
     {

diff --git a/src/RepoM.ActionMenu.CodeGen/ProcessMembersVisitor.cs b/src/RepoM.ActionMenu.CodeGen/ProcessMembersVisitor.cs
@@ -20,11 +20,11 @@ public class ProcessMembersVisitor : IClassDescriptorVisitor
 
     // todo extend.
     private static readonly string[] _collectionTypes =
-        {
-            "System.Collections.Generic.List<T>",
-            "System.Collections.Generic.IList<T>",
-            "System.Collections.Generic.IEnumerable<T>",
-        };
+    [
+        "System.Collections.Generic.List<T>",
+        "System.Collections.Generic.IList<T>",
+        "System.Collections.Generic.IEnumerable<T>",
+    ];
 
     public ProcessMembersVisitor(ITypeSymbol typeSymbol, IDictionary<string, string> files)
     {