TestConfig

Playwright Test 提供了许多选项来配置测试的收集和执行方式，例如 timeout 或 testDir。这些选项在配置文件中的 TestConfig 对象中有详细描述。该类型描述了配置文件的格式，要在运行时访问已解析的配置参数，请使用 FullConfig。

Playwright Test 支持同时运行多个测试项目。项目特定的选项应放在 testConfig.projects 中，但顶层的 TestConfig 也可以定义所有项目共享的基础选项。

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  timeout: 30000,
  globalTimeout: 600000,
  reporter: 'list',
  testDir: './tests',
});

属性

build

v1.35 新增

testConfig.build

Playwright 转译器配置。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  build: {
    external: ['**/*bundle.js'],
  },
});

类型

Object
- external Array<string> (可选)
  
  以 glob 模式列表形式指定要从转译中排除的路径。通常这里会列出测试使用的大型 JS 包。

captureGitInfo

添加于: v1.51

testConfig.captureGitInfo

这些设置控制是否捕获 git 信息并存储在配置 testConfig.metadata 中。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  captureGitInfo: { commit: true, diff: true }
});

类型

Object
- commit boolean (可选)
  
  是否捕获提交和拉取请求信息，如哈希值、作者、时间戳。
- diff boolean (可选)
  
  是否捕获提交差异。

详情

捕获 commit 信息在您希望查看 HTML（或第三方）报告时非常有用。
捕获 diff 信息可用于通过实际源代码差异丰富报告内容。这些信息可用于提供关于如何修复测试的智能建议。

备注

这些设置的默认值取决于环境。当测试作为 CI 的一部分运行时（此时获取 git 信息是安全的），默认值为 true，否则为 false。

备注

git 提交元数据的结构可能会发生变化。

expect

添加于: v1.10

testConfig.expect

expect 断言库的配置。了解更多关于各种超时设置。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  expect: {
    timeout: 10000,
    toMatchSnapshot: {
      maxDiffPixels: 10,
    },
  },
});

类型

Object
- timeout number (可选)
  
  异步 expect 匹配器的默认超时时间（毫秒），默认为 5000ms。
- toHaveScreenshot Object (可选)
  - animations "allow" | "disabled" (可选)
    
    参见 page.screenshot() 中的 animations。默认为 "disabled"。
  - caret "hide" | "initial" (可选)
    
    参见 page.screenshot() 中的 caret。默认为 "hide"。
  - maxDiffPixels number (可选)
    
    允许的不同像素数量，默认未设置。
  - maxDiffPixelRatio number (可选)
    
    允许的不同像素与总像素的比率，范围在 0 到 1 之间，默认未设置。
  - scale "css" | "device" (可选)
    
    参见 page.screenshot() 中的 scale。默认为 "css"。
  - stylePath string | Array<string> (可选)
    
    参见 page.screenshot() 中的 style。
  - threshold number (可选)
    
    比较图像中相同像素的可接受感知色差，范围从 0（严格）到 1（宽松）。"pixelmatch" 比较器在 YIQ 色彩空间中计算色差，默认 threshold 值为 0.2。
  - pathTemplate string (可选)
    
    控制截图位置的模板。详情参见 testConfig.snapshotPathTemplate。
  expect(page).toHaveScreenshot() 方法的配置。
- toMatchAriaSnapshot Object (可选)
  - pathTemplate string (可选)
    
    控制 ARIA 快照位置的模板。详情参见 testConfig.snapshotPathTemplate。
  expect(locator).toMatchAriaSnapshot() 方法的配置。
- toMatchSnapshot Object (可选)
  - maxDiffPixels number (可选)
    
    允许的不同像素数量，默认未设置。
  - maxDiffPixelRatio number (可选)
    
    允许的不同像素与总像素的比率，范围在 0 到 1 之间，默认未设置。
  - threshold number (可选)
    
    比较图像中相同像素的可接受感知色差，范围从 0（严格）到 1（宽松）。"pixelmatch" 比较器在 YIQ 色彩空间中计算色差，默认 threshold 值为 0.2。
  expect(value).toMatchSnapshot() 方法的配置。
