Vitest

测试项目 ​

示例项目

GitHub - 在线运行

WARNING

此功能也被称为 workspace。workspace 自 3.2 起已弃用，并被 projects 配置取代。它们在功能上是相同的。

Vitest 提供了一种在单个 Vitest 进程中定义多个项目配置的方法。此功能对于单仓库设置特别有用，但也可用于使用不同配置运行测试，例如 resolve.alias、plugins 或 test.browser 等。

定义项目 ​

你可以在根 config 中定义项目：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: ['packages/*'],
  },
})

项目配置可以是内联配置、文件或引用你项目的 glob 模式。例如，如果你有一个名为 packages 的文件夹包含你的项目，你可以在根 Vitest 配置中定义一个数组：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: ['packages/*'],
  },
})

Vitest 会将 packages 中的每个文件夹视为一个单独的项目，即使里面没有配置文件。如果项目条目解析为文件（来自 glob 模式或直接文件路径），Vitest 将验证名称是否：

  • 以 vitest.config 或 vite.config 开头（例如，vitest.config.unit.ts）
  • 或匹配 vitest.<name>.config.* / vite.<name>.config.*，其中 <name> 可以包含字母、数字、_ 和 -

例如，这些配置文件是有效的：

  • vitest.config.ts
  • vite.config.js
  • vitest.unit.config.ts
  • vitest.e2e-node.config.ts
  • vite.e2e.config.js
  • vitest.config.unit.js
  • vite.config.e2e.js

要排除文件夹和文件，你可以使用否定模式：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    // 包含 "packages" 内的所有文件夹，除了 "excluded"
    projects: [
      'packages/*',
      '!packages/excluded'
    ],
  },
})

如果你有一个嵌套结构，其中某些文件夹需要成为项目，但其他文件夹有自己的子文件夹，你必须使用括号以避免匹配父文件夹：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

// 例如，这将创建项目：
// packages/a
// packages/b
// packages/business/c
// packages/business/d
// 注意 "packages/business" 本身不是一个项目

export default defineConfig({
  test: {
    projects: [
      // 匹配 "packages" 内的每个文件夹，除了 "business"
      'packages/!(business)',
      // 匹配 "packages/business" 内的每个文件夹
      'packages/business/*',
    ],
  },
})

WARNING

Vitest 不会将根 vitest.config 文件视为项目，除非在配置中明确指定。因此，根配置只会影响全局选项，例如 reporters 和 coverage。请注意，Vitest 将始终运行根配置文件中指定的某些插件钩子，如 apply、config、configResolved 或 configureServer。Vitest 还使用相同的插件来执行全局设置和自定义覆盖率提供者。

你也可以通过配置文件引用项目：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: ['packages/*/vitest.config.{e2e,unit}.ts'],
  },
})

此模式将仅包含扩展名之前包含 e2e 或 unit 的 vitest.config 文件的项目。

你也可以使用内联配置定义项目。配置同时支持这两种语法。

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: [
      // 匹配 `packages` 文件夹内的每个文件夹和文件
      'packages/*',
      {
        // 内联项目默认继承
        // 此配置文件中的选项
        test: {
          include: ['tests/**/*.{browser}.test.{ts,js}'],
          // 建议在使用内联配置时定义名称
          name: 'happy-dom',
          environment: 'happy-dom',
        }
      },
      {
        // 添加 "extends: false" 以忽略
        // 此配置文件中定义的选项
        extends: false,
        test: {
          include: ['tests/**/*.{node}.test.{ts,js}'],
          // 名称标签的颜色可以更改
          name: { label: 'node', color: 'green' },
          environment: 'node',
        }
      }
    ]
  }
})

WARNING

所有项目必须具有唯一的名称；否则，Vitest 将抛出错误。如果内联配置中未提供名称，Vitest 将分配一个数字。对于使用 glob 语法定义的项目配置，Vitest 默认使用最近 package.json 文件中的 "name" 属性，如果不存在，则使用文件夹名称。

项目不支持所有配置属性。为了更好的类型安全，在项目配置文件中使用 defineProject 方法而不是 defineConfig：

packages/a/vitest.config.ts
ts
import { 
defineProject
 } from 'vitest/config'

export default 
defineProject
({
  
test
: {
    
environment
: 'jsdom',
    // "reporters" 在项目配置中不受支持，
    // 因此它会显示错误
    reporters: ['json']
No overload matches this call.
  The last overload gave the following error.
    Object literal may only specify known properties, and 'reporters' does not exist in type 'Omit<InlineConfig, NonProjectOptions | "projects" | "sequence" | "deps"> & { mode?: string | undefined; sequence?: (Omit<SequenceOptions, "sequencer" | ... 1 more ... | "shuffle"> & { ...; }) | undefined; deps?: DepsOptions | undefined; } & { ...; }'.
  }
})

运行测试 ​

要运行测试，请在根 package.json 中定义一个脚本：

package.json
json
{
  "scripts": {
    "test": "vitest"
  }
}

现在可以使用你的包管理器运行测试：

bash
npm run test
bash
yarn test
bash
pnpm run test
bash
bun run test

如果你只需要在单个项目中运行测试，请使用 --project CLI 选项：

bash
npm run test --project e2e
bash
yarn test --project e2e
bash
pnpm run test --project e2e
bash
bun run test --project e2e

TIP

CLI 选项 --project 可以多次使用以过滤出多个项目：

bash
npm run test --project e2e --project unit
bash
yarn test --project e2e --project unit
bash
pnpm run test --project e2e --project unit
bash
bun run test --project e2e --project unit

