ESLint Plugin Playwright

ESLint plugin for Playwright.

Installation

npm

npm install -D eslint-plugin-playwright

Yarn

yarn add -D eslint-plugin-playwright

pnpm

pnpm add -D eslint-plugin-playwright

Usage

This plugin bundles two configurations to work with both @playwright/test or jest-playwright.

With Playwright test runner

{
  "extends": ["plugin:playwright/recommended"]
}

With Jest Playwright

{
  "extends": ["plugin:playwright/jest-playwright"]
}

Global Settings

The plugin reads global settings from your ESLint configuration's shared data under the playwright key. It supports the following settings:

• additionalAssertFunctionNames: an array of function names to treat as assertion functions for the case of rules like expect-expect, which enforces the presence of at least one assertion per test case. This allows such rules to recognise custom assertion functions as valid assertions. The global setting applies to all modules. The expect-expect rule accepts an option by the same name to enable per-module configuration (.e.g, for module-specific custom assert functions).

You can configure these settings like so:

{
  "settings": {
    "playwright": {
      "additionalAssertFunctionNames": ["assertCustomCondition"]
    }
  }
}

List of Supported Rules

✔: Enabled in the recommended configuration.
🔧: Some problems reported by this rule are automatically fixable by the --fix command line option.
💡: Some problems reported by this rule are manually fixable by editor suggestions.