- toPass Object (可选)
  - intervals Array<number> (可选)
    
    toPass 方法的探测间隔时间（毫秒）。
  - timeout number (可选)
    
    toPass 方法的超时时间（毫秒）。
  expect(value).toPass() 方法的配置。

failOnFlakyTests

Added in: v1.52

testConfig.failOnFlakyTests

如果任何测试被标记为不稳定测试时是否报错退出。在 CI 环境中特别有用。

也可以通过命令行选项 --fail-on-flaky-tests 使用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  failOnFlakyTests: !!process.env.CI,
});

类型

boolean

forbidOnly

Added in: v1.10

testConfig.forbidOnly

如果任何测试或测试组被标记为 test.only() 或 test.describe.only() 时是否报错退出。在 CI 环境中特别有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  forbidOnly: !!process.env.CI,
});

类型

boolean

fullyParallel

Added in: v1.20

testConfig.fullyParallel

Playwright Test 默认以并行方式运行测试。为了实现这一点，它会同时运行多个工作进程。默认情况下，测试文件是并行运行的。单个文件中的测试会按顺序在同一个工作进程中运行。

您可以使用此选项配置整个测试运行，以并发执行所有文件中的所有测试。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  fullyParallel: true,
});

类型

boolean

globalSetup

Added in: v1.10

testConfig.globalSetup

全局设置文件的路径。该文件会在所有测试运行前被加载和执行。它必须导出一个接收 FullConfig 参数的函数。可以通过传递路径数组来指定多个全局设置文件。

了解更多关于全局设置和清理的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalSetup: './global-setup',
});

类型

string | Array<string>

globalTeardown

Added in: v1.10

testConfig.globalTeardown

全局清理文件的路径。该文件会在所有测试运行后被加载和执行。它必须导出一个函数。另请参阅 testConfig.globalSetup。可以通过传递路径数组来指定多个全局清理文件。

了解更多关于全局设置和清理的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalTeardown: './global-teardown',
});

类型

string | Array<string>

globalTimeout

Added in: v1.10

testConfig.globalTimeout

整个测试套件运行的最大时间（毫秒）。零超时（默认值）表示禁用此功能。在 CI 环境中特别有用，可以防止因配置错误导致运行时间过长而浪费资源。了解更多关于各种超时设置的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalTimeout: process.env.CI ? 60 * 60 * 1000 : undefined,
});

类型

number

grep

Added in: v1.10

testConfig.grep

筛选器，仅运行标题匹配指定模式的测试。例如，传递 grep: /cart/ 将只运行标题包含 "cart" 的测试。也可以通过命令行使用 -g 选项实现。正则表达式将针对由项目名称、测试文件名、test.describe 名称（如果有）、测试名称和测试标签组成的字符串进行匹配，这些内容用空格分隔，例如 chromium my-test.spec.ts my-suite my-test。

grep 选项也适用于测试标签。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  grep: /smoke/,
});

类型

RegExp | Array<RegExp>

grepInvert

Added in: v1.10

testConfig.grepInvert

筛选仅运行不匹配指定模式的测试标题。这是 testConfig.grep 的反向操作。也可通过命令行的 --grep-invert 选项使用。

grepInvert 选项也适用于测试标签。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  grepInvert: /manual/,
});

类型

RegExp | Array<RegExp>

ignoreSnapshots

Added in: v1.26

testConfig.ignoreSnapshots

是否跳过快照断言，例如 expect(value).toMatchSnapshot() 和 await expect(page).toHaveScreenshot()。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  ignoreSnapshots: !process.env.CI,
});

类型

boolean

maxFailures

Added in: v1.10

testConfig.maxFailures

整个测试套件运行的最大失败次数。达到此数量后，测试将停止并报错退出。设置为零（默认值）可禁用此行为。

也可通过命令行的 --max-failures 和 -x 选项使用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  maxFailures: process.env.CI ? 1 : 0,
});

类型

number

metadata

Added in: v1.10

testConfig.metadata

元数据包含要包含在报告中的键值对。例如，HTML 报告会将其显示为键值对，而 JSON 报告会包含序列化为 json 的元数据。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  metadata: { title: '验收测试' },
});

类型

Metadata

name

Added in: v1.10

testConfig.name

配置名称会在报告和测试执行期间显示，除非被 testProject.name 覆盖。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  name: '验收测试',
});

