add ability to define custom templates

Author: tm1000

.gitignore

@@ -98,4 +98,6 @@ Thumbs.db
 __tests__/runner/*
 lib/**/*
 
-.build-dev.npm
+.build-dev.npm
+code-coverage-results.md
+dist/artifacts

Makefile

@@ -15,8 +15,15 @@ lint-fix: .build-dev.npm
 
 act: act-schedule act-push
 
-act-%: /usr/bin/gh /usr/local/bin/act build
-	@act -s GITHUB_TOKEN="$(shell gh auth token)" --artifact-server-path /tmp/artifacts $(*)
+act-pull_request: /usr/bin/gh /usr/local/bin/act /usr/bin/glow build
+	@act --bind -e __tests__/pull-request.json -s GITHUB_TOKEN="$(shell gh auth token)" --artifact-server-path /tmp/artifacts pull_request
+	@glow code-coverage-results.md
+	@rm -Rf code-coverage-results.md
+
+act-%: /usr/bin/gh /usr/local/bin/act /usr/bin/glow build
+	@act --bind -s GITHUB_TOKEN="$(shell gh auth token)" --artifact-server-path /tmp/artifacts $(*)
+	@glow code-coverage-results.md
+	@rm -Rf code-coverage-results.md
 
 /usr/bin/gh:
 	@echo "gh is not installed. Please install it from https://cli.github.com/"
@@ -26,6 +33,10 @@ act-%: /usr/bin/gh /usr/local/bin/act build
 	@echo "act is not installed. Please install it from https://github.com/nektos/act"
 	@exit 1
 
+/usr/bin/glow:
+	@echo "glow is not installed. Please install it from https://github.com/charmbracelet/glow"
+	@exit 1
+
 .build-dev.npm: package-lock.json package.json node_modules
 	@npm update
 	@touch $@

__tests__/utils.test.ts

@@ -129,6 +129,9 @@ test('getInputs', () => {
     artifactDownloadWorkflowNames: null,
     artifactName: 'coverage-%name%',
     negativeDifferenceBy: 'package',
-    retention: undefined
+    retention: undefined,
+    //This is a cheat
+    withBaseCoverageTemplate: f.withBaseCoverageTemplate,
+    withoutBaseCoverageTemplate: f.withoutBaseCoverageTemplate
   })
 })

action.yml

@@ -54,6 +54,13 @@ inputs:
   retention_days:
     description: 'The number of days to retain uploaded artifacts. When `undefined` (default), the default retention period for the repository is used.'
     required: false
+  without_base_coverage_template:
+    description: 'Path to custom template without base coverage'
+    required: false
+  with_base_coverage_template:
+    description: 'Path to custom template with base coverage'
+    required: false
+
 
 outputs:
   file:

dist/index.js

