implement md reporter

Signed-off-by: Matteo Collina <hello@matteocollina.com>

Author: mcollina

.github/workflows/ci.yml

@@ -19,10 +19,10 @@ jobs:
         node-version: [18.x, 20.x, 21.x]
         os: [ubuntu-latest, windows-latest]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -36,8 +36,8 @@ jobs:
 
       - name: Run tests
         run: |
-          npm run unit -- --reporter spec --reporter tap:report.tap
+          npm run unit -- --reporter spec --reporter md:report.md
 
-      - uses: pcolby/tap-summary@v1
-        with:
-          path: report.tap
+      - name: Upload report
+        run: |
+          echo report.md >> "$GITHUB_OUTPUT"

borp.js

@@ -8,15 +8,15 @@ import { finished } from 'node:stream/promises'
 import { join, relative } from 'node:path'
 import posix from 'node:path/posix'
 import runWithTypeScript from './lib/run.js'
+import { MarkdownReporter } from './lib/reporter.js'
 import { Report } from 'c8'
 import os from 'node:os'
 import { execa } from 'execa'
 
-const reporters = {
-  ...Reporters,
-  /* eslint new-cap: "off" */
-  spec: new Reporters.spec()
-}
+process.on('unhandledRejection', (err) => {
+  console.error(err)
+  process.exit(1)
+})
 
 const args = parseArgs({
   args: process.argv.slice(2),
@@ -87,6 +87,14 @@ const config = {
 
 try {
   const pipes = []
+
+  const reporters = {
+    ...Reporters,
+    md: new MarkdownReporter(config),
+    /* eslint new-cap: "off" */
+    spec: new Reporters.spec()
+  }
+
   for (const input of args.values.reporter) {
     const [name, dest] = input.split(':')
     const reporter = reporters[name]

lib/reporter.js

@@ -0,0 +1,75 @@
+import { Transform } from 'node:stream'
+import { fileURLToPath } from 'node:url'
+
+function normalizeFile (file, cwd) {
+  let res = file
+  if (file.startsWith('file://')) {
+    res = fileURLToPath(new URL(file))
+  }
+  res = res.replace(cwd, '')
+  if (res.startsWith('/')) {
+    res = res.slice(1)
+  }
+  return res
+}
+
+function eventToLine (event) {
+  return `* __${event.data.name}__, duration ${event.data.details.duration_ms}ms, line ${event.data.line} \n`
+}
+
+export class MarkdownReporter extends Transform {
+  constructor ({ cwd }) {
+    super({
+      objectMode: true
+    })
+
+    this._files = {}
+    this._cwd = cwd
+  }
+
+  getFile (path) {
+    const file = this._files[path] || {
+      pass: [],
+      fail: []
+    }
+    this._files[path] = file
+    return file
+  }
+
+  _transform (event, encoding, callback) {
+    if (!event.data.file) {
+      callback()
+      return
+    }
+
+    const path = normalizeFile(event.data.file, this._cwd)
+    const file = this.getFile(path)
+    switch (event.type) {
+      case 'test:pass':
+        file.pass.push(event)
+        break
+      case 'test:fail':
+        file.fail.push(event)
+        break
+    }
+
+    callback()
+  }
+
+  _flush (callback) {
+    this.push('# Summary\n')
+    for (const [path, file] of Object.entries(this._files)) {
+      this.push(`# ${path}\n`)
+      this.push('## Pass\n')
+      for (const event of file.pass) {
+        this.push(eventToLine(event))
+      }
+      this.push('## Fail\n')
+      for (const event of file.fail) {
+        this.push(eventToLine(event))
+      }
+    }
+    this.push(null)
+    callback()
+  }
+}