Fix HTML report configuration section rendering

jbrinkman · jbrinkman · commit 0816bbc813ba · 2025-07-30T10:00:21.000-04:00
- Fixed Scriban template parameter indexing (/bin/zsh is template name, use / for data) - Added Dictionary to object array conversion for template compatibility - Updated all configuration template includes to use correct parameter positions - Enhanced configuration data preparation with proper object structure conversion - Added ComparisonConfiguration to ComparisonResult for template access - Removed debug code and cleaned up for production readiness Fixes #31: Configuration sections now display properly with correct labels and data
diff --git a/src/DotNetApiDiff/ApiExtraction/ApiComparer.cs b/src/DotNetApiDiff/ApiExtraction/ApiComparer.cs
@@ -2,6 +2,7 @@
 using System.Reflection;
 using DotNetApiDiff.Interfaces;
 using DotNetApiDiff.Models;
+using DotNetApiDiff.Models.Configuration;
 using Microsoft.Extensions.Logging;
 
 namespace DotNetApiDiff.ApiExtraction;
@@ -15,6 +16,7 @@ public class ApiComparer : IApiComparer
     private readonly IDifferenceCalculator _differenceCalculator;
     private readonly INameMapper _nameMapper;
     private readonly IChangeClassifier _changeClassifier;
+    private readonly ComparisonConfiguration _configuration;
     private readonly ILogger<ApiComparer> _logger;
 
     /// <summary>
@@ -24,18 +26,21 @@ public class ApiComparer : IApiComparer
     /// <param name="differenceCalculator">Calculator for detailed change analysis</param>
     /// <param name="nameMapper">Mapper for namespace and type name transformations</param>
     /// <param name="changeClassifier">Classifier for breaking changes and exclusions</param>
+    /// <param name="configuration">Configuration used for the comparison</param>
     /// <param name="logger">Logger for diagnostic information</param>
     public ApiComparer(
         IApiExtractor apiExtractor,
         IDifferenceCalculator differenceCalculator,
         INameMapper nameMapper,
         IChangeClassifier changeClassifier,
+        ComparisonConfiguration configuration,
         ILogger<ApiComparer> logger)
     {
         _apiExtractor = apiExtractor ?? throw new ArgumentNullException(nameof(apiExtractor));
         _differenceCalculator = differenceCalculator ?? throw new ArgumentNullException(nameof(differenceCalculator));
         _nameMapper = nameMapper ?? throw new ArgumentNullException(nameof(nameMapper));
         _changeClassifier = changeClassifier ?? throw new ArgumentNullException(nameof(changeClassifier));
+        _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
         _logger = logger ?? throw new ArgumentNullException(nameof(logger));
     }
 
@@ -66,7 +71,8 @@ public ComparisonResult CompareAssemblies(Assembly oldAssembly, Assembly newAsse
         {
             OldAssemblyPath = oldAssembly.Location,
             NewAssemblyPath = newAssembly.Location,
-            ComparisonTimestamp = DateTime.UtcNow
+            ComparisonTimestamp = DateTime.UtcNow,
+            Configuration = _configuration
         };
 
         try
diff --git a/src/DotNetApiDiff/Commands/CompareCommand.cs b/src/DotNetApiDiff/Commands/CompareCommand.cs
@@ -275,7 +275,14 @@ public override int Execute([NotNull] CommandContext context, [NotNull] CompareC
                         loggerFactory.CreateLogger<ApiExtraction.ChangeClassifier>()));
 
                 // Add the main comparison service that depends on configured services
-                commandServices.AddScoped<IApiComparer, ApiExtraction.ApiComparer>();
+                commandServices.AddScoped<IApiComparer>(provider =>
+                    new ApiExtraction.ApiComparer(
+                        provider.GetRequiredService<IApiExtractor>(),
+                        provider.GetRequiredService<IDifferenceCalculator>(),
+                        provider.GetRequiredService<INameMapper>(),
+                        provider.GetRequiredService<IChangeClassifier>(),
+                        config,
+                        provider.GetRequiredService<ILogger<ApiExtraction.ApiComparer>>()));
 
                 // Execute the command with the configured services
                 using (var commandProvider = commandServices.BuildServiceProvider())
