Add possibility to execute commands without cloned MS Learn repository

kysect · May 18, 2024 · dff6e83 · dff6e83
1 parent af9b5a9
commit dff6e83
Show file tree

Hide file tree

Showing 14 changed files with 90 additions and 45 deletions.
diff --git a/Sources/Kysect.Configuin.ConfigurationRoot/Kysect.Configuin.ConfigurationRoot.csproj b/Sources/Kysect.Configuin.ConfigurationRoot/Kysect.Configuin.ConfigurationRoot.csproj
@@ -26,6 +26,9 @@
     <None Update="appsettings.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="roslyn-rules.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="..\.editorconfig" CopyToOutputDirectory="Always" Condition="$(Configuration) == Debug" />
   </ItemGroup>
 

diff --git a/Sources/Kysect.Configuin.ConfigurationRoot/roslyn-rules.json b/Sources/Kysect.Configuin.ConfigurationRoot/roslyn-rules.json
diff --git a/Sources/Kysect.Configuin.Console/Commands/AnalyzeEditorConfigCommand.cs b/Sources/Kysect.Configuin.Console/Commands/AnalyzeEditorConfigCommand.cs
@@ -33,15 +33,17 @@ public sealed class Settings : CommandSettings
     public override int Execute([NotNull] CommandContext context, [NotNull] Settings settings)
     {
         settings.EditorConfigPath.ThrowIfNull();
-        settings.MsLearnRepositoryPath.ThrowIfNull();
 
         EditorConfigAnalyzer editorConfigAnalyzer = new EditorConfigAnalyzer();
         IEditorConfigAnalyzeReporter reporter = new EditorConfigAnalyzeLogReporter(logger);
 
+        RoslynRules roslynRules = settings.MsLearnRepositoryPath is null
+            ? RoslynRuleDocumentationCache.ReadFromCache()
+            : roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+
         string editorConfigContent = File.ReadAllText(settings.EditorConfigPath);
         EditorConfigDocument editorConfigDocument = editorConfigDocumentParser.Parse(editorConfigContent);
         DotnetConfigSettings dotnetConfigSettings = dotnetConfigSettingsParser.Parse(editorConfigDocument);
-        RoslynRules roslynRules = roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
 
         EditorConfigMissedConfiguration editorConfigMissedConfiguration = editorConfigAnalyzer.GetMissedConfigurations(dotnetConfigSettings, roslynRules);
         IReadOnlyCollection<EditorConfigInvalidOptionValue> incorrectOptionValues = editorConfigAnalyzer.GetIncorrectOptionValues(dotnetConfigSettings, roslynRules);

diff --git a/Sources/Kysect.Configuin.Console/Commands/FormatEditorconfigCommand.cs b/Sources/Kysect.Configuin.Console/Commands/FormatEditorconfigCommand.cs
@@ -34,10 +34,11 @@ public sealed class Settings : CommandSettings
     public override int Execute(CommandContext context, Settings settings)
     {
         settings.EditorConfigPath.ThrowIfNull();
-        settings.MsLearnRepositoryPath.ThrowIfNull();
 
         string[] editorConfigContentLines = File.ReadAllLines(settings.EditorConfigPath);
-        RoslynRules roslynRules = roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+        RoslynRules roslynRules = settings.MsLearnRepositoryPath is null
+            ? RoslynRuleDocumentationCache.ReadFromCache()
+            : roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
 
         EditorConfigDocument editorConfigDocument = editorConfigDocumentParser.Parse(editorConfigContentLines);
         EditorConfigDocument formattedDocument = editorConfigFormatter.FormatAccordingToRuleDefinitions(editorConfigDocument, roslynRules, settings.GroupQualityRulesByCategory);

diff --git a/Sources/Kysect.Configuin.Console/Commands/GenerateCodeStyleDocCommand.cs b/Sources/Kysect.Configuin.Console/Commands/GenerateCodeStyleDocCommand.cs
@@ -38,14 +38,15 @@ public sealed class Settings : CommandSettings
     public override int Execute([NotNull] CommandContext context, [NotNull] Settings settings)
     {
         settings.EditorConfigPath.ThrowIfNull();
-        settings.MsLearnRepositoryPath.ThrowIfNull();
         settings.OutputPath.ThrowIfNull();
 
         string editorConfigContent = File.ReadAllText(settings.EditorConfigPath);
         EditorConfigDocument editorConfigDocument = documentParser.Parse(editorConfigContent);
         DotnetConfigSettings dotnetConfigSettings = dotnetConfigSettingsParser.Parse(editorConfigDocument);
 
-        RoslynRules roslynRules = roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+        RoslynRules roslynRules = settings.MsLearnRepositoryPath is null
+            ? RoslynRuleDocumentationCache.ReadFromCache()
+            : roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
 
         CodeStyle codeStyle = codeStyleGenerator.Generate(dotnetConfigSettings, roslynRules);
         codeStyleWriter.Write(settings.OutputPath, codeStyle);

diff --git a/Sources/Kysect.Configuin.Console/Commands/GenerateEditorConfigTemplateTemplate.cs b/Sources/Kysect.Configuin.Console/Commands/GenerateEditorConfigTemplateTemplate.cs
@@ -29,9 +29,11 @@ public sealed class Settings : CommandSettings
     public override int Execute([NotNull] CommandContext context, [NotNull] Settings settings)
     {
         settings.EditorConfigPath.ThrowIfNull();
-        settings.MsLearnRepositoryPath.ThrowIfNull();
 
-        RoslynRules roslynRules = roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+        RoslynRules roslynRules = settings.MsLearnRepositoryPath is null
+            ? RoslynRuleDocumentationCache.ReadFromCache()
+            : roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+
         string editorconfigContent = editorConfigTemplateGenerator.GenerateTemplate(roslynRules);
         // TODO: move to interface?
         logger.LogInformation("Writing .editorconfig template to {path}", settings.EditorConfigPath);

diff --git a/Sources/Kysect.Configuin.Console/Commands/GenerateRoslynRuleDocumentationFile.cs b/Sources/Kysect.Configuin.Console/Commands/GenerateRoslynRuleDocumentationFile.cs
@@ -0,0 +1,36 @@
+using Kysect.CommonLib.BaseTypes.Extensions;
+using Kysect.Configuin.Learn.Abstraction;
+using Kysect.Configuin.RoslynModels;
+using Spectre.Console.Cli;
+using System.ComponentModel;
+using System.Text.Json;
+
+namespace Kysect.Configuin.Console.Commands;
+
+public class GenerateRoslynRuleDocumentationFile(
+    IRoslynRuleDocumentationParser roslynRuleDocumentationParser
+) : Command<GenerateRoslynRuleDocumentationFile.Settings>
+{
+    public sealed class Settings : CommandSettings
+    {
+        [Description("Path to cloned MS Learn repository.")]
+        [CommandArgument(0, "[ms-repo-path]")]
+        public string? MsLearnRepositoryPath { get; init; }
+
+        [Description("Output path.")]
+        [CommandArgument(0, "[output-path]")]
+        public string? OutputPath { get; init; }
+    }
+
+    public override int Execute(CommandContext context, Settings settings)
+    {
+        settings.ThrowIfNull();
+        settings.MsLearnRepositoryPath.ThrowIfNull();
+        settings.OutputPath.ThrowIfNull();
+
+        RoslynRules roslynRules = roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+        string documentation = JsonSerializer.Serialize(roslynRules);
+        File.WriteAllText(settings.OutputPath, documentation);
+        return 0;
+    }
+}
diff --git a/Sources/Kysect.Configuin.Console/Program.cs b/Sources/Kysect.Configuin.Console/Program.cs
@@ -25,6 +25,7 @@ public static void Main(string[] args)
             config.AddCommand<AnalyzeEditorConfigCommand>("analyze");
             config.AddCommand<GenerateEditorConfigTemplateTemplate>("template");
             config.AddCommand<FormatEditorconfigCommand>("format");
+            config.AddCommand<GenerateRoslynRuleDocumentationFile>("generate-roslyn-documentation");
         });
 
         app.Run(args);
@@ -37,7 +38,8 @@ private static string[] PrepareTestCommand()
         string[] analyzeCommand = new[] { "analyze", ".editorconfig", "-d", msLearnRepositoryPath };
         string[] templateGenerateCommand = new[] { "template", ".editorconfig", "-d", msLearnRepositoryPath };
         string[] formatCommand = new[] { "format", ".editorconfig", "-d", msLearnRepositoryPath };
+        string[] generateRoslynDocumentationCommand = new[] { "generate-roslyn-documentation", msLearnRepositoryPath, "roslyn-rules.json" };
 
-        return formatCommand;
+        return generateRoslynDocumentationCommand;
     }
 }
