For AI agents: the complete documentation index is available at https://rstest.rs/zh/llms.txt, the full documentation bundle is available at https://rstest.rs/zh/llms-full.txt, and this page is available as Markdown at https://rstest.rs/zh/config/test/setup-files.md.
close
  • 简体中文
  • setupFiles

    • 类型: string | string[]
    • 默认值: []

    一组 setup 文件列表,通常用于配置或设置测试环境,它们将在每个测试文件执行前运行。

    rstest.config.ts
    import { defineConfig } from '@rstest/core';
    
    export default defineConfig({
      setupFiles: ['./scripts/rstest.setup.ts'],
    });

    注册 hook

    setup 文件在测试文件加载前、在测试环境中执行,因此可以导入 Rstest API 来注册 hook 或扩展 matcher。例如,在每个测试结束后恢复 spy:

    scripts/rstest.setup.ts
    import { afterEach, rs } from '@rstest/core';
    
    afterEach(() => {
      rs.restoreAllMocks();
    });

    setup 文件的顶层代码每个测试文件执行一次;afterEach 回调则在每个测试结束后执行。即使 isolate 为 false,也遵循这一规则。

    与 globalSetup 不同,setup 文件不使用导出的 setup 或 teardown 函数。请注册 beforeAll、beforeEach、afterAll 或 afterEach 来控制初始化和清理时机。可以参考执行范围对照来选择。