noPlaywrightMissingAwait

Este conteúdo não está disponível em sua língua ainda.

JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/nursery/noPlaywrightMissingAwait
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/missing-playwright-await

How to configure

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

Description

Enforce Playwright async APIs to be awaited or returned.

Playwright has asynchronous matchers and methods that must be properly awaited. This rule identifies common mistakes where async Playwright APIs are not properly handled, which can lead to false positives in tests.

Examples

Invalid

1
test('example', async ({ page }) => {
2
    expect(page.getByRole('button')).toBeVisible();
3
});

code-block.js:2:5 lint/nursery/noPlaywrightMissingAwait  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Async matcher toBeVisible must be awaited or returned.
  
    1 │ test(‘example’, async ({ page }) => {
  > 2 │     expect(page.getByRole(‘button’)).toBeVisible();
      │     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ });
    4 │ 
  
  ℹ Async matchers return a Promise that must be handled.
  
  ℹ Add await before the expression or return it from the function.
  
  ℹ 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: Add await before the call.
  
    2 │ ····await·expect(page.getByRole(‘button’)).toBeVisible();
      │     ++++++

1
test('example', async ({ page }) => {
2
    test.step('step', async () => {});
3
});

code-block.js:2:5 lint/nursery/noPlaywrightMissingAwait  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ test.step must be awaited or returned.
  
    1 │ test(‘example’, async ({ page }) => {
  > 2 │     test.step(‘step’, async () => {});
      │     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ });
    4 │ 
  
  ℹ Test steps are asynchronous.
  
  ℹ Add await before the expression or return it from the function.
  
  ℹ 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: Add await before the call.
  
    2 │ ····await·test.step(‘step’,·async·()·=>·{});
      │     ++++++

Valid

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

1
test('example', async ({ page }) => {
2
    await test.step('step', async () => {});
3
});

1
test('example', async ({ page }) => {
2
    return expect(page.getByRole('button')).toBeVisible();
3
});