Replace .editorconfig with DotnetConfig

kysect · May 19, 2024 · bf51ea2 · bf51ea2
1 parent 3d5819f
commit bf51ea2
Show file tree

Hide file tree

Showing 63 changed files with 905 additions and 899 deletions.
diff --git a/Sources/Kysect.Configuin.CodeStyleDoc/CodeStyleGenerator.cs b/Sources/Kysect.Configuin.CodeStyleDoc/CodeStyleGenerator.cs
@@ -2,8 +2,8 @@
 using Kysect.CommonLib.Collections.Extensions;
 using Kysect.Configuin.CodeStyleDoc.Models;
 using Kysect.Configuin.Common;
-using Kysect.Configuin.EditorConfig.DocumentModel;
-using Kysect.Configuin.EditorConfig.DocumentModel.Nodes;
+using Kysect.Configuin.DotnetConfig.Syntax;
+using Kysect.Configuin.DotnetConfig.Syntax.Nodes;
 using Kysect.Configuin.RoslynModels;
 using Microsoft.Extensions.Logging;
 using System.Collections.Immutable;
@@ -19,34 +19,34 @@ public CodeStyleGenerator(ILogger logger)
         _logger = logger;
     }
 
-    public CodeStyle Generate(EditorConfigDocument editorConfigDocument, RoslynRules roslynRules)
+    public CodeStyle Generate(DotnetConfigDocument dotnetConfigDocument, RoslynRules roslynRules)
     {
-        editorConfigDocument.ThrowIfNull();
+        dotnetConfigDocument.ThrowIfNull();
         roslynRules.ThrowIfNull();
 
         _logger.LogInformation("Start code style generating.");
 
         IReadOnlyCollection<RoslynStyleRuleOption> roslynRuleOptions = roslynRules.GetOptions();
-        IReadOnlyCollection<IEditorConfigNode> notProcessedSettings = editorConfigDocument.DescendantNodes();
+        IReadOnlyCollection<IDotnetConfigSyntaxNode> notProcessedSettings = dotnetConfigDocument.DescendantNodes();
 
         _logger.LogInformation("Try parse {count} settings", notProcessedSettings.Count);
         notProcessedSettings = notProcessedSettings.Where(IsSupported).ToImmutableList();
 
         IReadOnlyCollection<CodeStyleRoslynOptionConfiguration> optionConfigurations = notProcessedSettings
-            .OfType<EditorConfigRuleOptionNode>()
+            .OfType<DotnetConfigRuleOptionNode>()
             .Select(o => ParseOptionSettings(o, roslynRuleOptions))
             .ToList();
         _logger.LogInformation("Parsed {count} option configurations", optionConfigurations.Count);
 
-        notProcessedSettings = notProcessedSettings.Where(r => r is not EditorConfigRuleOptionNode).ToImmutableList();
+        notProcessedSettings = notProcessedSettings.Where(r => r is not DotnetConfigRuleOptionNode).ToImmutableList();
 
         IReadOnlyCollection<ICodeStyleElement> ruleConfiguration = notProcessedSettings
-            .OfType<EditorConfigRuleSeverityNode>()
+            .OfType<DotnetConfigRuleSeverityNode>()
             .Select(severitySetting => ParseRuleSettings(severitySetting, optionConfigurations, roslynRules))
             .ToList();
         _logger.LogInformation("Parsed {count} rule severity", ruleConfiguration.Count);
 
-        notProcessedSettings = notProcessedSettings.Where(r => r is not EditorConfigRuleSeverityNode).ToImmutableList();
+        notProcessedSettings = notProcessedSettings.Where(r => r is not DotnetConfigRuleSeverityNode).ToImmutableList();
 
         if (notProcessedSettings.Any())
         {
@@ -61,30 +61,30 @@ public CodeStyle Generate(EditorConfigDocument editorConfigDocument, RoslynRules
         return new CodeStyle(ruleConfiguration);
     }
 
-    private bool IsSupported(IEditorConfigNode setting)
+    private bool IsSupported(IDotnetConfigSyntaxNode setting)
     {
-        if (setting is not IEditorConfigPropertyNode)
+        if (setting is not IDotnetConfigPropertySyntaxNode)
         {
             return false;
         }
 
         // TODO: #35 support parsing for this rule 
-        if (setting is EditorConfigRuleSeverityNode severityEditorConfigRule
+        if (setting is DotnetConfigRuleSeverityNode severityEditorConfigRule
             && severityEditorConfigRule.RuleId.Equals(RoslynRuleId.Parse("IDE1006")))
         {
             _logger.LogWarning("Rule IDE1006 is not supported and will be skipped.");
             return false;
         }
 
         // TODO: #35 Probably, most of this rules related to IDE1006
-        if (setting is EditorConfigRuleCompositeOptionNode compositeSetting)
+        if (setting is DotnetConfigRuleCompositeOptionNode compositeSetting)
         {
             _logger.LogWarning("{setting} is not supported and will be skipped.", compositeSetting.ToFullString());
             return false;
         }
 
         // TODO: Maybe we need to support it in some way
-        if (setting is EditorConfigGeneralOptionNode generalSetting)
+        if (setting is DotnetConfigGeneralOptionNode generalSetting)
         {
             _logger.LogWarning("{option} is not supported and will be skipped.", generalSetting.ToFullString());
             return false;
@@ -93,42 +93,42 @@ private bool IsSupported(IEditorConfigNode setting)
         return true;
     }
 
-    private CodeStyleRoslynOptionConfiguration ParseOptionSettings(EditorConfigRuleOptionNode optionEditorConfigSetting, IReadOnlyCollection<RoslynStyleRuleOption> styleRuleOptions)
+    private CodeStyleRoslynOptionConfiguration ParseOptionSettings(DotnetConfigRuleOptionNode optionDotnetConfigSetting, IReadOnlyCollection<RoslynStyleRuleOption> styleRuleOptions)
     {
-        RoslynStyleRuleOption? roslynStyleRuleOption = styleRuleOptions.SingleOrDefault(o => o.Name == optionEditorConfigSetting.Key);
+        RoslynStyleRuleOption? roslynStyleRuleOption = styleRuleOptions.SingleOrDefault(o => o.Name == optionDotnetConfigSetting.Key);
 
         if (roslynStyleRuleOption is null)
-            throw new ConfiguinException($"Option {optionEditorConfigSetting.Key} was not found in documentation");
+            throw new ConfiguinException($"Option {optionDotnetConfigSetting.Key} was not found in documentation");
 
-        return new CodeStyleRoslynOptionConfiguration(roslynStyleRuleOption, optionEditorConfigSetting.Value);
+        return new CodeStyleRoslynOptionConfiguration(roslynStyleRuleOption, optionDotnetConfigSetting.Value);
     }
 
     private ICodeStyleElement ParseRuleSettings(
-        EditorConfigRuleSeverityNode severityEditorConfigSetting,
+        DotnetConfigRuleSeverityNode severityDotnetConfigSetting,
         IReadOnlyCollection<CodeStyleRoslynOptionConfiguration> optionConfigurations,
         RoslynRules roslynRules)
     {
-        RoslynStyleRuleGroup? ruleGroup = roslynRules.StyleRuleGroups.SingleOrDefault(g => g.Rules.Any(r => r.RuleId.Equals(severityEditorConfigSetting.RuleId)));
+        RoslynStyleRuleGroup? ruleGroup = roslynRules.StyleRuleGroups.SingleOrDefault(g => g.Rules.Any(r => r.RuleId.Equals(severityDotnetConfigSetting.RuleId)));
 
         if (ruleGroup is not null)
         {
-            RoslynStyleRule rule = ruleGroup.Rules.Single(r => r.RuleId.Equals(severityEditorConfigSetting.RuleId));
+            RoslynStyleRule rule = ruleGroup.Rules.Single(r => r.RuleId.Equals(severityDotnetConfigSetting.RuleId));
             var options = ruleGroup
                 .Options
                 .Select(o => FindOptionConfiguration(optionConfigurations, o.Name))
                 .WhereNotNull()
                 .ToList();
 
-            return new CodeStyleRoslynStyleRuleConfiguration(rule, severityEditorConfigSetting.ParseSeverity(), options, ruleGroup.Overview, ruleGroup.Example);
+            return new CodeStyleRoslynStyleRuleConfiguration(rule, severityDotnetConfigSetting.ParseSeverity(), options, ruleGroup.Overview, ruleGroup.Example);
         }
 
-        RoslynQualityRule? roslynQualityRule = roslynRules.QualityRules.FirstOrDefault(q => q.RuleId.Equals(severityEditorConfigSetting.RuleId));
+        RoslynQualityRule? roslynQualityRule = roslynRules.QualityRules.FirstOrDefault(q => q.RuleId.Equals(severityDotnetConfigSetting.RuleId));
         if (roslynQualityRule is not null)
         {
-            return new CodeStyleRoslynQualityRuleConfiguration(roslynQualityRule, severityEditorConfigSetting.ParseSeverity());
+            return new CodeStyleRoslynQualityRuleConfiguration(roslynQualityRule, severityDotnetConfigSetting.ParseSeverity());
         }
 
-        throw new ConfiguinException($"Rule with id {severityEditorConfigSetting.RuleId} was not found");
+        throw new ConfiguinException($"Rule with id {severityDotnetConfigSetting.RuleId} was not found");
     }
 
     private CodeStyleRoslynOptionConfiguration? FindOptionConfiguration(

diff --git a/Sources/Kysect.Configuin.CodeStyleDoc/ICodeStyleGenerator.cs b/Sources/Kysect.Configuin.CodeStyleDoc/ICodeStyleGenerator.cs
@@ -1,10 +1,10 @@
 using Kysect.Configuin.CodeStyleDoc.Models;
-using Kysect.Configuin.EditorConfig.DocumentModel.Nodes;
+using Kysect.Configuin.DotnetConfig.Syntax.Nodes;
 using Kysect.Configuin.RoslynModels;
 
 namespace Kysect.Configuin.CodeStyleDoc;
 
 public interface ICodeStyleGenerator
 {
-    CodeStyle Generate(EditorConfigDocument editorConfigDocument, RoslynRules roslynRules);
+    CodeStyle Generate(DotnetConfigDocument dotnetConfigDocument, RoslynRules roslynRules);
 }
diff --git a/Sources/Kysect.Configuin.CodeStyleDoc/Kysect.Configuin.CodeStyleDoc.csproj b/Sources/Kysect.Configuin.CodeStyleDoc/Kysect.Configuin.CodeStyleDoc.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
-    <ProjectReference Include="..\Kysect.Configuin.EditorConfig\Kysect.Configuin.EditorConfig.csproj" />
+    <ProjectReference Include="..\Kysect.Configuin.DotnetConfig\Kysect.Configuin.DotnetConfig.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.RoslynModels\Kysect.Configuin.RoslynModels.csproj" />
   </ItemGroup>
 </Project>
diff --git a/Sources/Kysect.Configuin.ConfigurationRoot/DependencyBuilder.cs b/Sources/Kysect.Configuin.ConfigurationRoot/DependencyBuilder.cs
@@ -1,12 +1,12 @@
 using Kysect.Configuin.CodeStyleDoc;
 using Kysect.Configuin.CodeStyleDoc.Markdown;
+using Kysect.Configuin.DotnetConfig.Formatter;
+using Kysect.Configuin.DotnetConfig.Syntax;
+using Kysect.Configuin.DotnetConfig.Template;
 using Kysect.Configuin.DotnetFormatIntegration;
 using Kysect.Configuin.DotnetFormatIntegration.Abstractions;
 using Kysect.Configuin.DotnetFormatIntegration.Cli;
 using Kysect.Configuin.DotnetFormatIntegration.FileSystem;
-using Kysect.Configuin.EditorConfig.DocumentModel;
-using Kysect.Configuin.EditorConfig.Formatter;
-using Kysect.Configuin.EditorConfig.Template;
 using Kysect.Configuin.Learn;
 using Kysect.Configuin.Learn.Abstraction;
 using Kysect.Configuin.Markdown.TextExtractor;
@@ -42,9 +42,9 @@ public static IServiceCollection InitializeServiceProvider()
         serviceCollection.AddSingleton<TemporaryFileMover>();
         serviceCollection.AddSingleton<DotnetFormatReportComparator>();
         serviceCollection.AddSingleton<DotnetFormatPreviewGenerator>();
-        serviceCollection.AddSingleton<EditorConfigTemplateGenerator>();
-        serviceCollection.AddSingleton<EditorConfigDocumentParser>();
-        serviceCollection.AddSingleton<EditorConfigFormatter>();
+        serviceCollection.AddSingleton<DotnetConfigDocumentTemplateGenerator>();
+        serviceCollection.AddSingleton<DotnetConfigDocumentParser>();
+        serviceCollection.AddSingleton<DotnetConfigDocumentFormatter>();
 
         return serviceCollection;
     }

diff --git a/Sources/Kysect.Configuin.ConfigurationRoot/Kysect.Configuin.ConfigurationRoot.csproj b/Sources/Kysect.Configuin.ConfigurationRoot/Kysect.Configuin.ConfigurationRoot.csproj
@@ -16,7 +16,6 @@
     <ProjectReference Include="..\Kysect.Configuin.CodeStyleDoc\Kysect.Configuin.CodeStyleDoc.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.Common\Kysect.Configuin.Common.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.DotnetFormatIntegration\Kysect.Configuin.DotnetFormatIntegration.csproj" />
-    <ProjectReference Include="..\Kysect.Configuin.EditorConfig\Kysect.Configuin.EditorConfig.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.Learn\Kysect.Configuin.Learn.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.Markdown\Kysect.Configuin.Markdown.csproj" />
     <ProjectReference Include="..\Kysect.Configuin.RoslynModels\Kysect.Configuin.RoslynModels.csproj" />

diff --git a/Sources/Kysect.Configuin.Console/CommandAppInitializer.cs b/Sources/Kysect.Configuin.Console/CommandAppInitializer.cs
@@ -14,10 +14,10 @@ public static CommandApp Initialize(IServiceCollection services)
         app.Configure(config =>
         {
             config.AddCommand<GenerateCodeStyleDocCommand>("generate-styledoc");
-            config.AddCommand<EditorConfigApplyPreviewCommand>("preview");
-            config.AddCommand<AnalyzeEditorConfigCommand>("analyze");
-            config.AddCommand<GenerateEditorConfigTemplateTemplate>("template");
-            config.AddCommand<FormatEditorconfigCommand>("format");
+            config.AddCommand<PreviewDotnetConfigChangesCommand>("preview");
+            config.AddCommand<AnalyzeDotnetConfigCommand>("analyze");
+            config.AddCommand<GenerateDotnetConfigTemplateCommand>("template");
+            config.AddCommand<FormatDotnetConfigCommand>("format");
             config.AddCommand<GenerateRoslynRuleDocumentationFile>("generate-roslyn-documentation");
         });
 

diff --git a/Sources/Kysect.Configuin.Console/Commands/AnalyzeDotnetConfigCommand.cs b/Sources/Kysect.Configuin.Console/Commands/AnalyzeDotnetConfigCommand.cs
@@ -0,0 +1,55 @@
+using Kysect.CommonLib.BaseTypes.Extensions;
+using Kysect.Configuin.DotnetConfig.Analyzing;
+using Kysect.Configuin.DotnetConfig.Syntax;
+using Kysect.Configuin.DotnetConfig.Syntax.Nodes;
+using Kysect.Configuin.Learn.Abstraction;
+using Kysect.Configuin.RoslynModels;
+using Microsoft.Extensions.Logging;
+using Spectre.Console.Cli;
+using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Kysect.Configuin.Console.Commands;
+
+internal sealed class AnalyzeDotnetConfigCommand(
+    IRoslynRuleDocumentationParser roslynRuleDocumentationParser,
+    DotnetConfigDocumentParser dotnetConfigDocumentParser,
+    ILogger logger
+    ) : Command<AnalyzeDotnetConfigCommand.Settings>
+{
+    public sealed class Settings : CommandSettings
+    {
+        [Description("Path to dotnet config file.")]
+        [CommandArgument(0, "[dotnet config path]")]
+        public string? DotnetConfigPath { get; init; }
+
+        [Description("Path to cloned MS Learn repository.")]
+        [CommandOption("-d|--documentation")]
+        public string? MsLearnRepositoryPath { get; init; }
+    }
+
+    public override int Execute([NotNull] CommandContext context, [NotNull] Settings settings)
+    {
+        settings.DotnetConfigPath.ThrowIfNull();
+
+        DotnetConfigDocumentAnalyzer dotnetConfigDocumentAnalyzer = new DotnetConfigDocumentAnalyzer();
+        IDotnetConfigAnalyzeReporter reporter = new DotnetConfigAnalyzeLogReporter(logger);
+
+        RoslynRules roslynRules = settings.MsLearnRepositoryPath is null
+            ? RoslynRuleDocumentationCache.ReadFromCache()
+            : roslynRuleDocumentationParser.Parse(settings.MsLearnRepositoryPath);
+
+        string editorConfigContent = File.ReadAllText(settings.DotnetConfigPath);
+        DotnetConfigDocument dotnetConfigDocument = dotnetConfigDocumentParser.Parse(editorConfigContent);
+
+        DotnetConfigMissedConfiguration dotnetConfigMissedConfiguration = dotnetConfigDocumentAnalyzer.GetMissedConfigurations(dotnetConfigDocument, roslynRules);
+        IReadOnlyCollection<DotnetConfigInvalidOptionValue> incorrectOptionValues = dotnetConfigDocumentAnalyzer.GetIncorrectOptionValues(dotnetConfigDocument, roslynRules);
+        IReadOnlyCollection<RoslynRuleId> incorrectOptionSeverity = dotnetConfigDocumentAnalyzer.GetIncorrectOptionSeverity(dotnetConfigDocument, roslynRules);
+
+        reporter.ReportMissedConfigurations(dotnetConfigMissedConfiguration);
+        reporter.ReportIncorrectOptionValues(incorrectOptionValues);
+        reporter.ReportIncorrectOptionSeverity(incorrectOptionSeverity);
+
+        return 0;
+    }
+}
diff --git a/Sources/Kysect.Configuin.Console/Commands/AnalyzeEditorConfigCommand.cs b/Sources/Kysect.Configuin.Console/Commands/AnalyzeEditorConfigCommand.cs