Refactor configuration generation and analysis command

- Removed the `TryGenerateConfig` method from `Program.cs` to streamline the main execution flow.
- Integrated configuration generation directly into the `AnalyseCommand`, allowing users to create a default configuration file via the `--generate-config` option.
- Updated `AnalyseCommandSettings` to include a new command option for generating configuration files.
- Enhanced `IConsoleNotifier` and its implementation to provide feedback when a configuration file is created, improving user experience.
- Aimed to simplify the command-line interface and improve usability for new users setting up the analysis environment.

Author: floriankraemer

CognitiveCodeAnalysisConsoleApp.Tests/src/Application/AnalyseApplicationServiceTests.cs

@@ -218,6 +218,8 @@ public void WriteReportGenerated(string reportType, string fullPath) { }
 
         public void WriteConfigUsed(string configSourceDisplay)
             => ConfigUsedMessages.Add(configSourceDisplay);
+
+        public void WriteConfigFileCreated(string fullPath) { }
     }
 
     private sealed class RecordingReportGenerationService : IReportGenerationService

CognitiveCodeAnalysisConsoleApp.Tests/src/Commands/AnalyseCommandCliIntegrationTests.cs

@@ -116,5 +116,7 @@ public void WriteNoSourceFilesFound(string absoluteSourcePath) { }
         public void WriteReportGenerated(string reportType, string fullPath) { }
 
         public void WriteConfigUsed(string configSourceDisplay) { }
+
+        public void WriteConfigFileCreated(string fullPath) { }
     }
 }

CognitiveCodeAnalysisConsoleApp.Tests/src/Commands/AnalyseCommandSettingsTests.cs

@@ -63,6 +63,26 @@ public void ParseLongReportFormatAndOutputOptions_MapsToAnalysisRequest()
         Assert.That(request.OutputFile, Is.EqualTo(".\\report.html"));
     }
 
+    [Test]
+    public void ParseGenerateConfigWithoutPath_SetsGenerateConfigFlag()
+    {
+        Parse("--generate-config");
+
+        Assert.That(CliParseProbeCommand.Parsed, Is.Not.Null);
+        Assert.That(CliParseProbeCommand.Parsed!.GenerateConfig.IsSet, Is.True);
+        Assert.That(CliParseProbeCommand.Parsed.GenerateConfig.Value, Is.Null);
+    }
+
+    [Test]
+    public void ParseGenerateConfigWithPath_BindsDirectory()
+    {
+        Parse("--generate-config .\\config");
+
+        Assert.That(CliParseProbeCommand.Parsed, Is.Not.Null);
+        Assert.That(CliParseProbeCommand.Parsed!.GenerateConfig.IsSet, Is.True);
+        Assert.That(CliParseProbeCommand.Parsed.GenerateConfig.Value, Is.EqualTo(".\\config"));
+    }
+
     private static void Parse(string commandLine)
     {
         var services = new ServiceCollection();

CognitiveCodeAnalysisConsoleApp/src/Commands/AnalyseCommand.cs

@@ -24,6 +24,16 @@ CancellationToken cancellationToken
     ) {
         try
         {
+            if (settings.GenerateConfig.IsSet)
+            {
+                string directory = string.IsNullOrWhiteSpace(settings.GenerateConfig.Value)
+                    ? Directory.GetCurrentDirectory()
+                    : settings.GenerateConfig.Value!;
+                string written = ConfigFileGenerator.Generate(directory);
+                consoleNotifier.WriteConfigFileCreated(written);
+                return Success;
+            }
+
             var request = AnalyseRequestMapper.FromSettings(settings);
             var result = applicationService.Run(request);
 

CognitiveCodeAnalysisConsoleApp/src/Commands/AnalyseCommandSettings.cs

@@ -18,6 +18,10 @@ internal sealed class AnalyseCommandSettings : CommandSettings
     [CommandOption("-c|--config")]
     public string? ConfigFile { get; init; }
 
+    [Description("Write a default cognitive-metrics-settings.json to [path] or the current directory, then exit")]
+    [CommandOption("--generate-config [path]")]
+    public FlagValue<string?> GenerateConfig { get; init; }
+
     [Description("Report type: ConsoleText, Html, Markdown, Json, Sarif, GithubActions, GitlabCodeQuality, Csv. Defaults to console.")]
     [CommandOption("-f|-r|--report-type|--report-format")]
     [DefaultValue("ConsoleText")]

CognitiveCodeAnalysisConsoleApp/src/Infrastructure/IConsoleNotifier.cs

@@ -15,4 +15,6 @@ internal interface IConsoleNotifier
     void WriteReportGenerated(string reportType, string fullPath);
 
     void WriteConfigUsed(string configSourceDisplay);
+
+    void WriteConfigFileCreated(string fullPath);
 }

CognitiveCodeAnalysisConsoleApp/src/Infrastructure/SpectreConsoleNotifier.cs

@@ -22,4 +22,7 @@ public void WriteReportGenerated(string reportType, string fullPath)
 
     public void WriteConfigUsed(string configSourceDisplay)
         => AnsiConsole.MarkupLine($"[grey]Config:[/] {Markup.Escape(configSourceDisplay)}");
+
+    public void WriteConfigFileCreated(string fullPath)
+        => AnsiConsole.MarkupLine($"[green]Config file created:[/] {Markup.Escape(fullPath)}");
 }

CognitiveCodeAnalysisConsoleApp/src/Program.cs

@@ -15,7 +15,6 @@
 using CognitiveCodeAnalysisConsoleApp.DependencyInjection;
 using CognitiveCodeAnalysisConsoleApp.Infrastructure;
 using Microsoft.Extensions.DependencyInjection;
-using Spectre.Console;
 using Spectre.Console.Cli;
 
 namespace CognitiveCodeAnalysisConsoleApp;
@@ -30,12 +29,6 @@ public class Program
 {
     public static int Main(string[] args)
     {
-        int? generateConfigExitCode = TryGenerateConfig(args);
-        if (generateConfigExitCode.HasValue)
-        {
-            return generateConfigExitCode.Value;
-        }
-
         var serviceCollection = new ServiceCollection();
 
         CognitiveConfiguration defaultConfig = ConfigurationLoader.Load();
@@ -69,21 +62,4 @@ public static int Main(string[] args)
 
         return new CommandApp<AnalyseCommand>(registrar).Run(args);
     }
-
-    private static int? TryGenerateConfig(string[] args)
-    {
-        int generateConfigIndex = Array.IndexOf(args, "--generate-config");
-        if (generateConfigIndex < 0)
-        {
-            return null;
-        }
-
-        string? nextArg = generateConfigIndex + 1 < args.Length ? args[generateConfigIndex + 1] : null;
-        string directory = nextArg is not null && !nextArg.StartsWith('-')
-            ? nextArg
-            : Directory.GetCurrentDirectory();
-        string written = ConfigFileGenerator.Generate(directory);
-        AnsiConsole.MarkupLine($"[green]Config file created:[/] {Markup.Escape(written)}");
-        return 0;
-    }
 }