feat: support env option

e2e/env/fixtures/index.test.ts

@@ -0,0 +1,5 @@
+import { expect, it } from '@rstest/core';
+
+it('should get environment variables correctly', () => {
+  expect(process.env.printLogger).toBe('true');
+});

e2e/env/fixtures/rstest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  env: {
+    printLogger: 'true',
+  },
+});

e2e/env/index.test.ts

@@ -0,0 +1,25 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, it } from '@rstest/core';
+import { join } from 'pathe';
+import { runRstestCli } from '../scripts/';
+
+const __filename = fileURLToPath(import.meta.url);
+
+const __dirname = dirname(__filename);
+
+describe('test environment variables', () => {
+  it('should get environment variables correctly in test', async () => {
+    const { expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', 'index.test.ts'],
+      options: {
+        nodeOptions: {
+          cwd: join(__dirname, 'fixtures'),
+        },
+      },
+    });
+
+    await expectExecSuccess();
+  });
+});

packages/core/src/config.ts

@@ -145,6 +145,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
   printConsoleTrace: false,
   disableConsoleIntercept: false,
   snapshotFormat: {},
+  env: {},
   coverage: {
     exclude: [
       '**/node_modules/**',

packages/core/src/pool/index.ts

@@ -52,9 +52,11 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     isolate,
     coverage,
     snapshotFormat,
+    env,
   } = context.normalizedConfig;
 
   return {
+    env,
     testNamePattern,
     testTimeout,
     hookTimeout,

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

@@ -28,6 +28,12 @@ const registerGlobalApi = (api: Rstest) => {
 const listeners: (() => void)[] = [];
 let isTeardown = false;
 
+const setupEnv = (env?: Partial<NodeJS.ProcessEnv>) => {
+  if (env) {
+    Object.assign(process.env, env);
+  }
+};
+
 const preparePool = async ({
   entryInfo: { distPath, testPath },
   sourceMaps,
@@ -47,9 +53,12 @@ const preparePool = async ({
       disableConsoleIntercept,
       testEnvironment,
       snapshotFormat,
+      env,
     },
   } = context;
 
+  setupEnv(env);
+
   if (!disableConsoleIntercept) {
     const { createCustomConsole } = await import('./console');
 

packages/core/src/types/config.ts

@@ -218,6 +218,11 @@ export interface RstestConfig {
   /** Format snapshot output */
   snapshotFormat?: SnapshotFormat;
 
+  /**
+   * Custom environment variables available on `process.env` during tests.
+   */
+  env?: Partial<NodeJS.ProcessEnv>;
+
   /**
    * Coverage options
    */

packages/core/src/types/worker.ts

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

website/docs/en/config/test/_meta.json

@@ -11,6 +11,7 @@
   "includeSource",
   "testNamePattern",
 
+  "env",
   "retry",
   "testTimeout",
   "hookTimeout",

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

@@ -0,0 +1,30 @@
+---
+overviewHeaders: []
+---
+
+# env
+
+- **Type:** `Partial<NodeJS.ProcessEnv>`
+- **Default:** `undefined`
+
+Custom environment variables available on `process.env` during tests.
+
+```ts title="rstest.config.ts"
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  env: {
+    PRINT_LOGGER: 'true',
+  },
+});
+```
+
+After setting the above configuration, you can access the `PRINT_LOGGER` variable in your tests:
+
+```ts title="index.test.ts"
+import { describe, it } from '@rstest/core';
+
+if (process.env.PRINT_LOGGER === 'true') {
+  console.log('PRINT_LOGGER is enabled');
+}
+```

website/docs/zh/config/test/_meta.json

@@ -11,6 +11,7 @@
   "includeSource",
   "testNamePattern",
 
+  "env",
   "retry",
   "testTimeout",
   "hookTimeout",

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

@@ -0,0 +1,30 @@
+---
+overviewHeaders: []
+---
+
+# env
+
+- **类型：** `Partial<NodeJS.ProcessEnv>`
+- **默认值：** `undefined`
+
+自定义环境变量，在测试过程中可以通过 `process.env` 访问。
+
+```ts title="rstest.config.ts"
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  env: {
+    PRINT_LOGGER: 'true',
+  },
+});
+```
+
+在设置上述配置后，现在，你可以在测试中访问 `PRINT_LOGGER` 变量：
+
+```ts title="index.test.ts"
+import { describe, it } from '@rstest/core';
+
+if (process.env.PRINT_LOGGER === 'true') {
+  console.log('PRINT_LOGGER is enabled');
+}
+```

website/theme/components/ConfigOverview.tsx

@@ -31,7 +31,7 @@ const OVERVIEW_GROUPS: Group[] = [
   },
   {
     name: 'runtime',
-    items: ['retry', 'testTimeout', 'hookTimeout', 'maxConcurrency'],
+    items: ['env', 'retry', 'testTimeout', 'hookTimeout', 'maxConcurrency'],
   },
   {
     name: 'environment',