feat!: merge exclude values by default (#588)

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

Author: 9aoy

e2e/exclude/fixtures/index.test.ts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from '@rstest/core';
+
+describe('test a', () => {
+  it('test a-1', () => {
+    expect(1 + 1).toBe(2);
+  });
+});
+
+it('test a-2', () => {
+  expect(2 - 1).toBe(1);
+});

e2e/exclude/fixtures/rstest.override.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  exclude: { patterns: ['**/aaa/**'], override: true },
+});

e2e/exclude/index.test.ts

@@ -0,0 +1,74 @@
+import fs from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { beforeAll, describe, it } from '@rstest/core';
+import { runRstestCli } from '../scripts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+describe('test exclude option', () => {
+  beforeAll(() => {
+    const distPath = join(__dirname, 'fixtures', 'dist');
+    fs.mkdirSync(distPath, { recursive: true });
+    const fileName = 'index.test.ts';
+
+    fs.writeFileSync(
+      join(distPath, fileName),
+      `
+      import { expect, it } from '@rstest/core';
+      it('should add two numbers correctly', () => {
+        expect(1 + 1).toBe(3);
+      });
+      `,
+    );
+  });
+
+  it('should exclude dist by default', async () => {
+    const { expectLog, expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecSuccess();
+
+    expectLog('Test Files 1 passed');
+  });
+
+  it('should exclude dist correctly with custom exclude', async () => {
+    const { expectLog, expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--exclude', '**/aaa/**'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecSuccess();
+
+    expectLog('Test Files 1 passed');
+  });
+
+  it('should not exclude dist when override is true', async () => {
+    const { expectLog, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '-c', 'rstest.override.config.ts'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    expectLog('Test Files 1 failed | 1 passed (2)');
+  });
+});

packages/core/src/config.ts

@@ -76,18 +76,48 @@ export async function loadConfig({
   return { content: content as RstestConfig, filePath: configFilePath };
 }
 
-export const mergeRstestConfig = (...configs: RstestConfig[]): RstestConfig =>
-  mergeRsbuildConfig<RstestConfig>(...configs);
+export const mergeRstestConfig = (...configs: RstestConfig[]): RstestConfig => {
+  return configs.reduce<RstestConfig>((result, config) => {
+    const merged = mergeRsbuildConfig(result, {
+      ...config,
+      exclude: Array.isArray(config.exclude)
+        ? {
+            patterns: config.exclude,
+            override: false,
+          }
+        : config.exclude,
+    });
+
+    if (!Array.isArray(config.exclude) && config.exclude?.override) {
+      merged.exclude = {
+        patterns: config.exclude.patterns,
+      };
+    }
+
+    // The following configurations need overrides
+    merged.include = config.include ?? merged.include;
+    merged.reporters = config.reporters ?? merged.reporters;
+    if (merged.coverage) {
+      merged.coverage.reporters =
+        config.coverage?.reporters ?? merged.coverage?.reporters;
+    }
+
+    return merged;
+  }, {});
+};
 
 const createDefaultConfig = (): NormalizedConfig => ({
   root: process.cwd(),
   name: 'rstest',
   include: ['**/*.{test,spec}.?(c|m)[jt]s?(x)'],
-  exclude: [
-    '**/node_modules/**',
-    '**/dist/**',
-    '**/.{idea,git,cache,output,temp}/**',
-  ],
+  exclude: {
+    patterns: [
+      '**/node_modules/**',
+      '**/dist/**',
+      '**/.{idea,git,cache,output,temp}/**',
+    ],
+    override: false,
+  },
   setupFiles: [],
   includeSource: [],
   pool: {
@@ -145,15 +175,9 @@ export const withDefaultConfig = (config: RstestConfig): NormalizedConfig => {
   ) as NormalizedConfig;
 
   merged.setupFiles = castArray(merged.setupFiles);
-  // The following configurations need overrides
-  merged.include = config.include || merged.include;
-  merged.exclude = (config.exclude || merged.exclude || []).concat([
-    TEMP_RSTEST_OUTPUT_DIR_GLOB,
-  ]);
-  merged.reporters = config.reporters ?? merged.reporters;
-
-  merged.coverage.reporters =
-    config.coverage?.reporters ?? merged.coverage?.reporters;
+
+  merged.exclude.patterns.push(TEMP_RSTEST_OUTPUT_DIR_GLOB);
+
   const reportsDirectory = formatRootStr(
     merged.coverage.reportsDirectory,
     merged.root,
@@ -172,7 +196,12 @@ export const withDefaultConfig = (config: RstestConfig): NormalizedConfig => {
   return {
     ...merged,
     include: merged.include.map((p) => formatRootStr(p, merged.root)),
-    exclude: merged.exclude.map((p) => formatRootStr(p, merged.root)),
+    exclude: {
+      ...merged.exclude,
+      patterns: merged.exclude.patterns.map((p) =>
+        formatRootStr(p, merged.root),
+      ),
+    },
     setupFiles: merged.setupFiles.map((p) => formatRootStr(p, merged.root)),
     includeSource: merged.includeSource.map((p) =>
       formatRootStr(p, merged.root),

packages/core/src/core/listTests.ts

@@ -32,7 +32,7 @@ export async function listTests(
 
     const entries = await getTestEntries({
       include,
-      exclude,
+      exclude: exclude.patterns,
       rootPath,
       projectRoot: root,
       fileFilters: context.fileFilters || [],

packages/core/src/core/runTests.ts

@@ -31,7 +31,7 @@ export async function runTests(context: Rstest): Promise<void> {
     )!.normalizedConfig;
     const entries = await getTestEntries({
       include,
-      exclude,
+      exclude: exclude.patterns,
       includeSource,
       rootPath,
       projectRoot: root,
@@ -244,7 +244,7 @@ export async function runTests(context: Rstest): Promise<void> {
           );
           logger.log(
             color.gray('exclude:'),
-            p.normalizedConfig.exclude.join(color.gray(', ')),
+            p.normalizedConfig.exclude.patterns.join(color.gray(', ')),
           );
         });
       }

packages/core/src/types/config.ts

@@ -59,7 +59,16 @@ export interface RstestConfig {
    *
    * @default ['**\/node_modules/**', '**\/dist/**']
    */
-  exclude?: string[];
+  exclude?:
+    | string[]
+    | {
+        patterns: string[];
+        /**
+         * override default exclude patterns
+         * @default false
+         */
+        override?: boolean;
+      };
   /**
    * A list of glob patterns that match your in-source test files
    *
@@ -248,14 +257,18 @@ type OptionalKeys =
 export type NormalizedConfig = Required<
   Omit<
     RstestConfig,
-    OptionalKeys | 'pool' | 'projects' | 'coverage' | 'setupFiles'
+    OptionalKeys | 'pool' | 'projects' | 'coverage' | 'setupFiles' | 'exclude'
   >
 > & {
   [key in OptionalKeys]?: RstestConfig[key];
 } & {
   pool: RstestPoolOptions;
   coverage: NormalizedCoverageOptions;
   setupFiles: string[];
+  exclude: {
+    patterns: string[];
+    override?: boolean;
+  };
 };
 
 export type NormalizedProjectConfig = Required<

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -0,0 +1,73 @@
+// Rstest Snapshot v1
+
+exports[`mergeRstestConfig > should merge config correctly with default config 1`] = `
+{
+  "clearMocks": false,
+  "coverage": {
+    "clean": true,
+    "enabled": false,
+    "exclude": [
+      "**/node_modules/**",
+      "**/[.]*",
+      "**/dist/**",
+      "**/test/**",
+      "**/__tests__/**",
+      "**/__mocks__/**",
+      "**/*.d.ts",
+      "**/*.{test,spec}.[jt]s",
+      "**/*.{test,spec}.[c|m][jt]s",
+      "**/*.{test,spec}.[jt]sx",
+      "**/*.{test,spec}.[c|m][jt]sx",
+    ],
+    "provider": "istanbul",
+    "reporters": [
+      "text",
+      "html",
+      "clover",
+      "json",
+    ],
+    "reportsDirectory": "<ROOT>/packages/core/tests/coverage",
+  },
+  "disableConsoleIntercept": false,
+  "exclude": {
+    "override": false,
+    "patterns": [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/.{idea,git,cache,output,temp}/**",
+      "**/aa/**",
+      "**/dist/.rstest-temp",
+    ],
+  },
+  "globals": false,
+  "hookTimeout": 10000,
+  "include": [
+    "tests/**/*.test.ts",
+  ],
+  "includeSource": [],
+  "isolate": true,
+  "maxConcurrency": 5,
+  "name": "rstest",
+  "passWithNoTests": false,
+  "pool": {
+    "type": "forks",
+  },
+  "printConsoleTrace": false,
+  "reporters": [
+    "verbose",
+  ],
+  "resetMocks": false,
+  "restoreMocks": false,
+  "retry": 0,
+  "root": "<ROOT>/packages/core/tests",
+  "setupFiles": [
+    "./setup.ts",
+  ],
+  "slowTestThreshold": 300,
+  "testEnvironment": "node",
+  "testTimeout": 5000,
+  "unstubEnvs": false,
+  "unstubGlobals": false,
+  "update": false,
+}
+`;

packages/core/tests/config.test.ts

@@ -0,0 +1,78 @@
+import { mergeRstestConfig, withDefaultConfig } from '../src/config';
+
+describe('mergeRstestConfig', () => {
+  it('should merge config correctly with default config', () => {
+    const merged = withDefaultConfig({
+      include: ['tests/**/*.test.ts'],
+      root: __dirname,
+      exclude: ['**/aa/**'],
+      setupFiles: ['./setup.ts'],
+      reporters: ['verbose'],
+    });
+
+    expect(merged).toMatchSnapshot();
+  });
+
+  it('should merge exclude correctly', () => {
+    expect(
+      mergeRstestConfig(
+        {
+          exclude: ['**/node_modules/**'],
+        },
+        {
+          exclude: {
+            patterns: ['**/dist/**'],
+            override: true,
+          },
+        },
+      ),
+    ).toEqual({
+      exclude: {
+        patterns: ['**/dist/**'],
+      },
+    });
+
+    expect(
+      mergeRstestConfig(
+        {
+          exclude: ['**/node_modules/**'],
+        },
+        {
+          exclude: {
+            patterns: ['**/dist/**'],
+            override: false,
+          },
+        },
+      ),
+    ).toEqual({
+      exclude: {
+        patterns: ['**/node_modules/**', '**/dist/**'],
+        override: false,
+      },
+    });
+
+    expect(
+      mergeRstestConfig(
+        {
+          exclude: {
+            patterns: ['**/dist/**'],
+            override: false,
+          },
+        },
+        {
+          exclude: ['**/node_modules/**'],
+        },
+        {
+          exclude: {
+            patterns: ['**/aa/**'],
+            override: true,
+          },
+        },
+      ),
+    ).toEqual({
+      exclude: {
+        patterns: ['**/aa/**'],
+      },
+    });
+  });
+});