类型

string

outputDir

Added in: v1.10

testConfig.outputDir

测试执行期间生成文件的输出目录。默认为 <package.json所在目录>/test-results。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  outputDir: './test-results',
});

类型

string

详细说明

该目录会在测试开始时被清空。运行测试时，会在 testConfig.outputDir 下创建一个唯一的子目录，确保并行运行的测试不会产生冲突。可以通过 testInfo.outputDir 和 testInfo.outputPath() 访问此目录。

以下示例展示了如何使用 testInfo.outputPath() 创建临时文件。

import { test, expect } from '@playwright/test';
import fs from 'fs';

test('示例测试', async ({}, testInfo) => {
  const file = testInfo.outputPath('temporary-file.txt');
  await fs.promises.writeFile(file, '向文件写入一些数据', 'utf8');
});

preserveOutput

Added in: v1.10

testConfig.preserveOutput

是否保留 testConfig.outputDir 中的测试输出。默认为 'always'。

'always' - 保留所有测试的输出；
'never' - 不保留任何测试的输出；
'failures-only' - 仅保留失败测试的输出。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  preserveOutput: 'always',
});

类型

"always" | "never" | "failures-only"

projects

Added in: v1.10

testConfig.projects

Playwright Test 支持同时运行多个测试项目。更多信息请参阅 TestProject。

用法

playwright.config.ts
import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  projects: [
    { name: 'chromium', use: devices['Desktop Chrome'] }
  ]
});

类型

Array<TestProject>

quiet

Added in: v1.10

testConfig.quiet

是否抑制测试的标准输出和标准错误输出。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  quiet: !!process.env.CI,
});

类型

boolean

repeatEach

Added in: v1.10

testConfig.repeatEach

每个测试重复执行的次数，对于调试不稳定的测试很有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  repeatEach: 3,
});

类型

number

reportSlowTests

Added in: v1.10

testConfig.reportSlowTests

是否报告执行缓慢的测试文件。传入 null 可禁用此功能。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reportSlowTests: null,
});

类型

null | Object
- max number
  
  要报告的最大慢速测试文件数量。默认为 5。
- threshold number
  
  被视为慢速测试的阈值（毫秒）。默认为 5 分钟。

详情

执行时间超过 threshold 毫秒的测试文件会被视为慢速测试，系统会报告最慢的测试文件，但不超过 max 指定的数量。如果将 max 设为 0，则会报告所有超过阈值的测试文件。

reporter

Added in: v1.10

testConfig.reporter

要使用的报告器列表。每个报告器可以是：

内置报告器名称，如 'list' 或 'json'
模块名称，如 'my-awesome-reporter'
报告器的相对路径，如 './reporters/my-awesome-reporter.js'

可以通过元组形式向报告器传递选项，例如 ['json', { outputFile: './report.json' }]。

更多信息请参阅报告器指南。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'line',
});

类型

string | Array<Object> | "list" | "dot" | "line" | "github" | "json" | "junit" | "null" | "html"
- 0 string
  
  报告器名称、模块或文件路径
- 1 Object
  
  包含报告器选项的对象（如果有）

respectGitIgnore

Added in: v1.45

testConfig.respectGitIgnore

在搜索测试文件时是否跳过 .gitignore 中的条目。默认情况下，如果既未明确指定 testConfig.testDir 也未指定 testProject.testDir，Playwright 会忽略所有匹配 .gitignore 条目的测试文件。

用法

testConfig.respectGitIgnore

类型

boolean

retries

Added in: v1.10

testConfig.retries

为失败测试提供的最大重试次数。默认情况下失败的测试不会重试。了解更多关于测试重试的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  retries: 2,
});

类型

number

shard

Added in: v1.10

testConfig.shard

分片测试并仅执行选定的分片。以基于1的形式指定，如 { total: 5, current: 2 }。

了解更多关于 Playwright Test 的并行和分片功能。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  shard: { total: 10, current: 3 },
});

类型

null | Object
- current number
  
  要执行的分片索引（基于1）
- total number
  
  总分片数

snapshotPathTemplate

v1.28 版本新增

testConfig.snapshotPathTemplate

