feat: implement ReportGenerator and console output formatter #12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add IReportFormatter interface for output formatting - Implement ReportGenerator class with support for multiple formats - Create ConsoleFormatter with colored output for additions, removals, modifications - Add summary statistics and breaking change indicators - Include unit tests for console output formatting - Supports ReportFormat.Console with fallback handling for unsupported formats Addresses Requirements: 4.4, 8.1, 8.4
Update Exception to Exception? in ReportGeneratorTests to match the expected nullability signature for ILogger.Log method.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements a comprehensive reporting infrastructure with console output formatting, adding the core components needed for generating and displaying API comparison reports. The implementation provides a multi-format architecture with colored console output and extensive test coverage.
- Core
ReportGeneratorclass with pluggable formatter support and fallback handling ConsoleFormatterwith colored output using Spectre.Console for different change types- Comprehensive unit tests covering various scenarios and edge cases
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/DotNetApiDiff/Interfaces/IReportFormatter.cs |
Defines the interface contract for output formatters |
src/DotNetApiDiff/Reporting/ReportGenerator.cs |
Main report generation logic with multi-format support and file I/O |
src/DotNetApiDiff/Reporting/ConsoleFormatter.cs |
Console-specific formatting with colored output and detailed change visualization |
src/DotNetApiDiff/Program.cs |
Service registration for dependency injection |
tests/DotNetApiDiff.Tests/Reporting/ReportGeneratorTests.cs |
Unit tests for report generator functionality |
tests/DotNetApiDiff.Tests/Reporting/ConsoleFormatterTests.cs |
Comprehensive tests for console formatter output |
jbrinkman
force-pushed
the
feature/task-6.1-report-generator
branch
from
116d041 to
166fcb2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Task 6.1: Create ReportGenerator and console output formatter
This PR implements the core reporting infrastructure with console output formatting:
Changes Made
IReportFormatterinterface for output formattingReportGeneratorclass with support for multiple formatsConsoleFormatterwith colored output for additions, removals, modificationsReportFormat.Consolewith fallback handling for unsupported formatsKey Features
Requirements Addressed
Testing
This establishes the foundation for additional formatters (JSON, Markdown) in subsequent tasks.