eslint-plugin-playwright 2.5.1 → 2.6.1

package/README.md

@@ -128,6 +128,7 @@ CLI option\
 | [no-conditional-expect](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-conditional-expect.md)                         | Disallow calling `expect` conditionally                            | ✅  |     |     |
 | [no-conditional-in-test](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-conditional-in-test.md)                       | Disallow conditional logic in tests                                | ✅  |     |     |
 | [no-duplicate-hooks](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-duplicate-hooks.md)                               | Disallow duplicate setup and teardown hooks                        |     |     |     |
+| [no-duplicate-slow](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-duplicate-slow.md)                                 | Disallow multiple `test.slow()` calls in the same test             | ✅  |     |     |
 | [no-element-handle](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-element-handle.md)                                 | Disallow usage of element handles                                  | ✅  |     | 💡  |
 | [no-eval](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-eval.md)                                                     | Disallow usage of `page.$eval()` and `page.$$eval()`               | ✅  |     |     |
 | [no-focused-test](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-focused-test.md)                                     | Disallow usage of `.only` annotation                               | ✅  |     | 💡  |
@@ -141,6 +142,7 @@ CLI option\
 | [no-raw-locators](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-raw-locators.md)                                     | Disallow using raw locators                                        |     |     |     |
 | [no-restricted-locators](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-locators.md)                       | Disallow specific locator methods                                  |     |     |     |
 | [no-restricted-matchers](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-matchers.md)                       | Disallow specific matchers & modifiers                             |     |     |     |
+| [no-restricted-roles](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-roles.md)                             | Disallow specific roles in `getByRole()`                           |     |     |     |
 | [no-skipped-test](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-skipped-test.md)                                     | Disallow usage of the `.skip` annotation                           | ✅  |     | 💡  |
 | [no-slowed-test](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-slowed-test.md)                                       | Disallow usage of the `.slow` annotation                           |     |     | 💡  |
 | [no-standalone-expect](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-standalone-expect.md)                           | Disallow using expect outside of `test` blocks                     | ✅  |     |     |
@@ -166,6 +168,8 @@ CLI option\
 | [prefer-web-first-assertions](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-web-first-assertions.md)             | Suggest using web first assertions                                 | ✅  | 🔧  |     |
 | [require-hook](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-hook.md)                                           | Require setup and teardown code to be within a hook                |     |     |     |
 | [require-soft-assertions](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-soft-assertions.md)                     | Require assertions to use `expect.soft()`                          |     | 🔧  |     |
+| [require-tags](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-tags.md)                                           | Require test blocks to have tags                                   |     |     |     |
+| [require-to-pass-timeout](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-to-pass-timeout.md)                     | Require a timeout option for `toPass()`                            |     |     |     |
 | [require-to-throw-message](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-to-throw-message.md)                   | Require a message for `toThrow()`                                  |     |     |     |
 | [require-top-level-describe](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/require-top-level-describe.md)               | Require test cases and hooks to be inside a `test.describe` block  |     |     |     |
 | [valid-describe-callback](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/valid-describe-callback.md)                     | Enforce valid `describe()` callback                                | ✅  |     |     |

package/dist/index.cjs

@@ -22,7 +22,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 
-// src/index.ts
+// src/plugin.ts
 var import_globals = __toESM(require("globals"), 1);
 
 // src/utils/parseFnCall.ts
