noPlaywrightWaitForSelector (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/nursery/noPlaywrightWaitForSelector
This rule has an unsafe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-wait-for-selector

How to configure

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

Description

Disallow using page.waitForSelector().

Playwright’s page.waitForSelector() is discouraged in favor of more reliable locator-based APIs. Using locators with assertions or actions automatically waits for elements to be ready.

Examples

Invalid

1
await page.waitForSelector('.submit-button');

code-block.js:1:7 lint/nursery/noPlaywrightWaitForSelector  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.waitForSelector().
  
  > 1 │ await page.waitForSelector('.submit-button');
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Locators automatically wait for elements to be ready, making explicit waits unnecessary.
  
  ℹ Use locator-based page.locator() or page.getByRole() APIs instead.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with locator(selector).waitFor().
  
    1   │ - await·page.waitForSelector('.submit-button');
      1 │ + await·page.locator('.submit-button').waitFor();
    2 2 │

1
await page.waitForSelector('#dialog', { state: 'visible' });
2
await page.click('#dialog .button');

code-block.js:1:7 lint/nursery/noPlaywrightWaitForSelector  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.waitForSelector().
  
  > 1 │ await page.waitForSelector('#dialog', { state: 'visible' });
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ await page.click('#dialog .button');
    3 │ 
  
  ℹ Locators automatically wait for elements to be ready, making explicit waits unnecessary.
  
  ℹ Use locator-based page.locator() or page.getByRole() APIs instead.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with locator(selector).waitFor().
  
    1   │ - await·page.waitForSelector('#dialog',·{·state:·'visible'·});
      1 │ + await·page.locator('#dialog').waitFor({·state:·'visible'·});
    2 2 │   await page.click('#dialog .button');
    3 3 │

Valid

1
await page.locator('.submit-button').click();

1
await expect(page.locator('#dialog')).toBeVisible();

1
const button = page.getByRole('button', { name: 'Submit' });
2
await button.click();