ESLint Plugin Playwright
ESLint plugin for your Playwright testing needs.
Installation
Yarn
yarn add -D eslint-plugin-playwright
NPM
npm install -D eslint-plugin-playwright
Usage
This plugin bundles two configurations to work with both @playwright/test
or jest-playwright
.
Playwright test runner
With{
"extends": ["plugin:playwright/playwright-test"]
}
Jest Playwright
With{
"extends": ["plugin:playwright/jest-playwright"]
}
Rules
missing-playwright-await
🔧
Identify false positives when async Playwright APIs are not properly awaited.
Example
Example of incorrect code for this rule:
expect(page).toMatchText("text");
test.step("clicks the button", async () => {
await page.click("button");
});
Example of correct code for this rule:
await expect(page).toMatchText("text");
await test.step("clicks the button", async () => {
await page.click("button");
});
Options
The rule accepts a non-required option which can be used to specify custom matchers which this rule should also warn about. This is useful when creating your own async expect
matchers.
{
"playwright/missing-playwright-await": [
"error",
{ "customMatchers": ["toBeCustomThing"] }
]
}