feat: support coverage.reportsDirectory option (#557)

Co-authored-by: Copilot <[email protected]>

Author: 9aoy

e2e/projects/coverage.test.ts

@@ -0,0 +1,53 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from '@rstest/core';
+import fs from 'fs-extra';
+import { runRstestCli } from '../scripts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+describe('test projects coverage', () => {
+  it('should run projects correctly with coverage', async () => {
+    const { cli, expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--globals', '-c', 'rstest.coverage.config.ts'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecSuccess();
+    const logs = cli.stdout.split('\n').filter(Boolean);
+
+    expect(
+      logs.find(
+        (log) =>
+          log.includes('All files') &&
+          log.replaceAll(' ', '').includes('100|100|100|100'),
+      ),
+    ).toBeTruthy();
+
+    expect(
+      logs.find(
+        (log) =>
+          log.includes('client/test') &&
+          log.replaceAll(' ', '').includes('100|100|100|100'),
+      ),
+    ).toBeTruthy();
+
+    expect(
+      logs.find(
+        (log) =>
+          log.includes('node') &&
+          log.replaceAll(' ', '').includes('100|100|100|100'),
+      ),
+    ).toBeTruthy();
+
+    expect(
+      fs.existsSync(join(__dirname, 'fixtures/coverage/index.html')),
+    ).toBeTruthy();
+  });
+});

e2e/projects/fixtures/package.json

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "name": "@rstest/tests-projects",
+  "sideEffects": true,
+  "version": "1.0.0",
+  "devDependencies": {
+    "@rstest/core": "workspace:*",
+    "@rstest/coverage-istanbul": "workspace:*"
+  }
+}

e2e/projects/fixtures/rstest.coverage.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  projects: ['packages/*'],
+  globals: true,
+  coverage: {
+    enabled: true,
+  },
+  setupFiles: ['./setup.ts'],
+});

e2e/test-coverage/fixtures/rstest.reportsDirectory.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  coverage: {
+    enabled: true,
+    provider: 'istanbul',
+    reportsDirectory: 'test-temp-coverage',
+  },
+});

e2e/test-coverage/index.test.ts

@@ -104,3 +104,25 @@ it('coverage-istanbul with custom options', async () => {
     fs.existsSync(join(__dirname, 'fixtures/coverage/index.html')),
   ).toBeTruthy();
 });
+
+it('coverage-istanbul with custom reportsDirectory', async () => {
+  const { expectExecSuccess, expectLog, cli } = await runRstestCli({
+    command: 'rstest',
+    args: ['run', '-c', 'rstest.reportsDirectory.config.ts'],
+    options: {
+      nodeOptions: {
+        cwd: join(__dirname, 'fixtures'),
+      },
+    },
+  });
+
+  await expectExecSuccess();
+
+  const logs = cli.stdout.split('\n').filter(Boolean);
+
+  expectLog('Coverage enabled with istanbul', logs);
+
+  expect(
+    fs.existsSync(join(__dirname, 'fixtures/test-temp-coverage/index.html')),
+  ).toBeTruthy();
+});

packages/core/package.json

@@ -69,6 +69,7 @@
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/babel__code-frame": "^7.0.6",
     "@types/istanbul-reports": "^3.0.4",
+    "@types/istanbul-lib-coverage": "^2.0.6",
     "@types/jsdom": "^21.1.7",
     "@types/sinonjs__fake-timers": "^8.1.5",
     "@types/source-map-support": "^0.5.10",

packages/core/src/config.ts

@@ -4,7 +4,7 @@ import {
   loadConfig as loadRsbuildConfig,
   mergeRsbuildConfig,
 } from '@rsbuild/core';
-import { dirname, isAbsolute, join } from 'pathe';
+import { dirname, isAbsolute, join, resolve } from 'pathe';
 import type { NormalizedConfig, RstestConfig } from './types';
 import {
   color,
@@ -115,6 +115,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
     enabled: false,
     provider: 'istanbul',
     reporters: ['text', 'html', 'clover', 'json'],
+    reportsDirectory: './coverage',
   },
 });
 
@@ -131,6 +132,11 @@ export const withDefaultConfig = (config: RstestConfig): NormalizedConfig => {
   merged.coverage ??= {};
   merged.coverage.reporters =
     config.coverage?.reporters ?? merged.coverage?.reporters;
+  const reportsDirectory = merged.coverage.reportsDirectory!;
+  merged.coverage.reportsDirectory = isAbsolute(reportsDirectory)
+    ? reportsDirectory
+    : resolve(merged.root!, reportsDirectory);
+
   merged.pool =
     typeof config.pool === 'string'
       ? {

packages/core/src/types/coverage.ts

@@ -1,3 +1,4 @@
+import type { CoverageMap } from 'istanbul-lib-coverage';
 import type { ReportOptions } from 'istanbul-reports';
 
 type ReportWithOptions<Name extends keyof ReportOptions = keyof ReportOptions> =
@@ -24,17 +25,17 @@ export type CoverageOptions = {
    */
   reporters?: (keyof ReportOptions | ReportWithOptions)[];
 
+  /**
+   * The directory to store coverage reports.
+   * @default './coverage'
+   */
+  reportsDirectory?: string;
+
   // TODO: support clean
 };
 
 export type NormalizedCoverageOptions = Required<CoverageOptions>;
 
-interface CoverageMap {
-  files(): string[];
-  merge(other: any): void;
-  toJSON(): any;
-}
-
 export declare class CoverageProvider {
   constructor(options: CoverageOptions);
   /**

packages/coverage-istanbul/src/provider.ts

@@ -2,18 +2,13 @@ import type {
   NormalizedCoverageOptions,
   CoverageProvider as RstestCoverageProvider,
 } from '@rstest/core';
+import type { CoverageMap } from 'istanbul-lib-coverage';
 import istanbulLibCoverage from 'istanbul-lib-coverage';
 import { createContext } from 'istanbul-lib-report';
 import reports from 'istanbul-reports';
 
 const { createCoverageMap } = istanbulLibCoverage;
 
-interface CoverageMap {
-  files(): string[];
-  merge(other: any): void;
-  toJSON(): any;
-}
-
 // Global type declaration for coverage
 declare global {
   var __coverage__: any;
@@ -63,7 +58,7 @@ export class CoverageProvider implements RstestCoverageProvider {
 
     try {
       const context = createContext({
-        dir: 'coverage',
+        dir: this.options.reportsDirectory,
         defaultSummarizer: 'nested',
         coverageMap: createCoverageMap(coverageMap.toJSON()),
       });