diff --git a/src/DotNetApiDiff/DotNetApiDiff.csproj b/src/DotNetApiDiff/DotNetApiDiff.csproj
@@ -21,7 +21,7 @@
         <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" />
-        <PackageReference Include="Scriban" Version="5.9.0" />
+        <PackageReference Include="Scriban" Version="6.2.1" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/DotNetApiDiff/Reporting/HtmlFormatterScriban.cs b/src/DotNetApiDiff/Reporting/HtmlFormatterScriban.cs
@@ -4,6 +4,7 @@
 using DotNetApiDiff.Models.Configuration;
 using Scriban;
 using Scriban.Runtime;
+using System.Linq;
 
 namespace DotNetApiDiff.Reporting;
 
@@ -65,49 +66,57 @@ public string Format(ComparisonResult result)
 
     private object PrepareConfigData(ComparisonConfiguration config)
     {
+        var namespaceMappings = config?.Mappings?.NamespaceMappings ?? new Dictionary<string, List<string>>();
+
+        // Convert Dictionary to array of objects with key/value properties for Scriban
+        var namespaceMappingsArray = namespaceMappings.Select(kvp => new { key = kvp.Key, value = kvp.Value }).ToList();
+        var typeMappingsArray = (config?.Mappings?.TypeMappings ?? new Dictionary<string, string>()).Select(kvp => new { key = kvp.Key, value = kvp.Value }).ToList();
+
+        var mappingsResult = new
+        {
+            namespace_mappings = namespaceMappingsArray,
+            type_mappings = typeMappingsArray,
+            auto_map_same_name_types = config?.Mappings?.AutoMapSameNameTypes ?? false,
+            ignore_case = config?.Mappings?.IgnoreCase ?? false
+        };
+
         return new
         {
             filters = new
             {
-                include_internals = config.Filters.IncludeInternals,
-                include_compiler_generated = config.Filters.IncludeCompilerGenerated,
-                include_namespaces = config.Filters.IncludeNamespaces?.ToList() ?? new List<string>(),
-                exclude_namespaces = config.Filters.ExcludeNamespaces?.ToList() ?? new List<string>(),
-                include_types = config.Filters.IncludeTypes?.ToList() ?? new List<string>(),
-                exclude_types = config.Filters.ExcludeTypes?.ToList() ?? new List<string>()
-            },
-            mappings = new
-            {
-                namespace_mappings = config.Mappings.NamespaceMappings ?? new Dictionary<string, List<string>>(),
-                type_mappings = config.Mappings.TypeMappings ?? new Dictionary<string, string>(),
-                auto_map_same_name_types = config.Mappings.AutoMapSameNameTypes,
-                ignore_case = config.Mappings.IgnoreCase
+                include_internals = config?.Filters?.IncludeInternals ?? false,
+                include_compiler_generated = config?.Filters?.IncludeCompilerGenerated ?? false,
+                include_namespaces = config?.Filters?.IncludeNamespaces?.ToList() ?? new List<string>(),
+                exclude_namespaces = config?.Filters?.ExcludeNamespaces?.ToList() ?? new List<string>(),
+                include_types = config?.Filters?.IncludeTypes?.ToList() ?? new List<string>(),
+                exclude_types = config?.Filters?.ExcludeTypes?.ToList() ?? new List<string>()
             },
+            mappings = mappingsResult,
             exclusions = new
             {
-                excluded_types = config.Exclusions.ExcludedTypes?.ToList() ?? new List<string>(),
-                excluded_members = config.Exclusions.ExcludedMembers?.ToList() ?? new List<string>(),
-                excluded_type_patterns = config.Exclusions.ExcludedTypePatterns?.ToList() ?? new List<string>(),
-                excluded_member_patterns = config.Exclusions.ExcludedMemberPatterns?.ToList() ?? new List<string>(),
-                exclude_compiler_generated = config.Exclusions.ExcludeCompilerGenerated,
-                exclude_obsolete = config.Exclusions.ExcludeObsolete
+                excluded_types = config?.Exclusions?.ExcludedTypes?.ToList() ?? new List<string>(),
+                excluded_members = config?.Exclusions?.ExcludedMembers?.ToList() ?? new List<string>(),
+                excluded_type_patterns = config?.Exclusions?.ExcludedTypePatterns?.ToList() ?? new List<string>(),
+                excluded_member_patterns = config?.Exclusions?.ExcludedMemberPatterns?.ToList() ?? new List<string>(),
+                exclude_compiler_generated = config?.Exclusions?.ExcludeCompilerGenerated ?? false,
+                exclude_obsolete = config?.Exclusions?.ExcludeObsolete ?? false
             },
             breaking_change_rules = new
             {
-                treat_type_removal_as_breaking = config.BreakingChangeRules.TreatTypeRemovalAsBreaking,
-                treat_member_removal_as_breaking = config.BreakingChangeRules.TreatMemberRemovalAsBreaking,
-                treat_signature_change_as_breaking = config.BreakingChangeRules.TreatSignatureChangeAsBreaking,
-                treat_reduced_accessibility_as_breaking = config.BreakingChangeRules.TreatReducedAccessibilityAsBreaking,
-                treat_added_type_as_breaking = config.BreakingChangeRules.TreatAddedTypeAsBreaking,
-                treat_added_member_as_breaking = config.BreakingChangeRules.TreatAddedMemberAsBreaking,
-                treat_added_interface_as_breaking = config.BreakingChangeRules.TreatAddedInterfaceAsBreaking,
-                treat_removed_interface_as_breaking = config.BreakingChangeRules.TreatRemovedInterfaceAsBreaking,
-                treat_parameter_name_change_as_breaking = config.BreakingChangeRules.TreatParameterNameChangeAsBreaking,
-                treat_added_optional_parameter_as_breaking = config.BreakingChangeRules.TreatAddedOptionalParameterAsBreaking
+                treat_type_removal_as_breaking = config?.BreakingChangeRules?.TreatTypeRemovalAsBreaking ?? true,
+                treat_member_removal_as_breaking = config?.BreakingChangeRules?.TreatMemberRemovalAsBreaking ?? true,
+                treat_signature_change_as_breaking = config?.BreakingChangeRules?.TreatSignatureChangeAsBreaking ?? true,
+                treat_reduced_accessibility_as_breaking = config?.BreakingChangeRules?.TreatReducedAccessibilityAsBreaking ?? true,
+                treat_added_type_as_breaking = config?.BreakingChangeRules?.TreatAddedTypeAsBreaking ?? false,
+                treat_added_member_as_breaking = config?.BreakingChangeRules?.TreatAddedMemberAsBreaking ?? false,
+                treat_added_interface_as_breaking = config?.BreakingChangeRules?.TreatAddedInterfaceAsBreaking ?? true,
+                treat_removed_interface_as_breaking = config?.BreakingChangeRules?.TreatRemovedInterfaceAsBreaking ?? true,
+                treat_parameter_name_change_as_breaking = config?.BreakingChangeRules?.TreatParameterNameChangeAsBreaking ?? false,
+                treat_added_optional_parameter_as_breaking = config?.BreakingChangeRules?.TreatAddedOptionalParameterAsBreaking ?? false
             },
-            output_format = config.OutputFormat.ToString(),
-            output_path = config.OutputPath ?? string.Empty,
-            fail_on_breaking_changes = config.FailOnBreakingChanges
+            output_format = config?.OutputFormat.ToString() ?? "Console",
+            output_path = config?.OutputPath ?? string.Empty,
+            fail_on_breaking_changes = config?.FailOnBreakingChanges ?? false
         };
     }
 
