Implement CLI interface using Spectre.Console.Cli

- Added Spectre.Console and Spectre.Console.Cli packages
- Implemented CompareCommand with source/target assembly nomenclature
- Created TypeRegistrar for DI integration
- Updated Program.cs to use Spectre.Console.Cli
- Added comprehensive test coverage for CLI
- Updated Taskfile.yml with test report generation
- Updated README.md with CLI usage examples

Author: jbrinkman

.gitignore

@@ -90,4 +90,4 @@ node_modules/
 *.binlog
 
 # Local History for Visual Studio
-.localhistory/
+.localhistory/test-report/

.kiro/specs/dotnet-api-diff/tasks.md

@@ -92,8 +92,8 @@ Each task should follow this git workflow:
     - **Git Workflow**: Create branch `feature/task-4.3-change-classification`, commit, push, and create PR
     - _Requirements: 3.1, 7.1, 7.2, 7.3, 7.4_
 
-- [ ] 5. Create CLI interface and argument parsing
-  - [ ] 5.1 Implement command-line interface using System.CommandLine
+- [x] 5. Create CLI interface and argument parsing
+  - [x] 5.1 Implement command-line interface using Spectre.Console.Cli
     - Create CLI commands and options for assembly paths, configuration, output format
     - Implement help text and usage examples
     - Write integration tests for CLI argument parsing
@@ -108,11 +108,12 @@ Each task should follow this git workflow:
     - _Requirements: 3.2, 3.3, 5.1, 5.2, 5.3, 5.4_
 
 - [ ] 6. Implement output formatting and reporting
-  - [ ] 6.1 Create console output formatter
-    - Implement ConsoleFormatter with colored output for additions, removals, modifications
+  - [ ] 6.1 Create ReportGenerator and console output formatter
+    - Implement ReportGenerator interface with support for multiple formats
+    - Create ConsoleFormatter with colored output for additions, removals, modifications
     - Add summary statistics and breaking change indicators
     - Write unit tests for console output formatting
-    - **Git Workflow**: Create branch `feature/task-6.1-console-formatter`, commit, push, and create PR
+    - **Git Workflow**: Create branch `feature/task-6.1-report-generator`, commit, push, and create PR
     - _Requirements: 4.4, 8.1, 8.4_
 
   - [ ] 6.2 Implement JSON output formatter

README.md

@@ -66,7 +66,7 @@ task coverage
 task coverage:view
 
 # Run the application with arguments
-task run -- --old old.dll --new new.dll
+task run -- compare source.dll target.dll
 
 # Run CI build sequence
 task ci
@@ -76,22 +76,36 @@ task ci
 
 ```bash
 # Basic comparison
-dotnet run -- --old path/to/old/assembly.dll --new path/to/new/assembly.dll
+dotnet run -- compare source.dll target.dll
 
 # Generate JSON report
-dotnet run -- --old old.dll --new new.dll --format json --output report.json
+dotnet run -- compare source.dll target.dll --output json
 
-# Show only breaking changes
-dotnet run -- --old old.dll --new new.dll --breaking-only
+# Generate markdown report
+dotnet run -- compare source.dll target.dll --output markdown
+
+# Filter to specific namespaces
+dotnet run -- compare source.dll target.dll --filter System.Collections
+
+# Use configuration file
+dotnet run -- compare source.dll target.dll --config config.json
+
+# Enable verbose output
+dotnet run -- compare source.dll target.dll --verbose
 ```
 
 ## Command Line Options
 
-- `--old, -o`: Path to the original assembly
-- `--new, -n`: Path to the new assembly to compare against
-- `--format, -f`: Output format (console, json, xml, html, markdown)
-- `--output, -out`: Output file path (optional, defaults to console)
-- `--breaking-only, -b`: Show only breaking changes
+### Compare Command
+
+- `<sourceAssembly>`: Path to the source/baseline assembly (required)
+- `<targetAssembly>`: Path to the target/current assembly (required)
+- `--config, -c`: Path to configuration file
+- `--output, -o`: Output format (console, json, markdown)
+- `--filter, -f`: Filter to specific namespaces (can be specified multiple times)
+- `--exclude, -e`: Exclude types matching pattern (can be specified multiple times)
+- `--no-color`: Disable colored output
+- `--verbose, -v`: Enable verbose output
 - `--help, -h`: Show help information
 
 ## Project Structure

Taskfile.yml

@@ -8,7 +8,7 @@ vars:
   PROJECT: src/DotNetApiDiff/DotNetApiDiff.csproj
   TEST_PROJECT: tests/DotNetApiDiff.Tests/DotNetApiDiff.Tests.csproj
   COVERAGE_DIR: coverage-report