@@ -599,9 +599,9 @@ var expect_expect_default = createRule({
     const unchecked = [];
     function checkExpressions(nodes) {
       for (const node of nodes) {
-        const index2 = node.type === "CallExpression" ? unchecked.indexOf(node) : -1;
-        if (index2 !== -1) {
-          unchecked.splice(index2, 1);
+        const index = node.type === "CallExpression" ? unchecked.indexOf(node) : -1;
+        if (index !== -1) {
+          unchecked.splice(index, 1);
           break;
         }
       }
@@ -784,6 +784,18 @@ var max_nested_describe_default = createRule({
 
 // src/rules/missing-playwright-await.ts
 var validTypes = /* @__PURE__ */ new Set(["AwaitExpression", "ReturnStatement", "ArrowFunctionExpression"]);
+var waitForMethods = [
+  "waitForConsoleMessage",
+  "waitForDownload",
+  "waitForEvent",
+  "waitForFileChooser",
+  "waitForFunction",
+  "waitForPopup",
+  "waitForRequest",
+  "waitForResponse",
+  "waitForWebSocket"
+];
+var waitForMethodsRegex = new RegExp(`^(${waitForMethods.join("|")})$`);
 var expectPlaywrightMatchers = [
   "toBeChecked",
   "toBeDisabled",
@@ -886,6 +898,17 @@ var missing_playwright_await_default = createRule({
     }
     return {
       CallExpression(node) {
+        if (isPageMethod(node, waitForMethodsRegex)) {
+          if (!checkValidity(node, /* @__PURE__ */ new Set())) {
+            const methodName = getStringValue(node.callee.property);
+            context.report({
+              data: { methodName },
+              messageId: "waitFor",
+              node
+            });
+          }
+          return;
+        }
         const call = parseFnCall(context, node);
         if (call?.type !== "step" && call?.type !== "expect") return;
         const result = getCallType(call, awaitableMatchers);
@@ -912,7 +935,8 @@ var missing_playwright_await_default = createRule({
     messages: {
       expect: "'{{matcherName}}' must be awaited or returned.",
       expectPoll: "'expect.poll' matchers must be awaited or returned.",
-      testStep: "'test.step' must be awaited or returned."
+      testStep: "'test.step' must be awaited or returned.",
+      waitFor: "'{{methodName}}' must be awaited or returned."
     },
     schema: [
       {
@@ -1149,6 +1173,50 @@ var no_duplicate_hooks_default = createRule({
   }
 });
 
+// src/rules/no-duplicate-slow.ts
+var no_duplicate_slow_default = createRule({
+  create(context) {
+    const scopes = [false];
+    return {
+      "CallExpression"(node) {
+        const call = parseFnCall(context, node);
+        if (!call) return;
+        if (call.type === "test" || call.type === "describe") {
+          scopes.push(scopes[scopes.length - 1]);
+        }
+        if (call.group === "test" && call.type === "config") {
+          const isSlowCall = call.members.some((s) => getStringValue(s) === "slow");
+          if (isSlowCall) {
+            const current = scopes.length - 1;
+            if (scopes[current]) {
+              context.report({ messageId: "noDuplicateSlow", node });
+            } else {
+              scopes[current] = true;
+            }
+          }
+        }
+      },
+      "CallExpression:exit"(node) {
+        if (isTypeOfFnCall(context, node, ["test", "describe"])) {
+          scopes.pop();
+        }
+      }
+    };
+  },
+  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"
+    },
+    messages: {
+      noDuplicateSlow: "Multiple `test.slow()` calls will multiply the timeout. Use only one `test.slow()` per test."
+    },
+    type: "problem"
+  }
+});
+
 // src/rules/no-element-handle.ts
 function getPropertyRange(node) {
   return node.type === "Identifier" ? node.range : [node.range[0] + 1, node.range[1] - 1];
@@ -1727,6 +1795,77 @@ var no_restricted_matchers_default = createRule({
   }
 });
 
+// src/rules/no-restricted-roles.ts
+var no_restricted_roles_default = createRule({
+  create(context) {
+    const options = context.options?.[0] ?? [];
+    const restrictions = options.map((option) => {
+      if (typeof option === "string") {
+        return { message: null, role: option };
+      }
+      return {
+        message: option.message ?? null,
+        role: option.role
+      };
+    });
+    const restrictionMap = /* @__PURE__ */ new Map();
+    for (const restriction of restrictions) {
+      restrictionMap.set(restriction.role, restriction.message);
+    }
+    return {
+      CallExpression(node) {
+        if (!isPageMethod(node, "getByRole")) {
+          return;
+        }
+        const role = getStringValue(node.arguments[0]);
+        if (!role) {
+          return;
+        }
+        if (restrictionMap.has(role)) {
+          const message = restrictionMap.get(role) ?? "";
+          context.report({
+            data: { message, role },
+            messageId: message ? "restrictedWithMessage" : "restricted",
+            node
+          });
+        }
+      }
+    };
+  },
+  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"
+    },
+    messages: {
+      restricted: "Usage of role `{{role}}` in getByRole() is disallowed",
+      restrictedWithMessage: "{{message}}"
+    },
+    schema: [
+      {
+        items: {
+          oneOf: [
+            { type: "string" },
+            {
+              additionalProperties: false,
+              properties: {
+                message: { type: "string" },
+                role: { type: "string" }
+              },
+              required: ["role"],
+              type: "object"
+            }
+          ]
+        },
+        type: "array"
+      }
+    ],
+    type: "suggestion"
+  }
+});
+
 // src/rules/no-skipped-test.ts
 var no_skipped_test_default = createRule({
   create(context) {
@@ -2189,8 +2328,8 @@ function removePropertyFixer(fixer, property) {
   if (parent.properties.length === 1) {
     return fixer.remove(parent);
   }
-  const index2 = parent.properties.indexOf(property);
-  const range = index2 ? [parent.properties[index2 - 1].range[1], property.range[1]] : [property.range[0], parent.properties[1].range[0]];
+  const index = parent.properties.indexOf(property);
+  const range = index ? [parent.properties[index - 1].range[1], property.range[1]] : [property.range[0], parent.properties[1].range[0]];
   return fixer.removeRange(range);
 }
 
@@ -3409,6 +3548,113 @@ var require_soft_assertions_default = createRule({
   }
 });
 
+// src/rules/require-tags.ts
+var tagRegex = /@[\S]+/;
+function hasTagInOptions(node) {
+  const options = node.arguments[1];
+  if (!options || options.type !== "ObjectExpression") {
+    return false;
+  }
+  return options.properties.some(
+    (prop) => prop.type === "Property" && prop.key.type === "Identifier" && prop.key.name === "tag"
+  );
+}
+function hasTagInTitle(node) {
+  const title = node.arguments[0];
+  if (!title || title.type !== "Literal" || typeof title.value !== "string") {
+    return false;
+  }
+  return tagRegex.test(title.value);
+}
+function hasTags(node) {
+  return hasTagInTitle(node) || hasTagInOptions(node);
+}
+var require_tags_default = createRule({
+  create(context) {
+    const describeStack = [];
+    return {
+      "CallExpression"(node) {
+        const call = parseFnCall(context, node);
+        if (!call) {
+          return;
+        }
+        if (call.type === "describe") {
+          describeStack.push(hasTags(node) || !!describeStack.at(-1));
+          return;
+        }
+        if (call.type === "test") {
+          if (hasTags(node) || !!describeStack.at(-1)) {
+            return;
+          }
+          context.report({ messageId: "missingTag", node });
+        }
+      },
+      "CallExpression:exit"(node) {
+        if (isTypeOfFnCall(context, node, ["describe"])) {
+          describeStack.pop();
+        }
+      }
+    };
+  },
+  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"
+    },
+    messages: {
+      missingTag: "Test must have at least one tag"
+    },
+    schema: [],
+    type: "suggestion"
+  }
+});
+
+// src/rules/require-to-pass-timeout.ts
+var require_to_pass_timeout_default = createRule({
+  create(context) {
+    return {
+      CallExpression(node) {
+        const call = parseFnCall(context, node);
+        if (call?.type !== "expect" || call.matcherName !== "toPass") {
+          return;
+        }
+        const [options] = call.matcherArgs;
+        if (!options || options.type !== "ObjectExpression") {
+          context.report({
+            messageId: "addTimeoutOption",
+            node: call.matcher
+          });
+          return;
+        }
+        const hasTimeout = options.properties.some(
+          (prop) => prop.type === "Property" && prop.key.type === "Identifier" && prop.key.name === "timeout"
+        );
+        if (!hasTimeout) {
+          context.report({
+            messageId: "addTimeoutOption",
+            node: call.matcher
+          });
+        }
+      }
+    };
+  },
+  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"
+    },
+    messages: {
+      addTimeoutOption: "Add a timeout option to toPass()"
+    },
+    schema: [],
+    type: "suggestion"
+  }
+});
+
 // src/rules/require-to-throw-message.ts
 var require_to_throw_message_default = createRule({
   create(context) {
@@ -4174,6 +4420,9 @@ var valid_title_default = createRule({
           if (title.type === "BinaryExpression" && doesBinaryExpressionContainStringNode(title)) {
             return;
           }
+          if (title.type === "Identifier" || title.type === "MemberExpression") {
+            return;
+          }
           if (!(call.type === "describe" && ignoreTypeOfDescribeName || call.type === "test" && ignoreTypeOfTestName || call.type === "step" && ignoreTypeOfStepName) && title.type !== "TemplateLiteral") {
             context.report({
               loc: title.loc,
@@ -4323,8 +4572,8 @@ var valid_title_default = createRule({
   }
 });
 
-// src/index.ts
-var index = {
+// src/plugin.ts
+var plugin = {
   configs: {},
   rules: {
     "consistent-spacing-between-blocks": consistent_spacing_between_blocks_default,
@@ -4336,6 +4585,7 @@ var index = {
     "no-conditional-expect": no_conditional_expect_default,
     "no-conditional-in-test": no_conditional_in_test_default,
     "no-duplicate-hooks": no_duplicate_hooks_default,
+    "no-duplicate-slow": no_duplicate_slow_default,
     "no-element-handle": no_element_handle_default,
     "no-eval": no_eval_default,
     "no-focused-test": no_focused_test_default,
@@ -4349,6 +4599,7 @@ var index = {
     "no-raw-locators": no_raw_locators_default,
     "no-restricted-locators": no_restricted_locators_default,
     "no-restricted-matchers": no_restricted_matchers_default,
+    "no-restricted-roles": no_restricted_roles_default,
     "no-skipped-test": no_skipped_test_default,
     "no-slowed-test": no_slowed_test_default,
     "no-standalone-expect": no_standalone_expect_default,
@@ -4374,6 +4625,8 @@ var index = {
     "prefer-web-first-assertions": prefer_web_first_assertions_default,
     "require-hook": require_hook_default,
     "require-soft-assertions": require_soft_assertions_default,
+    "require-tags": require_tags_default,
+    "require-to-pass-timeout": require_to_pass_timeout_default,
     "require-to-throw-message": require_to_throw_message_default,
     "require-top-level-describe": require_top_level_describe_default,
     "valid-describe-callback": valid_describe_callback_default,
@@ -4429,11 +4682,13 @@ var flatConfig = {
     globals: import_globals.default["shared-node-browser"]
   },
   plugins: {
-    playwright: index
+    playwright: plugin
   }
 };
+
+// src/index.ts
 module.exports = {
-  ...index,
+  ...plugin,
   configs: {
     "flat/recommended": flatConfig,
     "playwright-test": legacyConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-playwright",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "description": "ESLint plugin for Playwright testing.",
   "license": "MIT",
   "author": "Mark Skelton <mark@mskelton.dev>",
@@ -32,24 +32,24 @@
     "format": "oxfmt .",
     "format:check": "oxfmt --check .",
     "test": "vitest --hideSkippedTests",
-    "test:watch": "vitest --reporter=dot",
-    "ts": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "ci": "yarn format:check && yarn lint && yarn typecheck"
   },
   "dependencies": {
-    "globals": "^16.4.0"
+    "globals": "^17.3.0"
   },
   "devDependencies": {
-    "@mskelton/eslint-config": "^9.0.1",
-    "@types/estree": "^1.0.6",
-    "@types/node": "^20.11.17",
-    "@typescript-eslint/parser": "^8.11.0",
-    "dedent": "^1.5.1",
+    "@mskelton/eslint-config": "^9.3.0",
+    "@types/estree": "^1.0.8",
+    "@types/node": "^25.2.3",
+    "@typescript-eslint/parser": "^8.56.0",
+    "dedent": "^1.7.1",
     "eslint": "^9.13.0",
-    "oxfmt": "^0.23.0",
-    "semantic-release": "^25.0.2",
-    "tsup": "^8.0.1",
-    "typescript": "^5.2.2",
-    "vitest": "^4.0.17"
+    "oxfmt": "^0.33.0",
+    "semantic-release": "^25.0.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "eslint": ">=8.40.0"