eslint-plugin-playwright

What is eslint-plugin-playwright?

eslint-plugin-playwright is an ESLint plugin that provides linting rules specific to Playwright, a Node.js library for browser automation. This plugin helps ensure best practices and code quality when writing tests with Playwright.

What are eslint-plugin-playwright's main functionalities?

No Page Pause

This rule disallows the use of `page.pause()` in your Playwright tests to prevent unintended pauses during test execution.

module.exports = {
  plugins: ['playwright'],
  rules: {
    'playwright/no-page-pause': 'error'
  }
};

No Element Handle

This rule discourages the use of `elementHandle` in favor of using locators, which are more robust and easier to work with.

module.exports = {
  plugins: ['playwright'],
  rules: {
    'playwright/no-element-handle': 'error'
  }
};

No Wait For Timeout

This rule prevents the use of `page.waitForTimeout()` to avoid flaky tests caused by arbitrary wait times.

module.exports = {
  plugins: ['playwright'],
  rules: {
    'playwright/no-wait-for-timeout': 'error'
  }
};

Other packages similar to eslint-plugin-playwright

eslint-plugin-jest

eslint-plugin-jest provides linting rules specific to Jest, a popular JavaScript testing framework. It helps enforce best practices and code quality in Jest tests. While eslint-plugin-playwright focuses on Playwright-specific rules, eslint-plugin-jest is tailored for Jest.

eslint-plugin-cypress

eslint-plugin-cypress offers linting rules for Cypress, another end-to-end testing framework. It ensures best practices and code quality in Cypress tests. Similar to eslint-plugin-playwright, but for Cypress instead of Playwright.

eslint-plugin-testing-library

eslint-plugin-testing-library provides linting rules for Testing Library, a set of utilities for testing UI components. It helps ensure best practices and code quality when using Testing Library. While eslint-plugin-playwright is for Playwright, this plugin is for Testing Library.

README

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"]
}

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.

✔	🔧	💡	Rule	Description
✔			expect-expect	Enforce assertion to be made in a test body
✔			max-nested-describe	Enforces a maximum depth to nested describe calls
✔	🔧		missing-playwright-await	Enforce Playwright APIs to be awaited
✔			no-conditional-in-test	Disallow conditional logic in tests
✔		💡	no-element-handle	Disallow usage of element handles
✔			no-eval	Disallow usage of page.$eval and page.$$eval
✔		💡	no-focused-test	Disallow usage of .only annotation
✔			no-force-option	Disallow usage of the { force: true } option
✔			no-nested-step	Disallow nested test.step() methods
✔			no-networkidle	Disallow usage of the networkidle option
			no-nth-methods	Disallow usage of first(), last(), and nth() methods
✔			no-page-pause	Disallow using page.pause
✔	🔧		no-useless-await	Disallow unnecessary awaits for Playwright methods
			no-restricted-matchers	Disallow specific matchers & modifiers
✔		💡	no-skipped-test	Disallow usage of the .skip annotation
✔	🔧		no-useless-not	Disallow usage of not matchers when a specific matcher exists
✔		💡	no-wait-for-timeout	Disallow usage of page.waitForTimeout
		💡	prefer-strict-equal	Suggest using toStrictEqual()
	🔧		prefer-lowercase-title	Enforce lowercase test names
	🔧		prefer-to-be	Suggest using toBe()
	🔧		prefer-to-contain	Suggest using toContain()
	🔧		prefer-to-have-length	Suggest using toHaveLength()
✔	🔧		prefer-web-first-assertions	Suggest using web first assertions
			require-top-level-describe	Require test cases and hooks to be inside a test.describe block
	🔧		require-soft-assertions	Require assertions to use expect.soft()
✔			valid-expect	Enforce valid expect() usage