diff --git a/src/DotNetApiDiff/Reporting/HtmlTemplates/config-mappings.scriban b/src/DotNetApiDiff/Reporting/HtmlTemplates/config-mappings.scriban
@@ -1,8 +1,8 @@
 <div class="config-item">
-    <span class="config-label">{{ label }}:</span>
-    {{if mappings && mappings.size > 0}}
+    <span class="config-label">{{ $2 }}:</span>
+    {{if $1 && $1.size > 0}}
     <div class="config-mappings">
-        {{for mapping in mappings}}
+        {{for mapping in $1}}
         <div class="config-mapping">
             <span class="mapping-from">{{ mapping.key }}</span>
             <span class="mapping-arrow">→</span>
diff --git a/src/DotNetApiDiff/Reporting/HtmlTemplates/config-namespace-mappings.scriban b/src/DotNetApiDiff/Reporting/HtmlTemplates/config-namespace-mappings.scriban
@@ -1,8 +1,8 @@
 <div class="config-item">
-    <span class="config-label">{{ label }}:</span>
-    {{if mappings && mappings.size > 0}}
+    <span class="config-label">{{ $2 }}:</span>
+    {{if $1 && $1.size > 0}}
     <div class="config-mappings">
-        {{for mapping in mappings}}
+        {{for mapping in $1}}
         <div class="config-mapping">
             <span class="mapping-from">{{ mapping.key }}</span>
             <span class="mapping-arrow">→</span>