-  REPORT_DIR: reports
+  TEST_REPORT_DIR: test-report
 
 tasks:
   default:
@@ -52,6 +52,41 @@ tasks:
     cmds:
       - dotnet test {{.TEST_PROJECT}} --filter "Category=Integration" --configuration Release
 
+  test:report:
+    desc: Run tests with detailed HTML report
+    cmds:
+      - mkdir -p {{.TEST_REPORT_DIR}}
+      - dotnet test {{.TEST_PROJECT}} --results-directory {{.TEST_REPORT_DIR}} --logger "html;LogFileName=test-results.html"
+      - echo "Test report generated in {{.TEST_REPORT_DIR}}/test-results.html"
+
+  ensure-test-report:
+    desc: Ensure test report exists
+    internal: true
+    cmds:
+      - |
+        if [ ! -f "{{.TEST_REPORT_DIR}}/test-results.html" ]; then
+          echo "Test report not found. Generating it now..."
+          task test:report
+        fi
+
+  test:report:view:
+    desc: Open test report in default browser (generates report if it doesn't exist)
+    cmds:
+      - task: ensure-test-report
+      - |
+        {{if eq OS "windows"}}
+        cmd.exe /c start {{.TEST_REPORT_DIR}}/test-results.html
+        {{else if eq OS "darwin"}}
+        open {{.TEST_REPORT_DIR}}/test-results.html
+        {{else}}
+        xdg-open {{.TEST_REPORT_DIR}}/test-results.html
+        {{end}}
+
+  test:watch:
+    desc: Run tests in watch mode (rerun on file changes)
+    cmds:
+      - dotnet watch test --project {{.TEST_PROJECT}}
+
   coverage:
     desc: Generate code coverage report
     cmds:
@@ -65,9 +100,28 @@ tasks:
       - dotnet tool restore
       - dotnet reportgenerator -reports:tests/DotNetApiDiff.Tests/coverage.info -targetdir:{{.COVERAGE_DIR}} -reporttypes:Html
 
+  coverage:report:detailed:
+    desc: Generate detailed HTML report with multiple formats
+    cmds:
+      - dotnet tool restore
+      - dotnet reportgenerator -reports:tests/DotNetApiDiff.Tests/coverage.info -targetdir:{{.COVERAGE_DIR}} -reporttypes:"Html;HtmlSummary;Cobertura;TextSummary"
+      - echo "Coverage report generated in {{.COVERAGE_DIR}}"
+      - cat {{.COVERAGE_DIR}}/Summary.txt
+
+  ensure-coverage-report:
+    desc: Ensure coverage report exists
+    internal: true
+    cmds:
+      - |
+        if [ ! -f "{{.COVERAGE_DIR}}/index.html" ]; then
+          echo "Coverage report not found. Generating it now..."
+          task coverage
+        fi
+
   coverage:view:
-    desc: Open coverage report in default browser
+    desc: Open coverage report in default browser (generates report if it doesn't exist)
     cmds:
+      - task: ensure-coverage-report
       - |
         {{if eq OS "windows"}}
         cmd.exe /c start {{.COVERAGE_DIR}}/index.html

src/DotNetApiDiff/Commands/CompareCommand.cs

@@ -16,13 +16,13 @@ namespace DotNetApiDiff.Commands;
 /// </summary>
 public class CompareCommandSettings : CommandSettings
 {
-    [CommandArgument(0, "<oldAssembly>")]
-    [Description("Path to the old/baseline assembly")]
-    public required string OldAssemblyPath { get; init; }
+    [CommandArgument(0, "<sourceAssembly>")]
+    [Description("Path to the source/baseline assembly")]
+    public required string SourceAssemblyPath { get; init; }
 
-    [CommandArgument(1, "<newAssembly>")]
-    [Description("Path to the new/current assembly")]
-    public required string NewAssemblyPath { get; init; }
+    [CommandArgument(1, "<targetAssembly>")]
+    [Description("Path to the target/current assembly")]
+    public required string TargetAssemblyPath { get; init; }
 
     [CommandOption("-c|--config <configFile>")]
     [Description("Path to configuration file")]
@@ -76,16 +76,16 @@ public CompareCommand(IServiceProvider serviceProvider)
     /// <returns>ValidationResult indicating success or failure</returns>
     public override ValidationResult Validate([NotNull] CommandContext context, [NotNull] CompareCommandSettings settings)
     {
-        // Validate old assembly path
-        if (!File.Exists(settings.OldAssemblyPath))
+        // Validate source assembly path
+        if (!File.Exists(settings.SourceAssemblyPath))
         {
-            return ValidationResult.Error($"Old assembly file not found: {settings.OldAssemblyPath}");
+            return ValidationResult.Error($"Source assembly file not found: {settings.SourceAssemblyPath}");
         }
 
-        // Validate new assembly path
-        if (!File.Exists(settings.NewAssemblyPath))
+        // Validate target assembly path
+        if (!File.Exists(settings.TargetAssemblyPath))
         {
-            return ValidationResult.Error($"New assembly file not found: {settings.NewAssemblyPath}");
+            return ValidationResult.Error($"Target assembly file not found: {settings.TargetAssemblyPath}");
         }
 
         // Validate config file if specified
@@ -152,23 +152,23 @@ public override int Execute([NotNull] CommandContext context, [NotNull] CompareC
             }
 
             // Load assemblies
-            logger.LogInformation("Loading old assembly: {Path}", settings.OldAssemblyPath);
-            logger.LogInformation("Loading new assembly: {Path}", settings.NewAssemblyPath);
+            logger.LogInformation("Loading source assembly: {Path}", settings.SourceAssemblyPath);
+            logger.LogInformation("Loading target assembly: {Path}", settings.TargetAssemblyPath);
 
             var assemblyLoader = _serviceProvider.GetRequiredService<IAssemblyLoader>();
-            var oldAssembly = assemblyLoader.LoadAssembly(settings.OldAssemblyPath);
-            var newAssembly = assemblyLoader.LoadAssembly(settings.NewAssemblyPath);
+            var sourceAssembly = assemblyLoader.LoadAssembly(settings.SourceAssemblyPath);
+            var targetAssembly = assemblyLoader.LoadAssembly(settings.TargetAssemblyPath);
 
             // Extract API information
             logger.LogInformation("Extracting API information from assemblies");
             var apiExtractor = _serviceProvider.GetRequiredService<IApiExtractor>();
-            var oldApi = apiExtractor.ExtractApiMembers(oldAssembly);
-            var newApi = apiExtractor.ExtractApiMembers(newAssembly);
+            var sourceApi = apiExtractor.ExtractApiMembers(sourceAssembly);
+            var targetApi = apiExtractor.ExtractApiMembers(targetAssembly);
 
             // Compare APIs
             logger.LogInformation("Comparing APIs");
             var apiComparer = _serviceProvider.GetRequiredService<IApiComparer>();
-            var comparisonResult = apiComparer.CompareAssemblies(oldAssembly, newAssembly);
+            var comparisonResult = apiComparer.CompareAssemblies(sourceAssembly, targetAssembly);
 
             // Create ApiComparison from ComparisonResult
             var comparison = new Models.ApiComparison

src/DotNetApiDiff/DotNetApiDiff.csproj

@@ -12,6 +12,8 @@
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.1" />
         <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.1" />
         <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.1" />
+        <PackageReference Include="Spectre.Console" Version="0.48.0" />
+        <PackageReference Include="Spectre.Console.Cli" Version="0.48.0" />
         <PackageReference Include="System.Reflection.Metadata" Version="8.0.1" />
     </ItemGroup>
 

src/DotNetApiDiff/Program.cs

@@ -37,9 +37,9 @@ public static int Main(string[] args)
             {
                 config.SetApplicationName("dotnet-api-diff");
 
-                config.AddExample(new[] { "compare", "old.dll", "new.dll" });
-                config.AddExample(new[] { "compare", "old.dll", "new.dll", "--output", "json" });
-                config.AddExample(new[] { "compare", "old.dll", "new.dll", "--config", "config.json" });
+                config.AddExample(new[] { "compare", "source.dll", "target.dll" });
+                config.AddExample(new[] { "compare", "source.dll", "target.dll", "--output", "json" });
+                config.AddExample(new[] { "compare", "source.dll", "target.dll", "--config", "config.json" });
 
                 config.SetExceptionHandler(ex =>
                 {
@@ -50,9 +50,9 @@ public static int Main(string[] args)
                 // Register the compare command
                 config.AddCommand<CompareCommand>("compare")
                     .WithDescription("Compare two .NET assemblies and report API differences")
-                    .WithExample(new[] { "compare", "old.dll", "new.dll" })
-                    .WithExample(new[] { "compare", "old.dll", "new.dll", "--output", "json" })
-                    .WithExample(new[] { "compare", "old.dll", "new.dll", "--filter", "System.Collections" });
+                    .WithExample(new[] { "compare", "source.dll", "target.dll" })
+                    .WithExample(new[] { "compare", "source.dll", "target.dll", "--output", "json" })
+                    .WithExample(new[] { "compare", "source.dll", "target.dll", "--filter", "System.Collections" });
             });
 
             return app.Run(args);