Generate simple tap v14 output from jest test results

Author: mdouglass

.github/workflows/build.yaml

@@ -0,0 +1,30 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20, 21]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build

.github/workflows/publish.yaml

@@ -0,0 +1,26 @@
+# This script is automatically triggered when a tag corresponding to a new version is pushed
+# That will cause the build to be published to npm
+name: publish
+
+on:
+  push:
+    tags: [v*]
+
+permissions:
+  contents: read  # required for accessing repository contents
+    
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.7.0'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+      - run: npm ci --no-audit
+      - env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_READWRITE_TOKEN }}
+        run: npm publish

.github/workflows/release.yaml

@@ -0,0 +1,35 @@
+# Run this script manually to bump the version number and trigger a publish
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      level:
+        description: 'Increment the version by the specified level. Level can be one of: major, minor, patch'
+        required: true
+        default: 'minor'
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.7.0'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+      - run: npm version ${{ inputs.level }}
+      - name: git config
+        run: |
+          git config user.name 'Warwick ✠'
+          git config user.email warwick@globalworldwide.com
+      - run: git push origin --follow-tags

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 100,
+  "arrowParens": "always",
+  "trailingComma": "all"
+}

README.md

@@ -1,2 +1,2 @@
-# jest-tap-reporter
+# jest-reporter-tap
 Test Anything Protocol reporter for Jest

index.mjs

@@ -0,0 +1,114 @@
+import { createWriteStream } from 'node:fs';
+import path from 'node:path';
+import YAML from 'yaml';
+
+class TapWriter {
+  #stream;
+  #testCount = 0;
+
+  constructor(stream) {
+    this.#stream = stream;
+  }
+
+  version() {
+    this.#stream.write(`TAP version 14\n`);
+  }
+
+  testPoint(ok, description, directive, data) {
+    this.#stream.write(`${ok ? 'ok' : 'not ok'} ${++this.#testCount} - ${description}`);
+    if (directive) {
+      this.#stream.write(` # ${directive}`);
+    }
+    this.#stream.write('\n');
+    if (data) {
+      this.#stream.write('  ---\n');
+      for (const line of YAML.stringify(data).split('\n')) {
+        this.#stream.write(`  ${line}\n`);
+      }
+      this.#stream.write('  ...\n');
+    }
+  }
+
+  plan() {
+    this.#stream.write(`1..${this.#testCount}\n`);
+  }
+}
+
+function formatErrorMessage(error) {
+  // remove escape codes that jest is leaving in the error message
+  return error?.replaceAll(/\x1b\[\d+\w/g, '');
+}
+
+export default class TapReporter {
+  constructor(globalConfig, reporterOptions, reporterContext) {
+    this._globalConfig = globalConfig;
+    this._options = reporterOptions;
+    this._context = reporterContext;
+  }
+
+  onRunComplete(_testContexts, results) {
+    let stream = this._options.filePath
+      ? createWriteStream(this._options.filePath)
+      : process.stdout;
+    let writer = new TapWriter(stream);
+    writer.version();
+
+    for (const suiteResult of results.testResults) {
+      if (suiteResult.testExecError) {
+        // suite failed altogether, treat this as a failed single test
+        writer.testPoint(
+          false,
+          suiteResult.displayName ?? this.#relativePath(suiteResult.testFilePath),
+          undefined,
+          {
+            code: suiteResult.testExecError.code,
+            message: suiteResult.testExecError.message,
+            stack: suiteResult.testExecError.stack,
+            type: suiteResult.testExecError.type,
+          },
+        );
+      } else {
+        // suite passed, now iterate over individual tests
+        for (const testResult of suiteResult.testResults) {
+          switch (testResult.status) {
+            case 'passed':
+              writer.testPoint(true, testResult.fullName, undefined, undefined);
+              break;
+            case 'failed':
+              writer.testPoint(false, testResult.fullName, undefined, {
+                message: formatErrorMessage(testResult.failureMessages[0]) ?? 'Unknown failure',
+                more: testResult.failureMessages.slice(1).map(formatErrorMessage),
+              });
+              break;
+            case 'skipped':
+            case 'pending':
+              writer.testPoint(true, testResult.fullName, 'skip', undefined);
+              break;
+            case 'todo':
+              writer.testPoint(false, testResult.fullName, 'todo', undefined);
+              break;
+            default:
+              writer.testPoint(false, testResult.fullName, undefined, {
+                message: `Unknown status ${testResult.status}`,
+              });
+              break;
+          }
+        }
+      }
+    }
+
+    writer.plan();
+
+    if (stream !== process.stdout) {
+      stream.end();
+    }
+  }
+
+  getLastError() {
+    return undefined;
+  }
+
+  #relativePath(file) {
+    return path.relative(this._globalConfig.rootDir, file);
+  }
+}

package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "@globalworldwide/jest-reporter-tap",
+  "version": "0.0.1",
+  "description": "Test Anything Protocol reporter for Jest",
+  "type": "module",
+  "main": "index.mjs",
+  "scripts": {
+    "build": "echo \"no build specified\"",
+    "test": "echo \"no test specified\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/globalworldwide/jest-reporter-tap.git"
+  },
+  "keywords": [
+    "jest",
+    "tap",
+    "tap-v14",
+    "reporter"
+  ],
+  "author": "Matthew Douglass <matthew@globalworldwide.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/globalworldwide/jest-reporter-tap/issues"
+  },
+  "homepage": "https://github.com/globalworldwide/jest-reporter-tap#readme",
+  "dependencies": {
+    "yaml": "^2.4.0"
+  }
+}