@reporters/github 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.1.2](https://github.com/MoLow/reporters/compare/github-v1.1.1...github-v1.1.2) (2023-02-28)
+
+
+### Bug Fixes
+
+* **github:** remove redundant diagnostics ([b62df32](https://github.com/MoLow/reporters/commit/b62df3280b141af763386a68b0b4e386bef907e7))
+
+## [1.1.1](https://github.com/MoLow/reporters/compare/github-v1.1.0...github-v1.1.1) (2023-02-28)
+
+
+### Bug Fixes
+
+* **github:** silent if not running on github actions ([#33](https://github.com/MoLow/reporters/issues/33)) ([a480454](https://github.com/MoLow/reporters/commit/a480454ac7ca0471744ec00b69a6c67a1d3c8ada))
+
 ## [1.1.0](https://github.com/MoLow/reporters/compare/github-v1.0.2...github-v1.1.0) (2023-02-02)
 
 

package/index.js

@@ -33,6 +33,11 @@ const DIAGNOSTIC_VALUES = {
 };
 
 module.exports = async function githubReporter(source) {
+  if (!process.env.GITHUB_ACTIONS) {
+    // eslint-disable-next-line no-unused-vars
+    for await (const _ of source);
+    return;
+  }
   const counter = { pass: 0, fail: 0 };
   const diagnostics = [];
   for await (const event of source) {
@@ -59,9 +64,10 @@ module.exports = async function githubReporter(source) {
         counter.fail += 1;
         break;
       } case 'test:diagnostic':
-        core.notice(event.data.message, { file: getFilePath(event.data.file) });
         if (event.data.nesting === 0) {
           diagnostics.push(event.data.message);
+        } else {
+          core.notice(event.data.message, { file: getFilePath(event.data.file) });
         }
         break;
       default:
@@ -80,8 +86,10 @@ module.exports = async function githubReporter(source) {
   core.notice(formatedDiagnostics.map((d) => d.join(': ')).join(EOL));
   core.endGroup();
 
-  await core.summary
-    .addHeading('Test Results')
-    .addTable(formatedDiagnostics)
-    .write();
+  if (process.env.GITHUB_STEP_SUMMARY) {
+    await core.summary
+      .addHeading('Test Results')
+      .addTable(formatedDiagnostics)
+      .write();
+  }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reporters/github",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",
@@ -14,7 +14,7 @@
     "stack-utils": "^2.0.6"
   },
   "scripts": {
-    "test": "node --test-reporter=spec --test"
+    "test": "node --test-reporter=spec --test-reporter-destination=stdout  --test-reporter=./index.js --test-reporter-destination=stdout --test"
   },
   "bugs": {
     "url": "https://github.com/MoLow/reporters/issues"

package/tests/index.test.js

@@ -11,7 +11,7 @@ const GITHUB_STEP_SUMMARY = join(tmpdir(), 'github-actions-test-reporter');
 writeFileSync(GITHUB_STEP_SUMMARY, '');
 
 const child = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], {
-  env: { GITHUB_STEP_SUMMARY, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
+  env: { GITHUB_ACTIONS: true, GITHUB_STEP_SUMMARY, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
 });
 
 assert.strictEqual(child.stderr?.toString(), '');

package/tests/output.js

@@ -5,13 +5,6 @@ module.exports = {
 ::debug::starting to run fails
 ::error title=fails,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {%0A  failureType: 'testCodeFailure',%0A  cause: Error: this is an error%0A      at Object.<anonymous> (.*/example.js:6:11).*
 ::error title=tests,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
-::notice file=tests/example.js::tests 1
-::notice file=tests/example.js::pass 0
-::notice file=tests/example.js::fail 1
-::notice file=tests/example.js::cancelled 0
-::notice file=tests/example.js::skipped 0
-::notice file=tests/example.js::todo 0
-::notice file=tests/example.js::duration_ms .*
 ::group::Test results \\(1 passed, 2 failed\\)
 ::notice::Total Tests: 1%0APassed ✅: 0%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 0%0ATodo 📝: 0%0ADuration: .*ms
 ::endgroup::