@reporters/github 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (2022-12-19)
+
+Initial release

package/README.md

@@ -0,0 +1,27 @@
+# Github Actions Reporter
+A Github actions reporter for `node:test`
+
+## Installation
+
+```bash
+npm install --save-dev @reporters/github
+```
+or
+```bash
+yarn add --dev @reporters/github
+```
+
+## Usage
+
+```bash
+node --test \
+  --test-reporter=@reporters/github --test-reporter-destination=stdout \
+  --test-reporter=spec --test-reporter-destination=stdout
+```
+
+## Features
+
+### annotations
+
+### summary
+

package/index.js

@@ -0,0 +1,88 @@
+const path = require('node:path');
+const util = require('node:util');
+const { EOL } = require('node:os');
+const StackUtils = require('stack-utils');
+
+const WORKSPACE = process.env.GITHUB_WORKSPACE ?? '';
+
+const stack = new StackUtils({ cwd: WORKSPACE, internals: StackUtils.nodeInternals() });
+
+const isFile = (name) => name?.startsWith(WORKSPACE);
+
+const getCurrentFile = (name) => (isFile(name) ? path.relative(WORKSPACE, name) : null);
+
+const parseStack = (error, file) => {
+  const stackLines = (error?.stack ?? '').split(/\r?\n/);
+  const line = stackLines.find((l) => l.includes(file)) ?? stackLines[0];
+  return line ? stack.parseLine(line) : null;
+};
+
+const escapeData = (s = '') => s
+  .replace(/%/g, '%25')
+  .replace(/\r/g, '%0D')
+  .replace(/\n/g, '%0A');
+
+const escapeProperty = (s = '') => escapeData(s)
+  .replace(/:/g, '%3A')
+  .replace(/,/g, '%2C');
+
+const propsToString = (props = {}) => {
+  const entries = Object.entries(props);
+  if (entries.length === 0) {
+    return '';
+  }
+
+  const result = entries
+    .filter(([, value]) => Boolean(value))
+    .map(([key, value]) => `${key}=${escapeProperty(String(value))}`).join(',');
+
+  return ` ${result}`;
+};
+
+const report = (command, message, pros) => process.stdout.write(`::${command}${propsToString(pros)}::${escapeData(message)}${EOL}`);
+
+module.exports = async function githubReporter(source) {
+  const counter = { pass: 0, fail: 0 };
+  const diagnostics = [];
+  let currentFile = null;
+  for await (const event of source) {
+    switch (event.type) {
+      case 'test:start':
+        currentFile = getCurrentFile(event.data.name) || currentFile;
+        report('debug', `starting to run ${event.data.name}`);
+        break;
+      case 'test:pass':
+        counter.pass += 1;
+        report('debug', `completed running ${event.data.name}`);
+        currentFile = isFile(event.data.name) ? null : currentFile;
+        break;
+      case 'test:fail': {
+        const error = util.inspect(
+          event.data.details?.error,
+          { colors: false, breakLength: Infinity },
+        );
+        const location = parseStack(event.data.details?.error, currentFile);
+        report('error', error, {
+          file: location?.file ?? currentFile,
+          line: location?.line,
+          col: location?.column,
+          title: event.data.name,
+        });
+        counter.fail += 1;
+        currentFile = isFile(event.data.name) ? null : currentFile;
+        break;
+      } case 'test:diagnostic':
+        if (currentFile) {
+          report('notice', event.data.message, { file: currentFile });
+        } else {
+          diagnostics.push(event.data.message);
+        }
+        break;
+      default:
+        break;
+    }
+  }
+  report('group', `Test results (${counter.pass} passed, ${counter.fail} failed)`);
+  report('notice', diagnostics.join(EOL));
+  report('endgroup');
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@reporters/github",
+  "version": "1.0.0",
+  "description": "A junit reporter for `node:test`",
+  "keywords": [
+    "github actions",
+    "node:test",
+    "test",
+    "reporter",
+    "reporters"
+  ],
+  "dependencies": {
+    "stack-utils": "^2.0.6"
+  },
+  "main": "index.js",
+  "repository": "https://github.com/MoLow/reporters.git",
+  "author": "Moshe Atlow",
+  "license": "MIT"
+}