Merge pull request #367 from timostroehlein/main

Improve comment generation and update docs

Author: dkhunt27

.gitignore

@@ -98,4 +98,7 @@ Thumbs.db
 __tests__/runner/*
 lib/**/*
 
-!__tests__/**/coverage
+!__tests__/**/coverage
+
+# Jetbrains IDE files
+.idea

README.md

@@ -87,12 +87,12 @@ The report is based on the coverage report generated by your test runner.
   
 ```yaml
       - name: Comment Code Coverage on PR
-        uses: dkhunt27/nx-code-coverage@v2
+        uses: dkhunt27/action-nx-code-coverage@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           no-coverage-ran: false
-          coverage-folder: ./coverage
-          coverage-base-folder: ./coverage-base
+          coverage-folder: coverage
+          coverage-base-folder: coverage-base
           gist-processing: true
           gist-token: ${{ secrets.COVERAGE_BADGES_GIST_TOKEN }}
           gist-id: d7e6b443a01eba615fd2a7c1215aec91

__tests__/__snapshots__/comment.test.ts.snap

@@ -1,27 +1,27 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when all results in one then return as expected 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app diff -</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table> <br/><table><tbody><tr><th>app diff +</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table> <br/><table><tbody><tr><th>app diff null</th><th>unknown%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when all results in one then return as expected 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app diff -</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr><tr><th>app diff +</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr><tr><th>app diff null</th><th>unknown%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result coverage is undefined then unknown diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>unknown%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result coverage is undefined then unknown diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>unknown%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is 0 then no code coverage comment 1`] = `"Code Coverage:<p></p>"`;
+exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is 0 then no code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is negative then negative diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is negative then negative diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is positive then positive diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when hiding unchanged when result diff is positive then positive diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when all results in one then return as expected 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app diff 0</th><th>50.00%</th><th>✅  0.00%</th></tr></tbody></table> <br/><table><tbody><tr><th>app diff -</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table> <br/><table><tbody><tr><th>app diff +</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table> <br/><table><tbody><tr><th>app diff null</th><th>unknown%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when all results in one then return as expected 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app diff 0</th><th>50.00%</th><th>✅  0.00%</th></tr><tr><th>app diff -</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr><tr><th>app diff +</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr><tr><th>app diff null</th><th>unknown%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result coverage is undefined then unknown diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>unknown%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result coverage is undefined then unknown diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>unknown%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is 0 then 0 diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅  0.00%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is 0 then 0 diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅  0.00%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is negative then negative diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is negative then negative diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table>"`;
 
-exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is positive then positive diff in code coverage comment 1`] = `"Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table> <br/>"`;
+exports[`comment tests buildComment when hiding coverage reports when not hiding unchanged when result diff is positive then positive diff in code coverage comment 1`] = `"<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th><th>✅ ▴ +25.00%</th></tr></tbody></table>"`;
 
 exports[`comment tests buildComment when not hiding coverage reports when all results in one then return as expected 1`] = `
-"Code Coverage:<p></p><table><tbody><tr><th>app diff 0</th><th>50.00%</th><th>✅  0.00%</th></tr></tbody></table> 
+"<h2>Code Coverage</h2><table><tbody><tr><th>app diff 0</th><th>50.00%</th><th>✅  0.00%</th></tr></tbody></table> 
 
  <details><summary>Coverage Report</summary><table><tbody><tr><th>File                                </th><th> % Stmts </th><th> % Branch </th><th> % Funcs </th><th> % Lines </th><th> Uncovered Line #s </th></tr><tr><td>All&nbsp;files                           </td><td>&nbsp;  96.42 </td><td>&nbsp;      60 </td><td>&nbsp;  96.66 </td><td>&nbsp;  96.59 </td><td>&nbsp;                  </td></tr></tbody></table></details> <br/><table><tbody><tr><th>app diff -</th><th>50.00%</th><th>❌ ▾ -25.00%</th></tr></tbody></table> 
 

__tests__/comment.test.ts

