usePlaywrightValidDescribeCallback

Цей контент ще не доступний вашою мовою.

JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/nursery/usePlaywrightValidDescribeCallback
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/valid-describe-callback

How to configure

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

Description

Enforce valid describe() callback.

Using an improper describe() callback function can lead to unexpected test errors. This rule validates that describe callbacks are proper synchronous functions without parameters.

Examples

Invalid

1
test.describe('suite', async () => {
2
    test('one', async ({ page }) => {});
3
});

code-block.js:1:1 lint/nursery/usePlaywrightValidDescribeCallback ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Describe callback should not be async.
  
  > 1 │ test.describe(‘suite’, async () => {
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  > 2 │     test(‘one’, async ({ page }) => {});
  > 3 │ });
      │ ^^
    4 │ 
  
  ℹ Describe blocks are meant to organize tests, not contain asynchronous logic. Async operations should be placed within individual test callbacks.
  
  ℹ Remove the async keyword from the describe callback.
  
  ℹ 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.

1
test.describe('suite', (done) => {
2
    test('one', async ({ page }) => {});
3
});

code-block.js:1:1 lint/nursery/usePlaywrightValidDescribeCallback ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Describe callback should not have parameters.
  
  > 1 │ test.describe(‘suite’, (done) => {
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  > 2 │     test(‘one’, async ({ page }) => {});
  > 3 │ });
      │ ^^
    4 │ 
  
  ℹ Describe callbacks are invoked without arguments by the test framework.
  
  ℹ Remove parameters from the describe callback.
  
  ℹ 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.

Valid

1
test.describe('suite', () => {
2
    test('one', async ({ page }) => {});
3
    test('two', async ({ page }) => {});
4
});

1
describe('suite', function() {
2
    test('one', async ({ page }) => {});
3
});