Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
docs(test): complete reporter/trace unions and fix stale option descriptions (#42839)
Ashraf Alie17dffae701d
diff --git a/docs/src/emulation.md b/docs/src/emulation.mdindex 7c3ca37c34..7f7a9b5599 100644--- a/docs/src/emulation.md+++ b/docs/src/emulation.md@@ -586,7 +586,7 @@ await context.SetGeolocationAsync(new Geolocation() { Longitude = 48.858455, Lat**Note** you can only change geolocation for all pages in the context.## Color Scheme and Media-Emulate the users `"colorScheme"`. Supported values are 'light' and 'dark'. You can also emulate the media type with [`method: Page.emulateMedia`].+Emulate the users `"colorScheme"`. Supported values are 'light', 'dark', and 'no-preference'. You can also emulate the media type with [`method: Page.emulateMedia`].```js title="playwright.config.ts"import { defineConfig } from '@playwright/test';diff --git a/docs/src/test-api/class-fullconfig.md b/docs/src/test-api/class-fullconfig.mdindex 0e89fc9fb8..596cda945a 100644--- a/docs/src/test-api/class-fullconfig.md+++ b/docs/src/test-api/class-fullconfig.md@@ -107,7 +107,7 @@ See [`property: TestConfig.quiet`].## property: FullConfig.reporter* since: v1.10-- type: <[string]|[Array]<[Object]>|[BuiltInReporter]<"list"|"dot"|"line"|"github"|"json"|"junit"|"null"|"html"|"perfetto">>+- type: <[string]|[Array]<[Object]>|[BuiltInReporter]<"list"|"dot"|"line"|"github"|"json"|"junit"|"null"|"html"|"blob"|"perfetto">>- `0` <[string]> Reporter name or module or file path- `1` <[Object]> An object with reporter options if anydiff --git a/docs/src/test-api/class-testconfig.md b/docs/src/test-api/class-testconfig.mdindex d84e3e2ab3..53bb0b23d0 100644--- a/docs/src/test-api/class-testconfig.md+++ b/docs/src/test-api/class-testconfig.md@@ -449,7 +449,7 @@ export default defineConfig({## property: TestConfig.reporter* since: v1.10-- type: ?<[string]|[Array]<[Object]>|[BuiltInReporter]<"list"|"dot"|"line"|"github"|"json"|"junit"|"null"|"html"|"perfetto">>+- type: ?<[string]|[Array]<[Object]>|[BuiltInReporter]<"list"|"dot"|"line"|"github"|"json"|"junit"|"null"|"html"|"blob"|"perfetto">>- `0` <[string]> Reporter name or module or file path- `1` <[Object]> An object with reporter options if anydiff --git a/docs/src/test-api/class-testoptions.md b/docs/src/test-api/class-testoptions.mdindex ac587752dc..879fa62417 100644--- a/docs/src/test-api/class-testoptions.md+++ b/docs/src/test-api/class-testoptions.md@@ -686,7 +686,7 @@ export default defineConfig({## property: TestOptions.trace* since: v1.10-- type: <[Object]|[TraceMode]<"off"|"on"|"retain-on-failure"|"on-first-retry"|"retain-on-first-failure"|"retain-on-failure-and-retries">>+- type: <[Object]|[TraceMode]<"off"|"on"|"on-first-retry"|"on-all-retries"|"retain-on-failure"|"retain-on-first-failure"|"retain-on-failure-and-retries">>- `mode` <[TraceMode]<"off"|"on"|"retain-on-failure"|"on-first-retry"|"on-all-retries"|"retain-on-first-failure"|"retain-on-failure-and-retries">> Trace recording mode.- `attachments` ?<[boolean]> Whether to include test attachments. Defaults to true. Optional.- `screenshots` ?<[boolean]> Whether to capture screenshots during tracing. Screenshots are used to build a timeline preview. Defaults to true. Optional.diff --git a/docs/src/test-cli-js.md b/docs/src/test-cli-js.mdindex 0c9ab8942d..6c57c94ff2 100644--- a/docs/src/test-cli-js.md+++ b/docs/src/test-cli-js.md@@ -319,7 +319,7 @@ npx playwright merge-reports ./reports| Option | Description || :--- | :--- || `-c, --config <file>` | Configuration file. Can be used to specify additional configuration for the output report |-| `--reporter <reporter>` | Reporter to use, comma-separated, can be "list", "line", "dot", "json", "junit", "null", "github", "html", "blob" (default: "list" locally and "dot" on CI) |+| `--reporter <reporter>` | Reporter to use, comma-separated, can be "list", "line", "dot", "json", "junit", "null", "github", "html", "blob", "perfetto" (default: "list" locally and "dot" on CI) |### Clear Cachediff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.tsindex 7ef43b4815..ce07a47c6d 100644--- a/packages/playwright/types/test.d.ts+++ b/packages/playwright/types/test.d.ts@@ -959,7 +959,7 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {* ```**/- reporter?: LiteralUnion<'list'|'dot'|'line'|'github'|'json'|'junit'|'null'|'html'|'perfetto'|'coverage', string> | ReporterDescription[];+ reporter?: LiteralUnion<'list'|'dot'|'line'|'github'|'json'|'junit'|'null'|'html'|'blob'|'perfetto'|'coverage', string> | ReporterDescription[];/*** Global options for all tests, for example* [testOptions.browserName](https://playwright.dev/docs/api/class-testoptions#test-options-browser-name). Learn morediff --git a/utils/generate_types/overrides-test.d.ts b/utils/generate_types/overrides-test.d.tsindex e7f4627c6c..bb5105866a 100644--- a/utils/generate_types/overrides-test.d.ts+++ b/utils/generate_types/overrides-test.d.ts@@ -69,7 +69,7 @@ type LiteralUnion<T extends U, U = string> = T | (U & { zz_IGNORE_ME?: never });interface TestConfig<TestArgs = {}, WorkerArgs = {}> {projects?: Project<TestArgs, WorkerArgs>[];- reporter?: LiteralUnion<'list'|'dot'|'line'|'github'|'json'|'junit'|'null'|'html'|'perfetto'|'coverage', string> | ReporterDescription[];+ reporter?: LiteralUnion<'list'|'dot'|'line'|'github'|'json'|'junit'|'null'|'html'|'blob'|'perfetto'|'coverage', string> | ReporterDescription[];use?: UseOptions<TestArgs, WorkerArgs>;webServer?: TestConfigWebServer | TestConfigWebServer[];}