Add a summary reporter for tests

Author: leeyi45

lib/vitest-reporter/build.js

@@ -4,17 +4,21 @@
   "version": "1.0.0",
   "type": "module",
   "dependencies": {
-    "istanbul-lib-report": "^3.0.1"
+    "istanbul-lib-report": "^3.0.1",
+    "vitest": "^3.2.3"
   },
   "devDependencies": {
-    "@sourceacademy/modules-repotools": "workspace:^",
     "@types/istanbul-lib-report": "^3.0.3",
+    "esbuild": "^0.25.8",
     "typescript": "^5.8.2"
   },
   "exports": {
-    ".": "./dist.cjs"
+    "./coverage-reporter": "./dist/coverage-reporter.cjs",
+    "./test-reporter": "./dist/test-reporter.js"
   },
   "scripts": {
-    "build": "node ./build.js"
+    "build": "yarn build:coverage-reporter && yarn build:test-reporter",
+    "build:coverage-reporter": "esbuild --outfile=./dist/coverage-reporter.cjs --format=cjs --bundle=true --external:\"istanbul-lib-report\" --platform=node src/coverage-reporter.cts",
+    "build:test-reporter": "esbuild --outfile=./dist/test-reporter.js --format=esm --bundle=true --external:\"vitest*\" --platform=node src/test-reporter.ts"
   }
 }

lib/vitest-reporter/dist.cjs

@@ -0,0 +1,72 @@
+import fs from 'fs';
+import type { RunnerTestFile, TestCase, TestModule, TestSuite, Vitest } from 'vitest/node';
+import { BasicReporter } from 'vitest/reporters';
+
+function* formatTestCase(testCase: TestCase, prefixes: string[]) {
+  const passed = testCase.ok();
+  const diagnostics = testCase.diagnostic();
+  const durationStr = diagnostics ? `${diagnostics.duration}ms` : '';
+
+  if (prefixes.length > 0) {
+    yield `- ${passed ? '✅' : '❌'} ${prefixes.join(' > ')} > ${testCase.name} ${durationStr}`;
+  } else {
+    yield `- ${passed ? '✅' : '❌'} ${testCase.name} ${durationStr}`;
+  }
+}
+
+function* formatTestSuite(suite: TestSuite, prefixes: string[]): Generator<string> {
+  const suiteName = suite.name;
+
+  for (const child of suite.children) {
+    if (child.type === 'suite') {
+      yield* formatTestSuite(child, [...prefixes, suiteName]);
+    } else {
+      yield* formatTestCase(child, [...prefixes, suiteName]);
+    }
+  }
+}
+
+function getTestCount(item: TestModule | TestSuite | TestCase): number {
+  if (item.type === 'test') return 1;
+
+  let output = 0;
+  for (const child of item.children) {
+    output += getTestCount(child);
+  }
+
+  return output;
+}
+
+export default class GithubActionsSummaryReporter extends BasicReporter {
+  private writeStream: fs.WriteStream | null = null;
+  private vitest: Vitest | null = null;
+
+  onInit(vitest: Vitest) {
+    this.vitest = vitest;
+
+    if (process.env.GITHUB_STEP_SUMMARY) {
+      this.writeStream = fs.createWriteStream(process.env.GITHUB_STEP_SUMMARY, { encoding: 'utf-8', flags: 'a' });
+    }
+  }
+
+  onTestRunEnd(files: RunnerTestFile[]) {
+    if (!this.writeStream) return;
+
+    this.writeStream.write('<h3>Test Results</h3>');
+    for (const file of files) {
+      const testModule = this.vitest!.state.getReportedEntity(file) as TestModule;
+      const passed = testModule.ok();
+      const testCount = getTestCount(testModule);
+
+      this.writeStream.write(`${passed ? '✅' : '❌'} \`${file.filepath}\` (${testCount} test${testCount === 1 ? '' : 's'}) \n`);
+
+      for (const child of testModule.children) {
+        const formatter = child.type === 'suite' ? formatTestSuite(child, []) : formatTestCase(child, []);
+        const line = Array.from(formatter).join('');
+        this.writeStream.write(line);
+      }
+    }
+
+    this.writeStream.close();
+  }
+}

lib/vitest-reporter/package.json

@@ -1,10 +1,10 @@
 // Repotools regular tsconfig
 {
   "extends": ["../tsconfig.json"],
-  "include": ["./index.cts"],
+  "include": ["src"],
   "compilerOptions": {
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "verbatimModuleSyntax": false
   }
 }

lib/vitest-reporter/index.cts renamed to lib/vitest-reporter/src/coverage-reporter.cts

@@ -2,11 +2,19 @@
 // Root vitest config
 import pathlib from 'path';
 import { coverageConfigDefaults, defineConfig } from 'vitest/config';
+import GithubActionsSummaryReporter from './lib/vitest-reporter/dist/test-reporter.js';
 
 const coverageReporters = ['text'];
+
+/**
+ * @type {Exclude<import('vitest/config').ViteUserConfig['test'], undefined>['reporters']}
+ */
+const testReporters = ['default'];
+
 if (process.env.GITHUB_ACTIONS) {
-  const reporter = pathlib.resolve(import.meta.dirname, './lib/vitest-reporter/dist.cjs');
+  const reporter = pathlib.resolve(import.meta.dirname, './lib/vitest-reporter/dist/coverage-reporter.cjs');
   coverageReporters.push(reporter);
+  testReporters.push(new GithubActionsSummaryReporter());
 } else {
   coverageReporters.push('html');
 }
@@ -26,6 +34,7 @@ export default defineConfig({
       './src/bundles/*',
       './src/tabs/*'
     ],
+    reporters: testReporters,
     clearMocks: true,
     coverage: {
       provider: 'v8',

lib/vitest-reporter/src/test-reporter.ts

@@ -4108,10 +4108,11 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@sourceacademy/vitest-reporter@workspace:lib/vitest-reporter"
   dependencies:
-    "@sourceacademy/modules-repotools": "workspace:^"
     "@types/istanbul-lib-report": "npm:^3.0.3"
+    esbuild: "npm:^0.25.8"
     istanbul-lib-report: "npm:^3.0.1"
     typescript: "npm:^5.8.2"
+    vitest: "npm:^3.2.3"
   languageName: unknown
   linkType: soft