@@ -1,8 +1,8 @@
 {
   "name": "code-coverage-report-action",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "",
-  "main": "lib/main.js",
+  "main": "dist/index.js",
   "private": true,
   "scripts": {
     "format": "prettier --write 'src/**/*.ts'",
@@ -12,9 +12,7 @@
     "package": "ncc build src/main.ts --source-map --license licenses.txt",
     "watch": "ncc build src/main.ts --watch",
     "test": "jest",
-    "all": "npm run format && npm run lint && npm run package && npm test",
-    "act": "act --artifact-server-path /tmp/artifacts -s GITHUB_TOKEN --env GITHUB_STEP_SUMMARY=/dev/stdout",
-    "act:pr": "act pull_request --artifact-server-path /tmp/artifacts -s GITHUB_TOKEN --env GITHUB_STEP_SUMMARY=/dev/stdout -e __tests__/pull-request.json"
+    "all": "npm run format && npm run lint && npm run package && npm test"
   },
   "repository": {
     "type": "git",
@@ -32,7 +30,8 @@
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
     "adm-zip": "^0.5.10",
-    "fast-xml-parser": "^4.3.2"
+    "fast-xml-parser": "^4.3.2",
+    "handlebars": "^4.7.8"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.2",

dist/index.js.map

@@ -24,8 +24,25 @@ export interface Inputs {
   artifactName: string
   negativeDifferenceBy: string
   retention: number | undefined
+  withBaseCoverageTemplate: string
+  withoutBaseCoverageTemplate: string
 }
 
 export interface Files {
   [key: string]: CoverageFile
 }
+
+export interface HandlebarContextCoverage {
+  package: string
+  base_coverage: string
+  new_coverage?: string
+  difference?: string
+}
+
+export interface HandlebarContext {
+  coverage_badge?: string
+  minimum_allowed_coverage?: string
+  new_coverage?: string
+  coverage: HandlebarContextCoverage[]
+  overall_coverage: HandlebarContextCoverage
+}

dist/licenses.txt

@@ -8,9 +8,15 @@ import {
   roundPercentage,
   uploadArtifacts
 } from './utils'
-import {Coverage} from './interfaces'
+import {
+  Coverage,
+  HandlebarContext,
+  HandlebarContextCoverage
+} from './interfaces'
 import {writeFile} from 'fs/promises'
 import path from 'path'
+import * as handlebars from 'handlebars'
+import {readFile} from 'node:fs/promises'
 
 async function run(): Promise<void> {
   try {
@@ -108,61 +114,10 @@ async function generateMarkdown(
     fileCoverageWarningMax,
     badge,
     markdownFilename,
-    negativeDifferenceBy
+    negativeDifferenceBy,
+    withBaseCoverageTemplate,
+    withoutBaseCoverageTemplate
   } = getInputs()
-
-  const baseMap = Object.entries(headCoverage.files).map(([hash, file]) => {
-    if (baseCoverage === null) {
-      return [
-        file.relative,
-        `${colorizePercentageByThreshold(
-          file.coverage,
-          fileCoverageWarningMax,
-          fileCoverageErrorMin
-        )}`
-      ]
-    }
-
-    const baseCoveragePercentage = baseCoverage.files[hash]
-      ? baseCoverage.files[hash].coverage
-      : 0
-
-    const differencePercentage = baseCoveragePercentage
-      ? roundPercentage(file.coverage - baseCoveragePercentage)
-      : roundPercentage(file.coverage)
-
-    if (
-      failOnNegativeDifference &&
-      negativeDifferenceBy === 'package' &&
-      differencePercentage !== null &&
-      differencePercentage < 0
-    ) {
-      core.setFailed(
-        `${headCoverage.files[hash].relative} coverage difference was ${differencePercentage}%`
-      )
-    }
-
-    return [
-      file.relative,
-      `${colorizePercentageByThreshold(
-        baseCoveragePercentage,
-        fileCoverageWarningMax,
-        fileCoverageErrorMin
-      )}`,
-      `${colorizePercentageByThreshold(
-        file.coverage,
-        fileCoverageWarningMax,
-        fileCoverageErrorMin
-      )}`,
-      colorizePercentageByThreshold(differencePercentage)
-    ]
-  })
-
-  const map = baseMap.sort((a, b) => (a[0] < b[0] ? -1 : a[0] > b[0] ? 1 : 0))
-
-  // Add a "summary row" showing changes in overall overage.
-  map.push(await addOverallRow(headCoverage, baseCoverage))
-
   const overallDifferencePercentage = baseCoverage
     ? roundPercentage(headCoverage.coverage - baseCoverage.coverage)
     : null
@@ -201,36 +156,84 @@ async function generateMarkdown(
     color = 'green'
   }
 
-  const summary = core.summary.addHeading('Code Coverage Report')
-
-  const headers =
+  const templatePath =
     baseCoverage === null
-      ? [
-          {data: 'Package', header: true},
-          {data: 'Coverage', header: true}
-        ]
-      : [
-          {data: 'Package', header: true},
-          {data: 'Base Coverage', header: true},
-          {data: 'New Coverage', header: true},
-          {data: 'Difference', header: true}
-        ]
+      ? withoutBaseCoverageTemplate
+      : withBaseCoverageTemplate
+
+  if (!(await checkFileExists(templatePath))) {
+    core.setFailed(`Unable to access template ${templatePath}`)
+    return
+  }
+
+  const contents = await readFile(templatePath, {
+    encoding: 'utf8'
+  })
+  const compiledTemplate = handlebars.compile(contents)
+
+  const context: HandlebarContext = {
+    minimum_allowed_coverage: `${overallCoverageFailThreshold}%`,
+    new_coverage: `${headCoverage.coverage}%`,
+    coverage: Object.entries(headCoverage.files)
+      .map(([hash, file]) => {
+        if (baseCoverage === null) {
+          return {
+            package: file.relative,
+            base_coverage: `${colorizePercentageByThreshold(
+              file.coverage,
+              fileCoverageWarningMax,
+              fileCoverageErrorMin
+            )}`
+          }
+        }
+
+        const baseCoveragePercentage = baseCoverage.files[hash]
+          ? baseCoverage.files[hash].coverage
+          : 0
+
+        const differencePercentage = baseCoveragePercentage
+          ? roundPercentage(file.coverage - baseCoveragePercentage)
+          : roundPercentage(file.coverage)
+
+        if (
+          failOnNegativeDifference &&
+          negativeDifferenceBy === 'package' &&
+          differencePercentage !== null &&
+          differencePercentage < 0
+        ) {
+          core.setFailed(
+            `${headCoverage.files[hash].relative} coverage difference was ${differencePercentage}%`
+          )
+        }
+
+        return {
+          package: file.relative,
+          base_coverage: `${colorizePercentageByThreshold(
+            baseCoveragePercentage,
+            fileCoverageWarningMax,
+            fileCoverageErrorMin
+          )}`,
+          new_coverage: `${colorizePercentageByThreshold(
+            file.coverage,
+            fileCoverageWarningMax,
+            fileCoverageErrorMin
+          )}`,
+          difference: colorizePercentageByThreshold(differencePercentage)
+        }
+      })
+      .sort((a, b) =>
+        a.package < b.package ? -1 : a.package > b.package ? 1 : 0
+      ),
+    overall_coverage: addOverallRow(headCoverage, baseCoverage)
+  }
 
   if (badge) {
-    summary.addImage(
-      `https://img.shields.io/badge/${encodeURIComponent(
-        `Code Coverage-${headCoverage.coverage}%-${color}`
-      )}?style=for-the-badge`,
-      'Code Coverage'
-    )
+    context.coverage_badge = `https://img.shields.io/badge/Code Coverage-${headCoverage.coverage}%-${color}?style=for-the-badge`
   }
 
-  summary
-    .addTable([headers, ...map])
-    .addBreak()
-    .addRaw(
-      `<i>Minimum allowed coverage is</i> <code>${overallCoverageFailThreshold}%</code>, this run produced</i> <code>${headCoverage.coverage}%</code>`
-    )
+  const markdown = compiledTemplate(context)
+
+  const summary = core.summary.addRaw(markdown)
 
   //If this is run after write the buffer is empty
   core.info(`Writing results to ${markdownFilename}.md`)
@@ -245,41 +248,41 @@ async function generateMarkdown(
 /**
  * Generate overall coverage row
  */
-async function addOverallRow(
+function addOverallRow(
   headCoverage: Coverage,
   baseCoverage: Coverage | null = null
-): Promise<string[]> {
+): HandlebarContextCoverage {
   const {overallCoverageFailThreshold} = getInputs()
 
   const overallDifferencePercentage = baseCoverage
     ? roundPercentage(headCoverage.coverage - baseCoverage.coverage)
     : null
 
   if (baseCoverage === null) {
-    return [
-      'Overall Coverage',
-      `${colorizePercentageByThreshold(
+    return {
+      package: 'Overall Coverage',
+      base_coverage: `${colorizePercentageByThreshold(
         headCoverage.coverage,
         0,
         overallCoverageFailThreshold
       )}`
-    ]
+    }
   }
 
-  return [
-    '<b>Overall Coverage</b>',
-    `<b>${colorizePercentageByThreshold(
+  return {
+    package: 'Overall Coverage',
+    base_coverage: `${colorizePercentageByThreshold(
       baseCoverage.coverage,
       0,
       overallCoverageFailThreshold
-    )}</b>`,
-    `<b>${colorizePercentageByThreshold(
+    )}`,
+    new_coverage: `${colorizePercentageByThreshold(
       headCoverage.coverage,
       0,
       overallCoverageFailThreshold
-    )}</b>`,
-    `<b>${colorizePercentageByThreshold(overallDifferencePercentage)}</b>`
-  ]
+    )}`,
+    difference: `${colorizePercentageByThreshold(overallDifferencePercentage)}`
+  }
 }
 
 run()

dist/with-base-coverage.hbs

@@ -366,6 +366,13 @@ export function getInputs(): Inputs {
       ? tempArtifactDownloadWorkflowNames.split(',').map(n => n.trim())
       : null
 
+  const withoutBaseCoverageTemplate =
+    core.getInput('without_base_coverage_template') ||
+    `${__dirname}/../templates/without-base-coverage.hbs`
+  const withBaseCoverageTemplate =
+    core.getInput('with_base_coverage_template') ||
+    `${__dirname}/../templates/with-base-coverage.hbs`
+
   inputs = {
     token,
     filename,
@@ -378,7 +385,9 @@ export function getInputs(): Inputs {
     artifactDownloadWorkflowNames,
     artifactName,
     negativeDifferenceBy,
-    retention: retentionDays
+    retention: retentionDays,
+    withoutBaseCoverageTemplate,
+    withBaseCoverageTemplate
   }
 
   return inputs

dist/without-base-coverage.hbs

@@ -0,0 +1,16 @@
+# Code Coverage Report
+
+{{#if coverage_badge}}
+![Code Coverage]({{coverage_badge}})
+
+{{/if}}
+| Package | Base Coverage | New Coverage | Difference |
+| ------- | ------------- | ------------ | ---------- |
+{{#each coverage}}
+| {{package}} | {{base_coverage}} | {{new_coverage}} | {{difference}} |
+{{/each}}
+{{#with overall_coverage}}
+| **{{package}}** | **{{base_coverage}}** | **{{new_coverage}}** | **{{difference}}** |
+{{/with}}
+
+_Minimum allowed coverage is_ `{{minimum_allowed_coverage}}`_, this run produced_ `{{new_coverage}}`

package-lock.json

@@ -0,0 +1,16 @@
+# Code Coverage Report
+
+{{#if coverage_badge}}
+![Code Coverage]({{coverage_badge}})
+
+{{/if}}
+| Package |    Coverage   |
+| ------- | ------------- |
+{{#each coverage}}
+| {{package}} | {{base_coverage}} |
+{{/each}}
+{{#with overall_coverage}}
+| **{{package}}** | **{{base_coverage}}** |
+{{/with}}
+
+_Minimum allowed coverage is_ `{{minimum_allowed_coverage}}`_, this run produced_ `{{new_coverage}}`