noPlaywrightPagePause (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/suspicious/noPlaywrightPagePause
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-page-pause

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noPlaywrightPagePause": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow using page.pause().

Playwright’s page.pause() is a debugging utility that should not be committed to version control. It pauses test execution and opens the Playwright Inspector, which is useful during development but should not be present in production test code.

Examples

Invalid

1
await page.pause();

code-block.js:1:7 lint/suspicious/noPlaywrightPagePause ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of page.pause().
  
  > 1 │ await page.pause();
      │       ^^^^^^^^^^^^
    2 │ 
  
  ℹ page.pause() is a debugging utility and should not be committed to version control.
  
  ℹ Remove the pause() call or use a proper debugging strategy.

1
test('example', async ({ page }) => {
2
    await page.click('button');
3
    await page.pause();
4
});

code-block.js:3:11 lint/suspicious/noPlaywrightPagePause ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of page.pause().
  
    1 │ test('example', async ({ page }) => {
    2 │     await page.click('button');
  > 3 │     await page.pause();
      │           ^^^^^^^^^^^^
    4 │ });
    5 │ 
  
  ℹ page.pause() is a debugging utility and should not be committed to version control.
  
  ℹ Remove the pause() call or use a proper debugging strategy.

Valid

1
test('example', async ({ page }) => {
2
    await page.click('button');
3
    await expect(page.locator('.result')).toBeVisible();
4
});