🐲 Include comments and suppressed items in summary calculation
#40
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
Updated `HtmlReportGenerator` and `SummaryGenerator` to account for `comments` and `suppressed` items in summary totals. Enhanced styling with new classes and updated sample HTML report for clarity. Added tests to ensure accurate summary calculations.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Gradle plugin’s HTML reporting so the summary totals include comment and suppressed items (in addition to tech-debt items), and reflects those new summary categories in styling and the sample report.
Changes:
- Updated summary calculation to include
COMMENTandSUPPRESSitems in the total and as separate summary buckets. - Extended the summary header UI with “Comments” and “Suppressed” boxes and added corresponding CSS classes.
- Updated and added tests (and refreshed the sample HTML report) to reflect the new summary behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| techdebt-gradle-plugin/src/test/kotlin/com/escodro/techdebt/gradle/report/HtmlReportGeneratorTest.kt | Updates/adds tests for the new summary totals and labels. |
| techdebt-gradle-plugin/src/main/kotlin/com/escodro/techdebt/gradle/report/SummaryGenerator.kt | Adds “Comments” and “Suppressed” boxes/parameters to the summary header generator. |
| techdebt-gradle-plugin/src/main/kotlin/com/escodro/techdebt/gradle/report/ReportStyle.kt | Adds CSS styling for the new summary categories. |
| techdebt-gradle-plugin/src/main/kotlin/com/escodro/techdebt/gradle/report/HtmlReportGenerator.kt | Computes totals including comments/suppressed and passes new values into the summary generator. |
| samples/sample-jvm/assets/report.html | Updates sample output to reflect new summary categories and totals. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...-gradle-plugin/src/test/kotlin/com/escodro/techdebt/gradle/report/HtmlReportGeneratorTest.kt
Show resolved
Hide resolved
...-gradle-plugin/src/test/kotlin/com/escodro/techdebt/gradle/report/HtmlReportGeneratorTest.kt
Show resolved
Hide resolved
...-gradle-plugin/src/test/kotlin/com/escodro/techdebt/gradle/report/HtmlReportGeneratorTest.kt
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Updated
HtmlReportGeneratorandSummaryGeneratorto account forcommentsandsuppresseditems in summary totals. Enhanced styling with new classes and updated sample HTML report for clarity. Added tests to ensure accurate summary calculations.