diff --git a/Sources/Kysect.Configuin.Console/RoslynRuleDocumentationCache.cs b/Sources/Kysect.Configuin.Console/RoslynRuleDocumentationCache.cs
@@ -0,0 +1,21 @@
+using Kysect.CommonLib.BaseTypes.Extensions;
+using Kysect.Configuin.Common;
+using Kysect.Configuin.RoslynModels;
+using System.Text.Json;
+
+namespace Kysect.Configuin.Console;
+
+public static class RoslynRuleDocumentationCache
+{
+    public static RoslynRules ReadFromCache()
+    {
+        var fileName = "roslyn-rules.json";
+        if (!File.Exists(fileName))
+        {
+            throw new ConfiguinException($"File with {fileName} was not found");
+        }
+
+        string readAllText = File.ReadAllText(fileName);
+        return JsonSerializer.Deserialize<RoslynRules>(readAllText).ThrowIfNull();
+    }
+}
diff --git a/Sources/Kysect.Configuin.EditorConfig/Analyzing/EditorConfigAnalyzer.cs b/Sources/Kysect.Configuin.EditorConfig/Analyzing/EditorConfigAnalyzer.cs
@@ -25,7 +25,7 @@ public EditorConfigMissedConfiguration GetMissedConfigurations(DotnetConfigSetti
             .ToHashSet();
 
         var missedStyleRules = roslynRules
-            .StyleRules
+            .GetStyleRules()
             .Where(rule => !selectedSeverity.Contains(rule.RuleId))
             .Select(r => r.RuleId)
             .Order()
@@ -74,7 +74,7 @@ public IReadOnlyCollection<RoslynRuleId> GetIncorrectOptionSeverity(DotnetConfig
         ArgumentNullException.ThrowIfNull(roslynRules);
 
         var ruleIds = new HashSet<RoslynRuleId>();
-        ruleIds.AddEach(roslynRules.StyleRules.Select(r => r.RuleId));
+        ruleIds.AddEach(roslynRules.GetStyleRules().Select(r => r.RuleId));
         ruleIds.AddEach(roslynRules.QualityRules.Select(r => r.RuleId));
 
         var result = new List<RoslynRuleId>();

diff --git a/Sources/Kysect.Configuin.Learn/LearnDocumentationParser.cs b/Sources/Kysect.Configuin.Learn/LearnDocumentationParser.cs
@@ -56,7 +56,7 @@ public RoslynRules Parse(string learnRepositoryPath)
     private List<RoslynStyleRuleGroup> AddNamingRule(List<RoslynStyleRuleGroup> roslynStyleRules)
     {
         var namingRule = new RoslynStyleRule(RoslynNameRuleInfo.RuleId, "Code-style naming rules", "Style");
-        var roslynStyleRuleGroup = new RoslynStyleRuleGroup(namingRule, string.Empty, null);
+        var roslynStyleRuleGroup = new RoslynStyleRuleGroup([namingRule], [], string.Empty, null);
 
         roslynStyleRules.Add(roslynStyleRuleGroup);
         return roslynStyleRules;

diff --git a/Sources/Kysect.Configuin.RoslynModels/RoslynRules.cs b/Sources/Kysect.Configuin.RoslynModels/RoslynRules.cs
@@ -1,19 +1,12 @@
 namespace Kysect.Configuin.RoslynModels;
 
-public class RoslynRules
+public record RoslynRules(
+    IReadOnlyCollection<RoslynQualityRule> QualityRules,
+    IReadOnlyCollection<RoslynStyleRuleGroup> StyleRuleGroups)
 {
-    public IReadOnlyCollection<RoslynQualityRule> QualityRules { get; }
-    public IReadOnlyCollection<RoslynStyleRule> StyleRules { get; }
-    public IReadOnlyCollection<RoslynStyleRuleGroup> StyleRuleGroups { get; }
-
-    public RoslynRules(
-        IReadOnlyCollection<RoslynQualityRule> qualityRules,
-        IReadOnlyCollection<RoslynStyleRuleGroup> styleRuleGroups)
+    public IReadOnlyCollection<RoslynStyleRule> GetStyleRules()
     {
-        QualityRules = qualityRules;
-        StyleRuleGroups = styleRuleGroups;
-
-        StyleRules = styleRuleGroups.SelectMany(r => r.Rules).ToList();
+        return StyleRuleGroups.SelectMany(r => r.Rules).ToList();
     }
 
     public IReadOnlyCollection<RoslynStyleRuleOption> GetOptions()

diff --git a/Sources/Kysect.Configuin.RoslynModels/RoslynStyleRuleGroup.cs b/Sources/Kysect.Configuin.RoslynModels/RoslynStyleRuleGroup.cs
@@ -4,22 +4,4 @@ public record RoslynStyleRuleGroup(
     IReadOnlyCollection<RoslynStyleRule> Rules,
     IReadOnlyCollection<RoslynStyleRuleOption> Options,
     string Overview,
-    string? Example)
-{
-    public RoslynStyleRuleGroup(
-        RoslynStyleRule rule,
-        string Overview,
-        string? Example)
-        : this(new[] { rule }, Array.Empty<RoslynStyleRuleOption>(), Overview, Example)
-    {
-    }
-
-    public RoslynStyleRuleGroup(
-        RoslynStyleRule rule,
-        IReadOnlyCollection<RoslynStyleRuleOption> Options,
-        string Overview,
-        string? Example)
-        : this(new[] { rule }, Options, Overview, Example)
-    {
-    }
-}
+    string? Example);
diff --git a/Sources/Kysect.Configuin.Tests/Resources/WellKnownRoslynRuleDefinitions.cs b/Sources/Kysect.Configuin.Tests/Resources/WellKnownRoslynRuleDefinitions.cs
@@ -25,7 +25,8 @@ class C
             Category: "Style");
 
         return new RoslynStyleRuleGroup(
-            rule,
+            [rule],
+            [],
             Overview: overview,
             Example: example);
     }
@@ -114,7 +115,7 @@ class MyClass
             "Add accessibility modifiers",
             "Style");
 
-        return new RoslynStyleRuleGroup(styleRule, new[] { expectedOption }, overview, Example: null);
+        return new RoslynStyleRuleGroup([styleRule], [expectedOption], overview, Example: null);
     }
 
     public static RoslynQualityRule CA1064()