eslint-plugin-playwright 2.6.1 → 2.7.1

package/README.md

@@ -1,6 +1,6 @@
 # ESLint Plugin Playwright
 
-[![Test](https://github.com/mskelton/eslint-plugin-playwright/actions/workflows/test.yml/badge.svg)](https://github.com/mskelton/eslint-plugin-playwright/actions/workflows/test.yml)
+[![CI](https://github.com/mskelton/eslint-plugin-playwright/actions/workflows/ci.yml/badge.svg)](https://github.com/mskelton/eslint-plugin-playwright/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/eslint-plugin-playwright)](https://www.npmjs.com/package/eslint-plugin-playwright)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 

package/dist/index.cjs

@@ -202,7 +202,6 @@ var findTopMostCallExpression = (node) => {
   while (parent) {
     if (parent.type === "CallExpression" && parent.callee === child) {
       top = parent;
-      node = parent;
       parent = parent.parent;
       continue;
     }
@@ -425,8 +424,11 @@ function createRule(rule) {
         cwd: context.cwd,
         filename: context.filename,
         id: context.id,
+        languageOptions: context.languageOptions,
         options: context.options,
+        // @ts-expect-error - Legacy context property
         parserOptions: context.parserOptions,
+        // @ts-expect-error - Legacy context property
         parserPath: context.parserPath,
         physicalFilename: context.physicalFilename,
         report,
@@ -634,7 +636,6 @@ var expect_expect_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Enforce assertion to be made in a test body",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/expect-expect.md"
@@ -703,7 +704,6 @@ var max_expects_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Enforces a maximum number assertion calls in a test body",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/max-expects.md"
@@ -758,7 +758,6 @@ var max_nested_describe_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Enforces a maximum depth to nested describe calls",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/max-nested-describe.md"
@@ -879,6 +878,9 @@ var missing_playwright_await_default = createRule({
       if (visited.has(parent)) return false;
       visited.add(parent);
       if (validTypes.has(parent.type)) return true;
+      if (parent.type === "MemberExpression" && isIdentifier(parent.property, /^(then|catch|finally)$/) && parent.parent?.type === "CallExpression") {
+        return checkValidity(parent.parent, visited);
+      }
       if (parent.type === "ArrayExpression") {
         return checkValidity(parent, visited);
       }
@@ -926,7 +928,6 @@ var missing_playwright_await_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: `Identify false positives when async Playwright APIs are not properly awaited.`,
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/missing-playwright-await.md"
@@ -983,7 +984,6 @@ var no_commented_out_tests_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow commented out tests",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-commented-out-tests.md"
@@ -1070,7 +1070,6 @@ var no_conditional_expect_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow calling `expect` conditionally",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-conditional-expect.md"
@@ -1113,7 +1112,6 @@ var no_conditional_in_test_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow conditional logic in tests",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-conditional-in-test.md"
@@ -1161,7 +1159,6 @@ var no_duplicate_hooks_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow duplicate setup and teardown hooks",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-duplicate-hooks.md"
@@ -1205,7 +1202,6 @@ var no_duplicate_slow_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow multiple `test.slow()` calls in the same test",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-duplicate-slow.md"
@@ -1249,7 +1245,6 @@ var no_element_handle_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "The use of ElementHandle is discouraged, use Locator instead",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-element-handle.md"
@@ -1281,7 +1276,6 @@ var no_eval_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "The use of `page.$eval` and `page.$$eval` are discouraged, use `locator.evaluate` or `locator.evaluateAll` instead",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-eval.md"
@@ -1325,7 +1319,6 @@ var no_focused_test_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Prevent usage of `.only()` focus test annotation",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-focused-test.md"
@@ -1374,7 +1367,6 @@ var no_force_option_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prevent usage of `{ force: true }` option.",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-force-option.md"
@@ -1399,7 +1391,6 @@ var no_get_by_title_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallows the usage of getByTitle()",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-get-by-title.md"
@@ -1434,7 +1425,6 @@ var no_hooks_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow setup and teardown hooks",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-hooks.md"
@@ -1490,7 +1480,6 @@ var no_nested_step_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow nested `test.step()` methods",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-nested-step.md"
@@ -1541,7 +1530,6 @@ var no_networkidle_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Prevent usage of the networkidle option",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-networkidle.md"
@@ -1575,7 +1563,6 @@ var no_nth_methods_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow usage of nth methods",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-nth-methods.md"
@@ -1600,7 +1587,6 @@ var no_page_pause_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Prevent usage of page.pause()",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-page-pause.md"
@@ -1641,7 +1627,6 @@ var no_raw_locators_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallows the usage of raw locators",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-raw-locators.md"
@@ -1705,7 +1690,6 @@ var no_restricted_locators_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallows the usage of specific locator methods",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-locators.md"
@@ -1774,7 +1758,6 @@ var no_restricted_matchers_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow specific matchers & modifiers",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-matchers.md"
@@ -1834,7 +1817,6 @@ var no_restricted_roles_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallows the usage of specific roles in getByRole()",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-roles.md"
@@ -1903,7 +1885,6 @@ var no_skipped_test_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prevent usage of the `.skip()` skip test annotation.",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-skipped-test.md"
@@ -1966,7 +1947,6 @@ var no_slowed_test_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prevent usage of the `.slow()` slow test annotation.",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-slowed-test.md"
@@ -2074,7 +2054,6 @@ var no_standalone_expect_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Disallow using `expect` outside of `test` blocks",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-standalone-expect.md"
@@ -2165,7 +2144,6 @@ var no_unsafe_references_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Prevent unsafe variable references in page.evaluate() and page.addInitScript()",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-unsafe-references.md"
@@ -2195,7 +2173,6 @@ var no_unused_locators_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: `Disallow usage of page locators that are not used`,
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-unused-locators.md"
@@ -2303,7 +2280,6 @@ var no_useless_await_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Disallow unnecessary awaits for Playwright methods",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md"
@@ -2399,7 +2375,6 @@ var no_useless_not_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: `Disallow usage of 'not' matchers when a more specific matcher exists`,
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-useless-not.md"
@@ -2438,7 +2413,6 @@ var no_wait_for_navigation_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Prevent usage of page.waitForNavigation()",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-navigation.md"
@@ -2476,7 +2450,6 @@ var no_wait_for_selector_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prevent usage of page.waitForSelector()",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-selector.md"
@@ -2514,7 +2487,6 @@ var no_wait_for_timeout_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prevent usage of page.waitForTimeout()",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-timeout.md"
@@ -2598,7 +2570,6 @@ var prefer_comparison_matcher_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using the built-in comparison matchers",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparison-matcher.md"
@@ -2660,7 +2631,6 @@ var prefer_equality_matcher_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using the built-in equality matchers",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-equality-matcher.md"
@@ -2716,7 +2686,6 @@ var prefer_hooks_in_order_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prefer having hooks in a consistent order",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-in-order.md"
@@ -2749,7 +2718,6 @@ var prefer_hooks_on_top_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest having hooks before any test cases",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-on-top.md"
@@ -2806,7 +2774,6 @@ var prefer_locator_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest locators over page methods",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-locator.md"
@@ -2874,7 +2841,6 @@ var prefer_lowercase_title_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Enforce lowercase test names",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-lowercase-title.md"
@@ -2984,7 +2950,6 @@ var prefer_native_locators_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prefer native locator functions",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-native-locators.md"
@@ -3040,7 +3005,6 @@ var prefer_strict_equal_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using `toStrictEqual()`",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-strict-equal.md"
@@ -3122,7 +3086,6 @@ var prefer_to_be_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using `toBe()` for primitive literals",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-be.md"
@@ -3187,7 +3150,6 @@ var prefer_to_contain_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using toContain()",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-contain.md"
@@ -3237,7 +3199,6 @@ var prefer_to_have_count_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using `toHaveCount()`",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-count.md"
@@ -3281,7 +3242,6 @@ var prefer_to_have_length_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Suggest using `toHaveLength()`",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-length.md"
@@ -3422,7 +3382,6 @@ var prefer_web_first_assertions_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Prefer web first assertions",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-web-first-assertions.md"
@@ -3489,7 +3448,6 @@ var require_hook_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require setup and teardown code to be within a hook",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-hook.md"
@@ -3598,7 +3556,6 @@ var require_tags_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require test blocks to have tags",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-tags.md"
@@ -3642,7 +3599,6 @@ var require_to_pass_timeout_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require a timeout option for `toPass()`",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-to-pass-timeout.md"
@@ -3674,7 +3630,6 @@ var require_to_throw_message_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require a message for `toThrow()`",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-to-throw-message.md"
@@ -3729,7 +3684,6 @@ var require_top_level_describe_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require test cases and hooks to be inside a `test.describe` block",
       recommended: false,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-top-level-describe.md"
@@ -3825,7 +3779,6 @@ var valid_describe_callback_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Enforce valid `describe()` callback",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-describe-callback.md"
@@ -4066,7 +4019,6 @@ var valid_expect_in_promise_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Require promises that have expectations in their chain to be valid",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-expect-in-promise.md"
@@ -4173,7 +4125,6 @@ var valid_expect_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Enforce valid `expect()` usage",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-expect.md"
@@ -4306,7 +4257,6 @@ var valid_test_tags_default = createRule({
   },
   meta: {
     docs: {
-      category: "Possible Errors",
       description: "Enforce valid tag format in Playwright test blocks and titles",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-test-tags.md"
@@ -4508,7 +4458,6 @@ var valid_title_default = createRule({
   },
   meta: {
     docs: {
-      category: "Best Practices",
       description: "Enforce valid titles",
       recommended: true,
       url: "https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-title.md"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-playwright",
-  "version": "2.6.1",
+  "version": "2.7.1",
   "description": "ESLint plugin for Playwright testing.",
   "license": "MIT",
   "author": "Mark Skelton <mark@mskelton.dev>",
@@ -31,7 +31,7 @@
     "lint": "eslint .",
     "format": "oxfmt .",
     "format:check": "oxfmt --check .",
-    "test": "vitest --hideSkippedTests",
+    "test": "vitest --reporter dot --hideSkippedTests",
     "typecheck": "tsc --noEmit",
     "ci": "yarn format:check && yarn lint && yarn typecheck"
   },
@@ -39,16 +39,19 @@
     "globals": "^17.3.0"
   },
   "devDependencies": {
-    "@mskelton/eslint-config": "^9.3.0",
+    "@eslint/js": "^10.0.1",
     "@types/estree": "^1.0.8",
     "@types/node": "^25.2.3",
     "@typescript-eslint/parser": "^8.56.0",
     "dedent": "^1.7.1",
-    "eslint": "^9.13.0",
+    "eslint": "^10.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-sort": "^4.0.0",
     "oxfmt": "^0.33.0",
     "semantic-release": "^25.0.3",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.0",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {