Skip to content

HTML Report: Configuration section incomplete - missing filter, exclusion and mapping values #31

@jbrinkman

Description

@jbrinkman

Problem Description

The HTML report's configuration section does not display all of the configuration values that are being used during the comparison. Important filter, exclusion, and mapping settings are missing from the report output.

Expected Behavior

The HTML report should display a complete configuration section showing:

Filters

  • includeNamespaces
  • excludeNamespaces
  • includeTypes
  • excludeTypes
  • includeInternals
  • includeCompilerGenerated

Mappings

  • namespaceMappings
  • typeMappings
  • autoMapSameNameTypes
  • ignoreCase

Exclusions

  • excludedTypes
  • excludedMembers
  • excludedTypePatterns
  • excludedMemberPatterns

Breaking Change Rules

  • treatTypeRemovalAsBreaking
  • treatMemberRemovalAsBreaking
  • treatAddedTypeAsBreaking
  • treatAddedMemberAsBreaking
  • treatSignatureChangeAsBreaking

Current Behavior

The configuration section in the HTML report is incomplete and doesn't show many of the configuration values that affect the comparison results.

Impact

  • Users cannot verify what configuration was used for a particular comparison
  • Difficult to reproduce results or understand why certain items were included/excluded
  • Reduces transparency and auditability of the comparison process

Steps to Reproduce

  1. Create a configuration file with various filter, exclusion, and mapping settings
  2. Run a comparison with --output html --config <config-file>
  3. Open the generated HTML report
  4. Observe that the configuration section is incomplete

Acceptance Criteria

  • HTML report displays complete filter configuration
  • HTML report displays complete mapping configuration
  • HTML report displays complete exclusion configuration
  • HTML report displays complete breaking change rules
  • Configuration values are clearly labeled and formatted
  • Empty/default values are handled appropriately

Related Files

  • src/DotNetApiDiff/Reporting/HtmlFormatter.cs
  • Template files for HTML report generation

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions