feat: support clean coverage directory before running tests (#558)

Author: 9aoy

e2e/test-coverage/index.test.ts

@@ -99,10 +99,9 @@ it('coverage-istanbul with custom options', async () => {
   // text reporter
   expectLog('% Stmts', logs);
 
-  // TODO: should clean and not generate html reporter
   expect(
     fs.existsSync(join(__dirname, 'fixtures/coverage/index.html')),
-  ).toBeTruthy();
+  ).toBeFalsy();
 });
 
 it('coverage-istanbul with custom reportsDirectory', async () => {

packages/core/src/config.ts

@@ -116,6 +116,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
     provider: 'istanbul',
     reporters: ['text', 'html', 'clover', 'json'],
     reportsDirectory: './coverage',
+    clean: true,
   },
 });
 

packages/core/src/core/rsbuild.ts

@@ -124,13 +124,17 @@ export const prepareRsbuild = async (
     },
   });
 
-  if (coverage?.enabled) {
+  if (coverage?.enabled && command !== 'list') {
     const { loadCoverageProvider } = await import('../coverage');
+    const { pluginCoverageCore } = await import('../coverage/plugin');
     const { pluginCoverage } = await loadCoverageProvider(
       coverage,
       context.rootPath,
     );
-    rsbuildInstance.addPlugins([pluginCoverage(coverage)]);
+    rsbuildInstance.addPlugins([
+      pluginCoverage(coverage),
+      pluginCoverageCore(coverage),
+    ]);
   }
 
   return rsbuildInstance;

packages/core/src/coverage/plugin.ts

@@ -0,0 +1,18 @@
+import fs from 'node:fs';
+import type { RsbuildPlugin } from '@rstest/core';
+import type { NormalizedCoverageOptions } from '../types/coverage';
+
+export const pluginCoverageCore: (
+  coverageOptions: NormalizedCoverageOptions,
+) => RsbuildPlugin = (coverageOptions) => ({
+  name: 'rstest:coverage-core',
+  setup: (api) => {
+    api.onBeforeDevCompile(({ isFirstCompile }) => {
+      if (isFirstCompile && coverageOptions.clean) {
+        if (fs.existsSync(coverageOptions.reportsDirectory)) {
+          fs.rmSync(coverageOptions.reportsDirectory, { recursive: true });
+        }
+      }
+    });
+  },
+});

packages/core/src/types/config.ts

@@ -1,5 +1,5 @@
 import type { RsbuildConfig } from '@rsbuild/core';
-import type { CoverageOptions } from './coverage';
+import type { CoverageOptions, NormalizedCoverageOptions } from './coverage';
 import type {
   BuiltInReporterNames,
   Reporter,
@@ -21,7 +21,7 @@ export type RstestPoolOptions = {
 
 export type ProjectConfig = Omit<
   RstestConfig,
-  'projects' | 'reporters' | 'pool' | 'isolate'
+  'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'
 >;
 
 /**
@@ -246,16 +246,17 @@ type OptionalKeys =
   | 'dev'
   | 'onConsoleLog';
 
-export type NormalizedProjectConfig = Required<
-  Omit<RstestConfig, OptionalKeys | 'projects' | 'reporters' | 'pool'>
-> & {
-  [key in OptionalKeys]?: RstestConfig[key];
-};
-
 export type NormalizedConfig = Required<
-  Omit<RstestConfig, OptionalKeys | 'pool' | 'projects'>
+  Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage'>
 > & {
   [key in OptionalKeys]?: RstestConfig[key];
 } & {
   pool: RstestPoolOptions;
+  coverage: NormalizedCoverageOptions;
+};
+
+export type NormalizedProjectConfig = Required<
+  Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool'>
+> & {
+  [key in OptionalKeys]?: NormalizedConfig[key];
 };

packages/core/src/types/core.ts

@@ -39,8 +39,9 @@ export type RstestContext = {
   /**
    * The command type.
    *
-   * - dev: `rstest dev`
-   * - run: `rstest run`
+   * - run: `rstest`
+   * - dev: `rstest dev` or watch mode
+   * - list: `rstest list`
    */
   command: RstestCommand;
   reporters: Reporter[];

packages/core/src/types/coverage.ts

@@ -31,7 +31,11 @@ export type CoverageOptions = {
    */
   reportsDirectory?: string;
 
-  // TODO: support clean
+  /**
+   * Whether to clean the coverage directory before running tests.
+   * @default true
+   */
+  clean?: boolean;
 };
 
 export type NormalizedCoverageOptions = Required<CoverageOptions>;

website/docs/en/config/test/projects.mdx

@@ -5,7 +5,7 @@
 ```ts
 type ProjectConfig = Omit<
   RstestConfig,
-  'projects' | 'reporters' | 'pool' | 'isolate'
+  'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'
 >;
 
 type Projects = (string | ProjectConfig)[];

website/docs/zh/config/test/projects.mdx

@@ -5,7 +5,7 @@
 ```ts
 type ProjectConfig = Omit<
   RstestConfig,
-  'projects' | 'reporters' | 'pool' | 'isolate'
+  'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'
 >;
 
 type Projects = (string | ProjectConfig)[];