kyfx
/
playwright
mirror of https://github.com/microsoft/playwright.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: address step.skip() API review comments (#34958)

This commit is contained in:
Yury Semikhatsky 2025-02-28 09:32:04 -08:00 committed by GitHub
parent e033e5aa11
commit 4a79c214f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/test-api/class-test.md
View File

@ -1771,7 +1771,7 @@ Specifies a custom location for the step to be shown in test reports and trace v
* since: v1.50
- returns: <[void]>
Mark a test step as "skip" to temporarily disable its execution, useful for steps that are currently failing and planned for a near-term fix. Playwright will not run the step.
Mark a test step as "skip" to temporarily disable its execution, useful for steps that are currently failing and planned for a near-term fix. Playwright will not run the step. See also [`method: TestStepInfo.skip#2`].
We recommend [`method: TestStepInfo.skip#1`] instead.

4
docs/src/test-api/class-teststepinfo.md
View File

@ -7,7 +7,7 @@
```js
import { test, expect } from '@playwright/test';
test('basic test', async ({ page, browserName }, TestStepInfo) => {
test('basic test', async ({ page, browserName }) => {
await test.step('check some behavior', async step => {
await step.skip(browserName === 'webkit', 'The feature is not available in WebKit');
// ... rest of the step code
@ -102,7 +102,7 @@ test('my test', async ({ page }) => {
## method: TestStepInfo.skip#2
* since: v1.51
Conditionally skip the currently running step with an optional description. Useful for steps that should not be executed in some cases.
Conditionally abort the currently running step and mark it as skipped with an optional description. Useful for steps that should not be executed in some cases.
**Usage**

13
packages/playwright/types/test.d.ts vendored
View File

@ -962,9 +962,9 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
/**
* - These settings control whether git information is captured and stored in the config
* [testConfig.metadata](https://playwright.dev/docs/api/class-testconfig#test-config-metadata).
* - The structure of the git commit metadata is not documented and is a subject to change.
* - The structure of the git commit metadata is subject to change.
* - Default values for these settings depend on the environment. When tests run as a part of CI where it is safe to
* obtain git information, the default value is true, false otherise.
* obtain git information, the default value is true, false otherwise.
*
* **Usage**
*
@ -5824,7 +5824,8 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
<T>(title: string, body: (step: TestStepInfo) => T | Promise<T>, options?: { box?: boolean, location?: Location, timeout?: number }): Promise<T>;
/**
* Mark a test step as "skip" to temporarily disable its execution, useful for steps that are currently failing and
* planned for a near-term fix. Playwright will not run the step.
* planned for a near-term fix. Playwright will not run the step. See also
* [testStepInfo.skip(condition[, description])](https://playwright.dev/docs/api/class-teststepinfo#test-step-info-skip-2).
*
* We recommend [testStepInfo.skip()](https://playwright.dev/docs/api/class-teststepinfo#test-step-info-skip-1)
* instead.
@ -9587,7 +9588,7 @@ export interface TestInfoError {
* ```js
* import { test, expect } from '@playwright/test';
*
* test('basic test', async ({ page, browserName }, TestStepInfo) => {
* test('basic test', async ({ page, browserName }) => {
* await test.step('check some behavior', async step => {
* await step.skip(browserName === 'webkit', 'The feature is not available in WebKit');
* // ... rest of the step code
@ -9686,8 +9687,8 @@ export interface TestStepInfo {
skip(): void;
/**
* Conditionally skip the currently running step with an optional description. Useful for steps that should not be
* executed in some cases.
* Conditionally abort the currently running step and mark it as skipped with an optional description. Useful for
* steps that should not be executed in some cases.
*
* **Usage**
*