noPlaywrightEval (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/style/noPlaywrightEval
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 information.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-eval

How to configure

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

Description

Disallow usage of page.$eval() and page.$$eval().

These methods are discouraged in favor of locator.evaluate() and locator.evaluateAll(). Locator-based evaluation is more reliable and follows Playwright’s recommended patterns.

Examples

Invalid

1
await page.$eval('.foo', el => el.textContent);

code-block.js:1:7 lint/style/noPlaywrightEval ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.$eval().
  
  > 1 │ await page.$eval('.foo', el => el.textContent);
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Locator-based evaluation is more reliable and follows Playwright's recommended patterns.
  
  ℹ Use locator.evaluate() instead.

1
const texts = await page.$$eval('.foo', els => els.map(el => el.textContent));

code-block.js:1:21 lint/style/noPlaywrightEval ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.$$eval().
  
  > 1 │ const texts = await page.$$eval('.foo', els => els.map(el => el.textContent));
      │                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Locator-based evaluation is more reliable and follows Playwright's recommended patterns.
  
  ℹ Use locator.evaluateAll() instead.

Valid

1
const text = await page.locator('.foo').evaluate(el => el.textContent);

1
const texts = await page.locator('.foo').evaluateAll(els => els.map(el => el.textContent));