Skip to content

Commit 7a7263c

Browse files
jatgargJatin Garg
andauthored
Modify comment syntax for code coverage (#22752)
## Description Modify comment for code coverage. Add the line coverage summary to the summary. Co-authored-by: Jatin Garg <[email protected]>
1 parent 83f8851 commit 7a7263c

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

build-tools/packages/build-cli/src/codeCoverage/getCommentForCodeCoverage.ts

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,13 @@ const getCodeCoverageSummary = (
7171
codeCoverageComparisonReport: CodeCoverageComparison[],
7272
): string => {
7373
const summary = codeCoverageComparisonReport
74-
.sort((report1, report2) => report1.branchCoverageDiff - report2.branchCoverageDiff)
74+
.sort(
75+
(report1, report2) =>
76+
// Sort the diff summary of packages based on the total coverage diff(line coverage + branch coverage)
77+
report1.branchCoverageDiff +
78+
report1.lineCoverageDiff -
79+
(report2.branchCoverageDiff + report2.lineCoverageDiff),
80+
)
7581
.map((coverageReport) => getCodeCoverageSummaryForPackages(coverageReport))
7682
.reduce((prev, current) => prev + current);
7783

@@ -81,21 +87,23 @@ const getCodeCoverageSummary = (
8187
const getCodeCoverageSummaryForPackages = (coverageReport: CodeCoverageComparison): string => {
8288
const metrics = codeCoverageDetailsHeader + getMetricRows(coverageReport);
8389

84-
return `<details><summary><b>${getColorGlyph(coverageReport.branchCoverageDiff)} ${
90+
return `<details><summary><b>${getColorGlyph(coverageReport.branchCoverageDiff + coverageReport.lineCoverageDiff)} ${
8591
coverageReport.packagePath
86-
}:</b> ${formatDiff(coverageReport.branchCoverageDiff)}</summary>${metrics}</table></details>`;
92+
}:</b> <br> Line Coverage Change: ${formatDiff(coverageReport.lineCoverageDiff)} Branch Coverage Change: ${formatDiff(
93+
coverageReport.branchCoverageDiff,
94+
)}</summary>${metrics}</table></details>`;
8795
};
8896

89-
const getColorGlyph = (codeCoverageBranchDiff: number): string => {
90-
if (codeCoverageBranchDiff === 0) {
91-
return '<span style="color: green">■</span>';
97+
const getColorGlyph = (codeCoverageDiff: number): string => {
98+
if (codeCoverageDiff === 0) {
99+
return "■";
92100
}
93101

94-
if (codeCoverageBranchDiff > 0) {
95-
return '<span style="color: green">⯅</span>';
102+
if (codeCoverageDiff > 0) {
103+
return "⯅";
96104
}
97105

98-
return '<span style="color: red">⯆</span>';
106+
return "⯅⯅";
99107
};
100108

101109
const formatDiff = (coverageDiff: number): string => {
@@ -114,14 +122,14 @@ const getMetricRows = (codeCoverageComparisonReport: CodeCoverageComparison): st
114122
return (
115123
`<tr>
116124
<td>Branch Coverage</td>
117-
<td>${formatDiff(codeCoverageComparisonReport.branchCoverageInBaseline)}</td>
118-
<td>${formatDiff(codeCoverageComparisonReport.branchCoverageInPr)}</td>
125+
<td>${codeCoverageComparisonReport.branchCoverageInBaseline.toFixed(2)}%</td>
126+
<td>${codeCoverageComparisonReport.branchCoverageInPr.toFixed(2)}%</td>
119127
<td>${glyphForBranchCoverage} ${formatDiff(codeCoverageComparisonReport.branchCoverageDiff)}</td>
120128
</tr>` +
121129
`<tr>
122130
<td>Line Coverage</td>
123-
<td>${formatDiff(codeCoverageComparisonReport.lineCoverageInBaseline)}</td>
124-
<td>${formatDiff(codeCoverageComparisonReport.lineCoverageInPr)}</td>
131+
<td>${codeCoverageComparisonReport.lineCoverageInBaseline.toFixed(2)}%</td>
132+
<td>${codeCoverageComparisonReport.lineCoverageInPr.toFixed(2)}%</td>
125133
<td>${glyphForLineCoverage} ${formatDiff(codeCoverageComparisonReport.lineCoverageDiff)}</td>
126134
</tr>`
127135
);

0 commit comments

Comments
 (0)