此选项用于配置一个模板，控制由 expect(page).toHaveScreenshot()、expect(locator).toMatchAriaSnapshot() 和 expect(value).toMatchSnapshot() 生成的快照文件位置。

您可以在 testConfig.expect 中为每个断言单独配置模板。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests',

  // 所有断言共用的单一模板
  snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}',

  // 断言专用的模板
  expect: {
    toHaveScreenshot: {
      pathTemplate: '{testDir}/__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
    },
    toMatchAriaSnapshot: {
      pathTemplate: '{testDir}/__snapshots__/{testFilePath}/{arg}{ext}',
    },
  },
});

类型

string

详情

该值可能包含一些"令牌"，这些令牌会在测试执行时被替换为实际值。

考虑以下文件结构：

playwright.config.ts
tests/
└── page/
    └── page-click.spec.ts

以及以下使用 toHaveScreenshot() 调用的 page-click.spec.ts 文件：

page-click.spec.ts
import { test, expect } from '@playwright/test';

test.describe('suite', () => {
  test('test should work', async ({ page }) => {
    await expect(page).toHaveScreenshot(['foo', 'bar', 'baz.png']);
  });
});

支持的令牌列表：

{arg} - 不带扩展名的相对快照路径。这来自传递给 toHaveScreenshot()、toMatchAriaSnapshot() 或 toMatchSnapshot() 的参数；如果调用时没有参数，这将是一个自动生成的快照名称。
- 值：foo/bar/baz
{ext} - 快照文件扩展名（带前导点）。
- 值：.png
{platform} - process.platform 的值。
{projectName} - 项目的文件系统安全名称（如果有）。
- 值：''（空字符串）。
{snapshotDir} - 项目的 testProject.snapshotDir。
- 值：/home/playwright/tests（由于配置中未提供 snapshotDir，默认为 testDir）
{testDir} - 项目的 testProject.testDir。
- 值：/home/playwright/tests（绝对路径，因为 testDir 是相对于配置目录解析的）
{testFileDir} - 从 testDir 到测试文件的相对路径中的目录。
- 值：page
{testFileName} - 带扩展名的测试文件名。
- 值：page-click.spec.ts
{testFilePath} - 从 testDir 到测试文件的相对路径。
- 值：page/page-click.spec.ts
{testName} - 文件系统安全的测试标题，包括父级描述但不包括文件名。
- 值：suite-test-should-work

每个令牌前面可以加一个字符，该字符仅当此令牌具有非空值时才会使用。

考虑以下配置：

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  snapshotPathTemplate: '__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
  testMatch: 'example.spec.ts',
  projects: [
    { use: { browserName: 'firefox' } },
    { name: 'chromium', use: { browserName: 'chromium' } },
  ],
});

在此配置中：

第一个项目没有名称，因此其快照将存储在 <configDir>/__screenshots__/example.spec.ts/...。
第二个项目有名称，因此其快照将存储在 <configDir>/__screenshots__/chromium/example.spec.ts/..。
由于 snapshotPathTemplate 解析为相对路径，它将相对于 configDir 解析。
正斜杠 "/" 可以在任何平台上用作路径分隔符。

testDir

Added in: v1.10

testConfig.testDir

递归扫描测试文件的目录。默认为配置文件所在目录。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests/playwright',
});

类型

string

testIgnore

Added in: v1.10

testConfig.testIgnore

匹配这些模式的文件不会作为测试文件执行。匹配基于文件的绝对路径。字符串被视为 glob 模式。

例如，'**/test-assets/**' 会忽略 test-assets 目录中的所有文件。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testIgnore: '**/test-assets/**',
});

类型

string | RegExp | Array<string | RegExp>

testMatch

Added in: v1.10

testConfig.testMatch

只有匹配这些模式的文件才会作为测试文件执行。匹配基于文件的绝对路径。字符串被视为 glob 模式。

