feat: support customize the chai config via chaiConfig configuration. (#683)

Author: 9aoy

e2e/chaiConfigs/fixtures/index.test.ts

@@ -0,0 +1,7 @@
+import { describe, expect, it } from '@rstest/core';
+
+describe('Index', () => {
+  it('test truncateThreshold', () => {
+    expect([1, 2, [3, [4], { a: 1, length: 1 }]]).toStrictEqual([1, 2, [3]]);
+  });
+});

e2e/chaiConfigs/fixtures/rstest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  chaiConfig: {
+    truncateThreshold: 100,
+  },
+});

e2e/chaiConfigs/index.test.ts

@@ -0,0 +1,27 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, it } from '@rstest/core';
+import { runRstestCli } from '../scripts/';
+
+const __filename = fileURLToPath(import.meta.url);
+
+const __dirname = dirname(__filename);
+
+describe('test chai config', () => {
+  it('should return test correct with chai config', async () => {
+    const { expectExecFailed, expectLog } = await runRstestCli({
+      command: 'rstest',
+      args: ['run'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecFailed();
+    expectLog(
+      'expected [ 1, 2, [ 3, [ 4 ], { a: 1, length: 1 } ] ] to strictly equal',
+    );
+  });
+});

examples/node/package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "build": "rsbuild build",
     "test": "rstest",
+    "test:coverage": "rstest --coverage",
     "test:watch": "rstest --watch"
   },
   "devDependencies": {

examples/node/rstest.config.ts

@@ -1,8 +1,3 @@
 import { defineConfig } from '@rstest/core';
 
-export default defineConfig({
-  coverage: {
-    enabled: true,
-    provider: 'istanbul',
-  },
-});
+export default defineConfig({});

packages/core/src/pool/index.ts

@@ -55,6 +55,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     snapshotFormat,
     env,
     logHeapUsage,
+    chaiConfig,
   } = context.normalizedConfig;
 
   return {
@@ -78,6 +79,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     coverage,
     snapshotFormat,
     logHeapUsage,
+    chaiConfig,
   };
 };
 

packages/core/src/runtime/api/expect.ts

@@ -31,6 +31,7 @@ import {
 import * as chai from 'chai';
 import type {
   Assertion,
+  ChaiConfig,
   MatcherState,
   RstestExpect,
   TestCase,
@@ -45,6 +46,10 @@ chai.use(SnapshotPlugin);
 chai.use(JestAsymmetricMatchers);
 export { GLOBAL_EXPECT };
 
+export function setupChaiConfig(config: ChaiConfig): void {
+  Object.assign(chai.config, config);
+}
+
 export function createExpect({
   getCurrentTest,
   workerState,

packages/core/src/runtime/api/index.ts

@@ -8,7 +8,7 @@ import type {
   WorkerState,
 } from '../../types';
 import { createRunner } from '../runner';
-import { assert, createExpect, GLOBAL_EXPECT } from './expect';
+import { assert, createExpect, GLOBAL_EXPECT, setupChaiConfig } from './expect';
 import { createRstestUtilities } from './utilities';
 
 export const createRstestRuntime = (
@@ -27,6 +27,10 @@ export const createRstestRuntime = (
 } => {
   const { runner, api: runnerAPI } = createRunner({ workerState });
 
+  if (workerState.runtimeConfig.chaiConfig) {
+    setupChaiConfig(workerState.runtimeConfig.chaiConfig);
+  }
+
   const expect: RstestExpect = createExpect({
     workerState,
     getCurrentTest: () => runner.getCurrentTest(),

packages/core/src/types/config.ts

@@ -1,12 +1,17 @@
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { SnapshotStateOptions } from '@vitest/snapshot';
+import type { config } from 'chai';
 import type { CoverageOptions, NormalizedCoverageOptions } from './coverage';
 import type {
   BuiltInReporterNames,
   Reporter,
   ReporterWithOptions,
 } from './reporter';
 
+export type ChaiConfig = Partial<
+  Omit<typeof config, 'useProxy' | 'proxyExcludedKeys' | 'deepEqual'>
+>;
+
 export type RstestPoolType = 'forks';
 
 export type RstestPoolOptions = {
@@ -251,6 +256,11 @@ export interface RstestConfig {
    */
   coverage?: CoverageOptions;
 
+  /**
+   * chai configuration options
+   */
+  chaiConfig?: ChaiConfig;
+
   // Rsbuild configs
 
   plugins?: RsbuildConfig['plugins'];
@@ -290,6 +300,7 @@ type OptionalKeys =
   | 'tools'
   | 'dev'
   | 'onConsoleLog'
+  | 'chaiConfig'
   | 'resolveSnapshotPath';
 
 export type NormalizedConfig = Required<

packages/core/src/types/worker.ts

@@ -49,6 +49,7 @@ export type RuntimeConfig = Pick<
   | 'snapshotFormat'
   | 'env'
   | 'logHeapUsage'
+  | 'chaiConfig'
 >;
 
 export type WorkerContext = {