该过滤器支持 * 通配符和 ! 排除项。如果项目不匹配任何否定模式，并且同时提供了常规模式，则至少匹配其中一个常规模式，该项目就会运行：

bash
# run every project except "e2e"
vitest --project '!e2e'
# run every project starting with "unit", except "unit (browser)"
vitest --project 'unit*' --project '!unit (browser)'

配置 ​

使用内联配置定义的项目会继承根级配置中的所有选项。这由 extends 选项控制，自 Vitest 5.0 起默认启用：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
  test: {
    pool: 'threads',
    projects: [
      {
        // 继承此配置中的选项，例如插件和 pool
        //（`extends: true` 是默认值）
        test: {
          name: 'unit',
          include: ['**/*.unit.test.ts'],
        },
      },
      {
        // 不会继承此配置中的任何选项
        extends: false,
        test: {
          name: 'integration',
          include: ['**/*.integration.test.ts'],
        },
      },
    ],
  },
})

如果你希望从根配置之外的其他配置文件继承选项，extends 选项也接受另一个配置文件的路径：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: [
      {
        extends: './vitest.shared.ts',
        test: {
          name: 'unit',
          include: ['**/*.unit.test.ts'],
        },
      },
    ],
  },
})

扩展配置中的所有选项都会与项目自身的选项合并。请注意，setupFiles 等数组会进行拼接，而不是被覆盖。有几个选项会被特殊处理：

  • name 和 projects 永远不会被继承。
  • globalSetup 不会从根配置中继承：根级别的 globalSetup 已经会在每次测试运行时执行一次，因此继承它会导致相同的文件在每个项目中再次执行。从非根配置文件扩展时，仍然会继承该选项。
  • 项目自身的 tags 会替换继承的数组，而不是与其合并。

如果你通过高级 API运行 Vitest，请参阅项目配置解析，了解程序化配置如何参与继承。

以配置文件或目录形式引用的项目不会从根配置中继承任何选项。你可以创建一个共享配置文件，然后自行将其与项目配置合并：

packages/a/vitest.config.ts
ts
import { defineProject, mergeConfig } from 'vitest/config'
import configShared from '../vitest.shared.js'

export default mergeConfig(
  configShared,
  defineProject({
    test: {
      environment: 'jsdom',
    }
  })
)

不支持的选项

某些配置选项不允许在项目配置中使用。其中最重要的包括：

  • coverage：覆盖率在整个进程中计算
  • reporters：仅支持根级报告器
  • resolveSnapshotPath：仅支持根级解析器
  • attachmentsDir：附件存储在一个由所有项目共享的根级目录中
  • 所有其他不会影响测试运行器的选项

所有在项目配置中不受支持的配置选项都在其名称旁边标记有 图标。它们只能在根配置文件中定义一次。

嵌套项目 ​

作为配置文件（或包含配置文件的目录）引用的项目本身可以声明 projects。这样的配置表现得就像根配置一样：它自身不会运行任何测试，只提供实际运行测试的项目。这样就可以引用一个已经定义了自身项目的工作区：

vitest.config.ts
ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: ['./packages/app/vitest.config.ts'],
  },
})
packages/app/vitest.config.ts
ts
import { defineProject } from 'vitest/config'

export default defineProject({
  test: {
    name: 'app',
    projects: [
      {
        test: {
          name: 'unit',
          include: ['**/*.unit.test.ts'],
        },
      },
      {
        test: {
          name: 'e2e',
          include: ['**/*.e2e.test.ts'],
        },
      },
    ],
  },
})

嵌套项目的工作方式与根配置中定义的项目相同：内联配置会扩展声明它们的配置（此处是 app 配置，而不是根配置），extends 路径相对于该配置解析，并且它自身的 globalSetup 会被扩展项目继承，就像任何其他非根配置一样。

嵌套项目的名称会添加声明它们的配置名称作为前缀，因此上面的示例会创建 app (unit) 和 app (e2e) 项目。--project 过滤器也会匹配此前缀：--project app 会运行 app 配置的所有项目，而 --project "app (unit)" 只会运行其中一个项目。

如果还要运行声明 projects 的配置中的测试，请引用其自身的配置文件：

packages/app/vitest.config.ts
ts
import { defineProject } from 'vitest/config'

export default defineProject({
  test: {
    name: 'app',
    include: ['**/*.test.ts'],
    projects: [
      // "app" 项目会运行其自身的 "include"，以及 "app (unit)"
      './vitest.config.ts',
      {
        test: {
          name: 'unit',
          include: ['**/*.unit.test.ts'],
        },
      },
    ],
  },
})

请注意，只有配置文件才能定义嵌套项目。内联配置中的 projects 选项不受支持。

调试项目解析 ​

如果项目未按照预期解析，请使用环境变量 DEBUG=vitest:projects 运行 Vitest：

bash
DEBUG=vitest:projects vitest

Vitest 会记录每个项目的解析方式：glob 模式匹配了哪些文件、浏览器实例和基准测试项目是如何展开的、项目为何被 --project 过滤器排除，以及项目是创建自己的 Vite 服务器还是与其他项目共享一个：

vitest:projects resolving 3 project definitions declared by <root>/vitest.config.ts
vitest:projects projects glob "packages/*" matched 2 paths
vitest:projects inline project "unit" shares the Vite server of <root>/vitest.config.ts
vitest:projects project "e2e" is dropped by the --project filter: unit
vitest:projects resolved projects: "unit", "pkg-a", "pkg-b"
vitest:projects creating a Vite server for project "pkg-a"

© 2026 VoidZero Inc. and Vitest contributors.