默认情况下，Playwright 会查找匹配以下 glob 模式的文件：**/*.@(spec|test).?(c|m)[jt]s?(x)。这意味着带有 ".test" 或 ".spec" 后缀的 JavaScript 或 TypeScript 文件，例如 login-screen.wrong-credentials.spec.ts。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testMatch: /.*\.e2e\.js/,
});

类型

string | RegExp | Array<string | RegExp>

timeout

Added in: v1.10

testConfig.timeout

每个测试的超时时间（毫秒）。默认为 30 秒。

这是所有测试的基础超时时间。此外，每个测试可以通过 test.setTimeout() 配置自己的超时时间。了解更多关于各种超时设置的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  timeout: 5 * 60 * 1000,
});

类型

number

tsconfig

Added in: v1.49

testConfig.tsconfig

适用于所有导入文件的单一 tsconfig 路径。默认情况下，会为每个导入文件单独查找 tsconfig。请注意，当配置文件或其任何依赖项被加载时，tsconfig 属性不会生效。当指定了 --tsconfig 命令行选项时会被忽略。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  tsconfig: './tsconfig.test.json',
});

类型

string

updateSnapshots

Added in: v1.10

testConfig.updateSnapshots

是否使用测试运行产生的实际结果更新预期快照。默认为 'missing'。

'all' - 所有执行的测试都会更新快照。
'changed' - 所有执行的测试会更新不匹配的快照。匹配的快照不会被更新。
'missing' - 创建缺失的快照，例如在编写新测试并首次运行时。这是默认值。
'none' - 不更新任何快照。

了解更多关于快照的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  updateSnapshots: 'missing',
});

类型

"all" | "changed" | "missing" | "none"

updateSourceMethod

Added in: v1.50

testConfig.updateSourceMethod

定义如何在源代码中更新快照。

'patch' - 创建一个统一的 diff 文件，可用于后续更新源代码。这是默认值。
'3way' - 在源代码中生成合并冲突标记。这允许用户手动选择相关变更，就像在 IDE 中解决合并冲突一样。
'overwrite' - 用新的快照值直接覆盖源代码。

用法

testConfig.updateSourceMethod

类型

"overwrite" | "3way" | "patch"

use

添加于: v1.10

testConfig.use

为所有测试设置的全局选项，例如 testOptions.browserName。了解更多关于配置的信息，并查看可用选项。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    browserName: 'chromium',
  },
});

类型

TestOptions

webServer

添加于: v1.10

testConfig.webServer

在测试期间启动开发 web 服务器（或多个服务器）。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  webServer: {
    command: 'npm run start',
    url: 'http://localhost:3000',
    timeout: 120 * 1000,
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'http://localhost:3000/',
  },
});

现在可以在导航页面时使用相对路径：

test.spec.ts
import { test } from '@playwright/test';

test('test', async ({ page }) => {
  // 这将指向 http://localhost:3000/foo
  await page.goto('/foo');
});

可以启动多个 web 服务器（或后台进程）：

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  webServer: [
    {
      command: 'npm run start',
      url: 'http://localhost:3000',
      name: 'Frontend',
      timeout: 120 * 1000,
      reuseExistingServer: !process.env.CI,
    },
    {
      command: 'npm run backend',
      url: 'http://localhost:3333',
      name: 'Backend',
      timeout: 120 * 1000,
      reuseExistingServer: !process.env.CI,
    }
  ],
  use: {
    baseURL: 'http://localhost:3000',
  },
});

类型

Object | Array<Object>
- command string
  
  启动命令。例如 npm run start。
- cwd string (可选)
  
  生成进程的工作目录，默认为配置文件所在目录。
- env Object<string, string> (可选)
  
  为命令设置的环境变量，默认为 process.env。
- gracefulShutdown Object (可选)
  - signal "SIGINT" | "SIGTERM"
  - timeout number
  如何关闭进程。如果未指定，则强制使用 SIGKILL 终止进程组。如果设置为 { signal: 'SIGTERM', timeout: 500 }，会先向进程组发送 SIGTERM 信号，如果 500 毫秒内未退出则发送 SIGKILL。也可以使用 SIGINT 作为信号。0 超时表示不会发送 SIGKILL。Windows 不支持 SIGTERM 和 SIGINT 信号，因此在 Windows 上此选项会被忽略。注意关闭 Docker 容器需要使用 SIGTERM。
- ignoreHTTPSErrors boolean (可选)
  
  获取 url 时是否忽略 HTTPS 错误。默认为 false。
- name string (可选)
  
  为 web 服务器指定自定义名称。此名称将作为日志消息的前缀。默认为 [WebServer]。
- port number (可选)
  
  HTTP 服务器监听的端口。会等待直到端口可连接。必须指定 port 或 url 之一。
- reuseExistingServer boolean (可选)
  
  如果为 true，当 port 或 url 上有现有服务器时会复用。如果没有服务器运行，则会运行命令启动新服务器。如果为 false，当 port 或 url 上有进程监听时会抛出错误。通常应设置为 !process.env.CI 以便在本地运行测试时允许使用本地开发服务器。
- stderr "pipe" | "ignore" (可选)
  
  是否将命令的 stderr 输出到进程 stderr 或忽略。默认为 "pipe"。
- stdout "pipe" | "ignore" (可选)
  
  如果为 "pipe"，会将命令的 stdout 输出到进程 stdout。如果为 "ignore"，会忽略命令的 stdout。默认为 "ignore"。
- timeout number (可选)
  
  等待进程启动并可用时间（毫秒）。默认为 60000。
- url string (可选)
  
  服务器准备就绪时预期返回 2xx、3xx、400、401、402 或 403 状态码的 URL。重定向（3xx 状态码）会被跟踪并检查新位置。必须指定 port 或 url 之一。

详情

如果指定了端口，Playwright Test 会在运行测试前等待 127.0.0.1 或 ::1 上的端口可用。如果指定了 URL，Playwright Test 会等待该 URL 返回 2xx、3xx、400、401、402 或 403 状态码后再运行测试。

对于持续集成，可以使用 reuseExistingServer: !process.env.CI 选项，该选项在 CI 上不会复用现有服务器。要查看 stdout，可以设置环境变量 DEBUG=pw:webserver。

port（不包括 url）会作为 testOptions.baseURL 传递给 Playwright。例如端口 8080 会生成等于 http://localhost:8080 的 baseURL。如果 webServer 指定为数组，必须显式配置 baseURL（即使只有一个条目）。

备注

建议同时在配置中指定 testOptions.baseURL，以便测试可以使用相对 URL。

workers

Added in: v1.10

testConfig.workers

用于并行化测试的最大并发工作进程数。也可以设置为逻辑 CPU 核心数的百分比，例如 '50%'。

Playwright Test 使用工作进程来运行测试。始终至少有一个工作进程，但可以使用更多来加速测试执行。

默认为逻辑 CPU 核心数的一半。了解更多关于并行化和分片的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  workers: 3,
});

类型

number | string

已弃用

snapshotDir

Added in: v1.10

testConfig.snapshotDir

不推荐使用

请使用 testConfig.snapshotPathTemplate 来配置快照路径。

用于存放 toMatchSnapshot 创建的快照文件的基础目录，相对于配置文件。默认为 testConfig.testDir。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  snapshotDir: './snapshots',
});

类型

string

详细信息

每个测试的目录可以通过 testInfo.snapshotDir 和 testInfo.snapshotPath() 访问。

此路径将作为每个测试文件快照目录的基础目录。如果将 snapshotDir 设置为 'snapshots'，则 testInfo.snapshotDir 将解析为 snapshots/a.spec.js-snapshots。

属性​

build​

captureGitInfo​

expect​

failOnFlakyTests​

forbidOnly​

fullyParallel​

globalSetup​

globalTeardown​

globalTimeout​

grep​

grepInvert​

ignoreSnapshots​

maxFailures​

metadata​

name​

outputDir​

preserveOutput​

projects​

quiet​

repeatEach​

reportSlowTests​

reporter​

respectGitIgnore​

retries​

shard​

snapshotPathTemplate​

testDir​

testIgnore​

testMatch​

timeout​

tsconfig​

updateSnapshots​

updateSourceMethod​

use​

webServer​

workers​

已弃用​

snapshotDir​

属性

build

captureGitInfo

expect

failOnFlakyTests

forbidOnly

fullyParallel

globalSetup

globalTeardown

globalTimeout

grep

grepInvert

ignoreSnapshots

maxFailures

metadata

name

outputDir

preserveOutput

projects

quiet

repeatEach

reportSlowTests

reporter

respectGitIgnore

retries

shard

snapshotPathTemplate

testDir

testIgnore

testMatch

timeout

tsconfig

updateSnapshots

updateSourceMethod

use

webServer

workers

已弃用

snapshotDir