@reporters/github 1.13.0 → 2.0.0

package/gh_core.js

@@ -1,18 +1,37 @@
-'use strict';
+import { EOL } from 'node:os';
 
-// From Github Core SDK code
-// eslint-disable-next-line import/no-unresolved
-const coreUtils = require('@actions/core/lib/utils');
-const { EOL } = require('node:os');
+function toCommandValue(input) {
+  if (input === null || input === undefined) {
+    return '';
+  }
+  if (typeof input === 'string' || input instanceof String) {
+    return input;
+  }
+  return JSON.stringify(input);
+}
+
+export function toCommandProperties(annotationProperties) {
+  if (!Object.keys(annotationProperties).length) {
+    return {};
+  }
+  return {
+    title: annotationProperties.title,
+    file: annotationProperties.file,
+    line: annotationProperties.startLine,
+    endLine: annotationProperties.endLine,
+    col: annotationProperties.startColumn,
+    endColumn: annotationProperties.endColumn,
+  };
+}
 
 function escapeData(s) {
-  return coreUtils.toCommandValue(s)
+  return toCommandValue(s)
     .replace(/%/g, '%25')
     .replace(/\r/g, '%0D')
     .replace(/\n/g, '%0A');
 }
 function escapeProperty(s) {
-  return coreUtils.toCommandValue(s)
+  return toCommandValue(s)
     .replace(/%/g, '%25')
     .replace(/\r/g, '%0D')
     .replace(/\n/g, '%0A')
@@ -21,7 +40,7 @@ function escapeProperty(s) {
 }
 
 const CMD_STRING = '::';
-class Command {
+export class Command {
   constructor(command, properties, message, options = { EOL }) {
     this.command = command ?? 'missing.command';
     this.properties = properties;
@@ -54,8 +73,3 @@ class Command {
     return cmdStr;
   }
 }
-
-module.exports = {
-  toCommandProperties: coreUtils.toCommandProperties,
-  Command,
-};

package/index.js

@@ -1,12 +1,10 @@
-'use strict';
-
-const path = require('node:path');
-const { fileURLToPath } = require('node:url');
-const util = require('node:util');
-const { EOL } = require('node:os');
-const core = require('@actions/core');
-const StackUtils = require('stack-utils');
-const { Command, toCommandProperties } = require('./gh_core');
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import util from 'node:util';
+import { EOL } from 'node:os';
+import { summary } from '@actions/core';
+import StackUtils from 'stack-utils';
+import { Command, toCommandProperties } from './gh_core.js';
 
 const WORKSPACE = process.env.GITHUB_WORKSPACE ?? '';
 
@@ -44,7 +42,7 @@ const DIAGNOSTIC_KEYS = {
   duration_ms: 'Duration 🕐',
 };
 
-const DIAGNOSTIC_VALUES = {
+export const DIAGNOSTIC_VALUES = {
   duration_ms: (value) => `${Number(value).toFixed(3)}ms`,
 };
 
@@ -66,14 +64,14 @@ function extractLocation(data) {
 const counter = { pass: 0, fail: 0 };
 const diagnostics = [];
 
-function isTopLevelDiagnostic(data) {
+export function isTopLevelDiagnostic(data) {
   return (data.file === undefined
           || data.line === undefined
           || data.column === undefined
           || (data.line === 1 && data.column === 1));
 }
 
-function transformEvent(event) {
+export function transformEvent(event) {
   switch (event.type) {
     case 'test:start':
       return new Command('debug', {}, `starting to run ${event.data.name}`).toString();
@@ -82,9 +80,7 @@ function transformEvent(event) {
       return new Command('debug', {}, `completed running ${event.data.name}`).toString();
     case 'test:fail': {
       const error = event.data.details?.error;
-      if (error?.code === 'ERR_TEST_FAILURE' && error?.failureType === 'subtestsFailed') {
-        // This means the failed subtests are already reported
-        // no need to re-annotate the file itself
+      if (!error || (error.code === 'ERR_TEST_FAILURE' && error.failureType === 'subtestsFailed')) {
         break;
       }
       const err = error.code === 'ERR_TEST_FAILURE' ? error.cause : error;
@@ -127,7 +123,7 @@ function transformEvent(event) {
   return '';
 }
 
-async function getSummary() {
+export async function getSummary() {
   const formattedDiagnostics = diagnostics.map((d) => {
     const [key, ...rest] = d.split(' ');
     const value = rest.join(' ');
@@ -142,7 +138,7 @@ async function getSummary() {
   res += new Command('endgroup').toString();
 
   if (process.env.GITHUB_STEP_SUMMARY) {
-    await core.summary
+    await summary
       .addHeading('Test Results')
       .addTable(formattedDiagnostics)
       .write();
@@ -150,7 +146,7 @@ async function getSummary() {
   return res;
 }
 
-module.exports = async function* githubReporter(source) {
+export default async function* githubReporter(source) {
   if (!process.env.GITHUB_ACTIONS) {
     // eslint-disable-next-line no-unused-vars
     for await (const _ of source);
@@ -160,9 +156,4 @@ module.exports = async function* githubReporter(source) {
     yield transformEvent(event);
   }
   yield await getSummary();
-};
-
-module.exports.transformEvent = transformEvent;
-module.exports.getSummary = getSummary;
-module.exports.isTopLevelDiagnostic = isTopLevelDiagnostic;
-module.exports.DIAGNOSTIC_VALUES = DIAGNOSTIC_VALUES;
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@reporters/github",
-  "version": "1.13.0",
+  "version": "2.0.0",
   "description": "A github actions reporter for `node:test`",
-  "type": "commonjs",
+  "type": "module",
   "keywords": [
     "github actions",
     "node:test",
@@ -11,7 +11,7 @@
     "reporters"
   ],
   "dependencies": {
-    "@actions/core": "^2.0.3",
+    "@actions/core": "^3.0.1",
     "stack-utils": "^2.0.6"
   },
   "files": [
@@ -25,6 +25,10 @@
     "url": "https://github.com/MoLow/reporters/issues"
   },
   "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./gh_core": "./gh_core.js"
+  },
   "homepage": "https://github.com/MoLow/reporters/tree/main/packages/github",
   "repository": "https://github.com/MoLow/reporters.git",
   "author": "Moshe Atlow",