diff --git a/src/DotNetApiDiff/Reporting/HtmlTemplates/config-string-list.scriban b/src/DotNetApiDiff/Reporting/HtmlTemplates/config-string-list.scriban
@@ -1,8 +1,8 @@
 <div class="config-item">
-    <span class="config-label">{{ label }}:</span>
-    {{if items && items.size > 0}}
+    <span class="config-label">{{ $2 }}:</span>
+    {{if $1 && $1.size > 0}}
     <div class="config-list">
-        {{for item in items}}
+        {{for item in $1}}
         <span class="config-list-item">{{ item }}</span>
         {{end}}
     </div>
diff --git a/src/DotNetApiDiff/Reporting/HtmlTemplates/main-layout.scriban b/src/DotNetApiDiff/Reporting/HtmlTemplates/main-layout.scriban
@@ -85,7 +85,7 @@
                 </button>
             </div>
             <div id="config-details" class="config-details" style="display: none;">
-                {{ include "configuration" result.configuration }}
+                {{ include "configuration" }}
             </div>
         </section>
 
diff --git a/tests/DotNetApiDiff.Tests/ApiExtraction/ApiComparerTests.cs b/tests/DotNetApiDiff.Tests/ApiExtraction/ApiComparerTests.cs
@@ -3,6 +3,7 @@
 using DotNetApiDiff.ApiExtraction;
 using DotNetApiDiff.Interfaces;
 using DotNetApiDiff.Models;
+using DotNetApiDiff.Models.Configuration;
 using Microsoft.Extensions.Logging;
 using Moq;
 using Xunit;
@@ -35,6 +36,7 @@ public ApiComparerTests()
             _mockDifferenceCalculator.Object,
             _mockNameMapper.Object,
             _mockChangeClassifier.Object,
+            ComparisonConfiguration.CreateDefault(),
             _mockLogger.Object);
     }
 
diff --git a/tests/DotNetApiDiff.Tests/ApiExtraction/ApiComparerWithMappingTests.cs b/tests/DotNetApiDiff.Tests/ApiExtraction/ApiComparerWithMappingTests.cs
@@ -157,6 +157,7 @@ public void CompareTypes_WithNoMapping_FindsDifferences()
                 _differenceCalculatorMock.Object,
                 nameMapper,
                 _changeClassifierMock.Object,
+                ComparisonConfiguration.CreateDefault(),
                 _loggerMock.Object);
 
             var addedDifference = new ApiDifference { ChangeType = ChangeType.Added };
