feat(@angular/build): add reporter output file option for unit-test

cexbrayat · cexbrayat · commit 5bccc8101d42 · 2025-09-11T23:07:54.000+02:00
The experimental `unit-test` builder now contains an additional option named `outputFile` that supports configuring the output file for the reporter. This option is currently only used by the `vitest` runner. See https://vitest.dev/config/#outputfile Usage example: ``` ng test --no-watch --reporter=json --output-file=results/unit-test.json ```
diff --git a/goldens/public-api/angular/build/index.api.md b/goldens/public-api/angular/build/index.api.md
@@ -223,6 +223,7 @@ export type UnitTestBuilderOptions = {
     debug?: boolean;
     exclude?: string[];
     include?: string[];
+    outputFile?: string;
     progress?: boolean;
     providersFile?: string;
     reporters?: string[];
diff --git a/packages/angular/build/src/builders/unit-test/options.ts b/packages/angular/build/src/builders/unit-test/options.ts
@@ -33,7 +33,7 @@ export async function normalizeOptions(
   const buildTargetSpecifier = options.buildTarget ?? `::development`;
   const buildTarget = targetFromTargetString(buildTargetSpecifier, projectName, 'build');
 
-  const { tsConfig, runner, reporters, browsers, progress } = options;
+  const { tsConfig, runner, reporters, outputFile, browsers, progress } = options;
 
   return {
     // Project/workspace information
@@ -59,6 +59,7 @@ export async function normalizeOptions(
     tsConfig,
     buildProgress: progress,
     reporters,
+    outputFile,
     browsers,
     watch: options.watch ?? isTTY(),
     debug: options.debug ?? false,
diff --git a/packages/angular/build/src/builders/unit-test/runners/vitest/executor.ts b/packages/angular/build/src/builders/unit-test/runners/vitest/executor.ts
@@ -135,8 +135,8 @@ export class VitestExecutor implements TestExecutor {
   }
 
   private async initializeVitest(): Promise<Vitest> {
-    const { codeCoverage, reporters, workspaceRoot, browsers, debug, watch } = this.options;
-
+    const { codeCoverage, reporters, outputFile, workspaceRoot, browsers, debug, watch } =
+      this.options;
     let vitestNodeModule;
     try {
       vitestNodeModule = await loadEsmModule<typeof import('vitest/node')>('vitest/node');
@@ -196,6 +196,7 @@ export class VitestExecutor implements TestExecutor {
         name: 'base',
         include: [],
         reporters: reporters ?? ['default'],
+        outputFile,
         watch,
         coverage: generateCoverageOption(codeCoverage),
         ...debugOptions,
diff --git a/packages/angular/build/src/builders/unit-test/schema.json b/packages/angular/build/src/builders/unit-test/schema.json
@@ -93,6 +93,10 @@
         "type": "string"
       }
     },
+    "outputFile": {
+      "type": "string",
+      "description": "The file to output the test report to. If not specified, the test runner will output to the console."
+    },
     "providersFile": {
       "type": "string",
       "description": "TypeScript file that exports an array of Angular providers to use during test execution. The array must be a default export.",
diff --git a/packages/angular/build/src/builders/unit-test/tests/options/reporter_and_output_file_spec.ts b/packages/angular/build/src/builders/unit-test/tests/options/reporter_and_output_file_spec.ts
@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+
+import { execute } from '../../index';
+import {
+  BASE_OPTIONS,
+  describeBuilder,
+  UNIT_TEST_BUILDER_INFO,
+  setupApplicationTarget,
+} from '../setup';
+
+describeBuilder(execute, UNIT_TEST_BUILDER_INFO, (harness) => {
+  describe('Options: "reporter" and "outputFile"', () => {
+    beforeEach(async () => {
+      setupApplicationTarget(harness);
+    });
+
+    it(`should output a JSON report`, async () => {
+      await harness.removeFile('src/app/app.component.spec.ts');
+      await harness.writeFiles({
+        'src/app/services/test.service.spec.ts': `
+          describe('TestService', () => {
+            it('should succeed', () => {
+              expect(true).toBe(true);
+            });
+          });`,
+      });
+
+      harness.useTarget('test', {
+        ...BASE_OPTIONS,
+        reporters: ['json'],
+        outputFile: 'test-report.json',
+      });
+
+      const { result } = await harness.executeOnce();
+      expect(result?.success).toBeTrue();
+      const reportContent = await harness.readFile('test-report.json');
+      expect(reportContent).toContain('TestService');
+    });
+  });
+});
