Wrap table summary headers into a helper function

jgillick · Jan 6, 2023 · b0fffc2 · b0fffc2
1 parent 27b9198
commit b0fffc2
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 18 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -27040,6 +27040,7 @@ function getTemplateVars(report, failureMessage, inputs) {
         commitSha,
         commitUrl,
         prIdentifier: PR_COMMENT_IDENTIFIER,
+        renderFileSummaryTableHeader: renderFileSummaryTableHeader,
         renderFileSummaryTableRow: renderFileSummaryFactory(inputs),
     };
     const { stripPathPrefix } = inputs;
@@ -27167,6 +27168,15 @@ function createSummary(output, failed, inputs) {
     });
 }
 exports.createSummary = createSummary;
+/**
+ * Create the markdown file table headers
+ */
+function renderFileSummaryTableHeader() {
+    return [
+        "| | Name | Stmts | Branch | Funcs | Lines |",
+        "| ---- | ---- | ----- | ------ | ----- | ----- |",
+    ].join("\n");
+}
 /**
  * Create the markdown for a filepath row
  */

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/summary.md b/dist/summary.md
@@ -15,10 +15,10 @@ Commit: <%= commitSha %>
 <% } %>
 
 <!-- Summary -->
+
 Summary
 
-| Name | Stmts | Branch | Funcs | Lines |
-| ---- | ----- | ------ | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= renderFileSummaryTableRow(total) %>
 
 <!-- All files, if diffs aren't present -->
@@ -30,8 +30,7 @@ Summary
 All files
 </summary>
 
-| Name | Stmts | Branch | Funcs | Lines |  |
-| ---- | ----- | ------ | ----- | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= all.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 
 </details>
@@ -43,8 +42,7 @@ All files
 
 Changed files
 
-| Name | Stmts | Branch | Funcs | Lines |  |
-| ---- | ----- | ------ | ----- | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= changed.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 <% } %>
 
@@ -57,8 +55,7 @@ Changed files
 Unchanged files
 </summary>
 
-| Name | Stmts | Branch | Funcs | Lines |
-| ---- | ----- | ------ | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= unchanged.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 
 </details>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "test-coverage-reporter",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Generate a test coverage report for a PR",
   "main": "dist/index.js",
   "scripts": {

diff --git a/src/output.ts b/src/output.ts
@@ -83,6 +83,7 @@ export function getTemplateVars(
     commitUrl,
     prIdentifier: PR_COMMENT_IDENTIFIER,
 
+    renderFileSummaryTableHeader: renderFileSummaryTableHeader,
     renderFileSummaryTableRow: renderFileSummaryFactory(inputs),
   };
   const { stripPathPrefix } = inputs;
@@ -230,6 +231,16 @@ export function createSummary(output: string, failed: boolean, inputs: Inputs) {
   });
 }
 
+/**
+ * Create the markdown file table headers
+ */
+function renderFileSummaryTableHeader() {
+  return [
+    "| | Name | Stmts | Branch | Funcs | Lines |",
+    "| ---- | ---- | ----- | ------ | ----- | ----- |",
+  ].join("\n");
+}
+
 /**
  * Create the markdown for a filepath row
  */

diff --git a/src/summary.md b/src/summary.md
@@ -15,10 +15,10 @@ Commit: <%= commitSha %>
 <% } %>
 
 <!-- Summary -->
+
 Summary
 
-| Name | Stmts | Branch | Funcs | Lines |
-| ---- | ----- | ------ | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= renderFileSummaryTableRow(total) %>
 
 <!-- All files, if diffs aren't present -->
@@ -30,8 +30,7 @@ Summary
 All files
 </summary>
 
-| Name | Stmts | Branch | Funcs | Lines |  |
-| ---- | ----- | ------ | ----- | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= all.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 
 </details>
@@ -43,8 +42,7 @@ All files
 
 Changed files
 
-| Name | Stmts | Branch | Funcs | Lines |  |
-| ---- | ----- | ------ | ----- | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= changed.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 <% } %>
 
@@ -57,8 +55,7 @@ Changed files
 Unchanged files
 </summary>
 
-| Name | Stmts | Branch | Funcs | Lines |
-| ---- | ----- | ------ | ----- | ----- |
+<%= renderFileSummaryTableHeader() %>
 <%= unchanged.map((fileSummary) => renderFileSummaryTableRow(fileSummary)).join('\n') %>
 
 </details>

diff --git a/src/types.ts b/src/types.ts
@@ -62,6 +62,7 @@ export type TemplateVars = {
   unchanged: TemplateDiffSummary[];
   all: TemplateDiffSummary[];
 
+  renderFileSummaryTableHeader: Function;
   renderFileSummaryTableRow: Function;
 };