@@ -19,7 +19,7 @@ describe('comment tests', () => {
         hideUnchanged
       }
       const actual = buildComment(input)
-      expect(actual).toStrictEqual('Code Coverage:<p></p>')
+      expect(actual).toStrictEqual('<h2>Code Coverage</h2>')
     })
     test('when result base/diff null then no diff in code coverage comment', async () => {
       const input: BuildCommentInputs = {
@@ -37,7 +37,7 @@ describe('comment tests', () => {
       }
       const actual = buildComment(input)
       expect(actual).toContain(
-        'Code Coverage:<p></p><table><tbody><tr><th>app A</th><th>50.00%</th></tr></tbody></table>'
+        '<h2>Code Coverage</h2><table><tbody><tr><th>app A</th><th>50.00%</th></tr></tbody></table>'
       )
     })
 

dist/index.js

@@ -13,63 +13,76 @@ export const buildComment = ({
   hideCoverageReports,
   hideUnchanged
 }: BuildCommentInputs): string => {
-  const html = results.map(result => {
-    let plus = ''
-    let arrow = ''
-    let diffHtml = ''
+  const rows = results
+    .map(result => {
+      let plus = ''
+      let arrow = ''
+      let diffHtml = ''
 
-    // when no tests, not sure if output is undefined or 'Unknown'; TODO: add test case
-    if (
-      result.diff !== undefined &&
-      result.diff !== null &&
-      (result.diff as unknown) !== 'Unknown'
-    ) {
-      if (result.diff < 0) {
-        arrow = '▾'
-      } else if (result.diff > 0) {
-        plus = '+'
-        arrow = '▴'
-      }
+      // when no tests, not sure if output is undefined or 'Unknown'; TODO: add test case
+      if (
+        result.diff !== undefined &&
+        result.diff !== null &&
+        (result.diff as unknown) !== 'Unknown'
+      ) {
+        if (result.diff < 0) {
+          arrow = '▾'
+        } else if (result.diff > 0) {
+          plus = '+'
+          arrow = '▴'
+        }
 
-      diffHtml = th(
-        renderEmoji(result.diff),
-        ' ',
-        arrow,
-        ' ',
-        plus,
-        result.diff.toFixed(2),
-        '%'
-      )
-    }
+        diffHtml = th(
+          renderEmoji(result.diff),
+          ' ',
+          arrow,
+          ' ',
+          plus,
+          result.diff.toFixed(2),
+          '%'
+        )
+      }
 
-    // when no tests, not sure if is undefined or 'Unknown'; TODO: add test case
-    let coverage
-    if (
-      result.coverage === undefined ||
-      result.coverage === null ||
-      (result.coverage as unknown) === 'Unknown'
-    ) {
-      coverage = 'unknown'
-    } else {
-      coverage = result.coverage.toFixed(2)
-    }
+      // when no tests, not sure if is undefined or 'Unknown'; TODO: add test case
+      let coverage
+      if (
+        result.coverage === undefined ||
+        result.coverage === null ||
+        (result.coverage as unknown) === 'Unknown'
+      ) {
+        coverage = 'unknown'
+      } else {
+        coverage = result.coverage.toFixed(2)
+      }
 
-    if (result.diff === 0 && hideUnchanged) {
-      return ''
-    } else {
-      if (hideCoverageReports) {
-        return `${table(
-          tbody(tr(th(result.app), th(coverage, '%'), diffHtml))
-        )} <br/>`
+      if (result.diff === 0 && hideUnchanged) {
+        return {
+          row: '',
+          htmlResults: ''
+        }
       } else {
         const htmlResults = tabulate(result.details)
-        return `${table(
-          tbody(tr(th(result.app), th(coverage, '%'), diffHtml))
-        )} \n\n ${details(summary('Coverage Report'), htmlResults)} <br/>`
+        return {
+          row: tr(
+            th(result.app.replace(/^\/+/g, '')),
+            th(coverage, '%'),
+            diffHtml
+          ),
+          htmlResults
+        }
       }
-    }
-  })
+    })
+    .filter(row => row.row !== '')
+
+  const tableHtml = hideCoverageReports
+    ? table(tbody(rows.map(row => row.row).join('')))
+    : rows
+        .map(
+          row =>
+            `${table(tbody(row.row))} \n\n ${details(summary('Coverage Report'), row.htmlResults)} <br/>`
+        )
+        .join('')
 
-  const title = `Code Coverage:<p></p>`
-  return fragment(title, html.join(''))
+  const title = `<h2>Code Coverage</h2>`
+  return fragment(title, tableHtml)
 }

dist/index.js.map

@@ -76,7 +76,10 @@ export const mergeFileLists = ({
     const found = baseSummaryFileList.find(item => item.app === summary.app)
     if (found) {
       base = buildMergeItem(found)
-      baseCoveragePct = base.parsedTotal.statements.pct
+      baseCoveragePct =
+        base.parsedTotal.statements.pct.toString() === 'Unknown'
+          ? 0
+          : base.parsedTotal.statements.pct
 
       // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/EPSILON
       // use Number.EPSILON so rounding of 0.0005 is correct