eslint-plugin-playwright 2.8.0 → 2.10.0

package/README.md

@@ -127,13 +127,13 @@ CLI option\
 | [no-commented-out-tests](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-commented-out-tests.md)                       | Disallow commented out tests                                       |     |     |     |
 | [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-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                               | ✅  |     | 💡  |
 | [no-force-option](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-force-option.md)                                     | Disallow usage of the `{ force: true }` option                     | ✅  |     |     |
-| [no-get-by-title](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-get-by-title.md)                                     | Disallow using `getByTitle()`                                      |     | 🔧  |     |
+| [no-get-by-title](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-get-by-title.md)                                     | Disallow using `getByTitle()`                                      |     |     |     |
 | [no-hooks](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-hooks.md)                                                   | Disallow setup and teardown hooks                                  |     |     |     |
 | [no-nested-step](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-nested-step.md)                                       | Disallow nested `test.step()` methods                              | ✅  |     |     |
 | [no-networkidle](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-networkidle.md)                                       | Disallow usage of the `networkidle` option                         | ✅  |     |     |
@@ -145,7 +145,7 @@ CLI option\
 | [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                     | ✅  |     |     |
+| [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                     | ✅  | 🔧  |     |
 | [no-unsafe-references](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-unsafe-references.md)                           | Prevent unsafe variable references in `page.evaluate()`            | ✅  | 🔧  |     |
 | [no-unused-locators](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-unused-locators.md)                               | Disallow usage of page locators that are not used                  | ✅  |     |     |
 | [no-useless-await](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md)                                   | Disallow unnecessary `await`s for Playwright methods               | ✅  | 🔧  |     |
@@ -155,16 +155,16 @@ CLI option\
 | [no-wait-for-timeout](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-timeout.md)                             | Disallow usage of `page.waitForTimeout()`                          | ✅  |     | 💡  |
 | [prefer-comparison-matcher](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparison-matcher.md)                 | Suggest using the built-in comparison matchers                     |     | 🔧  |     |
 | [prefer-equality-matcher](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-equality-matcher.md)                     | Suggest using the built-in equality matchers                       |     |     | 💡  |
-| [prefer-hooks-in-order](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-in-order.md)                         | Prefer having hooks in a consistent order                          |     |     |     |
-| [prefer-hooks-on-top](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-on-top.md)                             | Suggest having hooks before any test cases                         |     |     |     |
+| [prefer-hooks-in-order](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-in-order.md)                         | Prefer having hooks in a consistent order                          | ✅  |     |     |
+| [prefer-hooks-on-top](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-hooks-on-top.md)                             | Suggest having hooks before any test cases                         | ✅  |     |     |
 | [prefer-lowercase-title](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-lowercase-title.md)                       | Enforce lowercase test names                                       |     | 🔧  |     |
 | [prefer-native-locators](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-native-locators.md)                       | Suggest built-in locators over `page.locator()`                    |     | 🔧  |     |
-| [prefer-locator](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-locator.md)                                       | Suggest locators over page methods                                 |     |     |     |
-| [prefer-strict-equal](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-strict-equal.md)                             | Suggest using `toStrictEqual()`                                    |     |     | 💡  |
+| [prefer-locator](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-locator.md)                                       | Suggest locators over page methods                                 | ✅  |     |     |
+| [prefer-strict-equal](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-strict-equal.md)                             | Suggest using `toStrictEqual()`                                    |     | 🔧  | 💡  |
 | [prefer-to-be](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-be.md)                                           | Suggest using `toBe()`                                             |     | 🔧  |     |
 | [prefer-to-contain](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-contain.md)                                 | Suggest using `toContain()`                                        |     | 🔧  |     |
-| [prefer-to-have-count](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-count.md)                           | Suggest using `toHaveCount()`                                      |     | 🔧  |     |
-| [prefer-to-have-length](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-length.md)                         | Suggest using `toHaveLength()`                                     |     | 🔧  |     |
+| [prefer-to-have-count](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-count.md)                           | Suggest using `toHaveCount()`                                      | ✅  | 🔧  |     |
+| [prefer-to-have-length](https://github.com/mskelton/eslint-plugin-playwright/tree/main/docs/rules/prefer-to-have-length.md)                         | Suggest using `toHaveLength()`                                     | ✅  | 🔧  |     |
 | [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()`                          |     | 🔧  |     |

package/dist/index.cjs

@@ -861,6 +861,105 @@ var waitForMethods = [
   "waitForWebSocket"
 ];
 var waitForMethodsRegex = new RegExp(`^(${waitForMethods.join("|")})$`);
+var pageMethods = /* @__PURE__ */ new Set([
+  "addInitScript",
+  "addScriptTag",
+  "addStyleTag",
+  "bringToFront",
+  "check",
+  "click",
+  "close",
+  "dblclick",
+  "dispatchEvent",
+  "dragAndDrop",
+  "emulateMedia",
+  "evaluate",
+  "evaluateHandle",
+  "exposeBinding",
+  "exposeFunction",
+  "fill",
+  "focus",
+  "getAttribute",
+  "goBack",
+  "goForward",
+  "goto",
+  "hover",
+  "innerHTML",
+  "innerText",
+  "inputValue",
+  "isChecked",
+  "isDisabled",
+  "isEditable",
+  "isEnabled",
+  "isHidden",
+  "isVisible",
+  "pdf",
+  "press",
+  "reload",
+  "route",
+  "routeFromHAR",
+  "screenshot",
+  "selectOption",
+  "setBypassCSP",
+  "setContent",
+  "setChecked",
+  "setExtraHTTPHeaders",
+  "setInputFiles",
+  "setViewportSize",
+  "tap",
+  "textContent",
+  "title",
+  "type",
+  "uncheck",
+  "unroute",
+  "unrouteAll",
+  "waitForLoadState",
+  "waitForTimeout",
+  "waitForURL"
+]);
+var locatorMethods = /* @__PURE__ */ new Set([
+  "all",
+  "allInnerTexts",
+  "allTextContents",
+  "blur",
+  "boundingBox",
+  "check",
+  "clear",
+  "click",
+  "count",
+  "dblclick",
+  "dispatchEvent",
+  "dragTo",
+  "evaluate",
+  "evaluateAll",
+  "evaluateHandle",
+  "fill",
+  "focus",
+  "getAttribute",
+  "hover",
+  "innerHTML",
+  "innerText",
+  "inputValue",
+  "isChecked",
+  "isDisabled",
+  "isEditable",
+  "isEnabled",
+  "isHidden",
+  "isVisible",
+  "press",
+  "pressSequentially",
+  "screenshot",
+  "scrollIntoViewIfNeeded",
+  "selectOption",
+  "selectText",
+  "setChecked",
+  "setInputFiles",
+  "tap",
+  "textContent",
+  "type",
+  "uncheck",
+  "waitFor"
+]);
 var expectPlaywrightMatchers = [
   "toBeChecked",
   "toBeDisabled",
@@ -916,14 +1015,18 @@ function getReportNode(node) {
 }
 function getCallType(call, awaitableMatchers) {
   if (call.type === "step") {
-    return { messageId: "testStep", node: call.head.node };
+    return {
+      data: { name: "test.step" },
+      messageId: "missingAwait",
+      node: call.head.node
+    };
   }
   if (call.type === "expect") {
     const isPoll = call.modifiers.some((m) => getStringValue(m) === "poll");
     if (isPoll || awaitableMatchers.has(call.matcherName)) {
       return {
-        data: { matcherName: call.matcherName },
-        messageId: isPoll ? "expectPoll" : "expect",
+        data: { name: isPoll ? "expect.poll" : call.matcherName },
+        messageId: "missingAwait",
         node: call.head.node
       };
     }
@@ -932,6 +1035,7 @@ function getCallType(call, awaitableMatchers) {
 var missing_playwright_await_default = createRule({
   create(context) {
     const options = context.options[0] || {};
+    const includePageLocatorMethods = !!options.includePageLocatorMethods;
     const awaitableMatchers = /* @__PURE__ */ new Set([
       ...expectPlaywrightMatchers,
       ...playwrightTestMatchers,
@@ -992,9 +1096,18 @@ var missing_playwright_await_default = createRule({
       if (parent.type === "SpreadElement") {
         return checkValidity(parent, visited);
       }
-      if (parent.type === "CallExpression" && parent.callee.type === "MemberExpression" && isIdentifier(parent.callee.object, "Promise") && isIdentifier(parent.callee.property, "all")) {
+      if (parent.type === "CallExpression" && parent.callee.type === "MemberExpression" && isIdentifier(parent.callee.object, "Promise") && isIdentifier(parent.callee.property, /^(all|allSettled|race|any)$/)) {
         return true;
       }
+      if (parent.type === "MemberExpression" && parent.object === node && getStringValue(parent.property) === "resolves" && node.type === "CallExpression" && isIdentifier(node.callee, "expect")) {
+        return checkValidity(parent, visited);
+      }
+      if (parent.type === "MemberExpression" && parent.object === node) {
+        return checkValidity(parent, visited);
+      }
+      if (parent.type === "CallExpression" && parent.callee === node) {
+        return checkValidity(parent, visited);
+      }
       if (parent.type === "VariableDeclarator") {
         return isVariableConsumed(parent, checkValidity, validTypes, visited);
       }
@@ -1006,13 +1119,27 @@ var missing_playwright_await_default = createRule({
           if (!checkValidity(node, /* @__PURE__ */ new Set())) {
             const methodName = getStringValue(node.callee.property);
             context.report({
-              data: { methodName },
-              messageId: "waitFor",
+              data: { name: methodName },
+              messageId: "missingAwait",
               node
             });
           }
           return;
         }
+        if (includePageLocatorMethods && node.callee.type === "MemberExpression") {
+          const methodName = getStringValue(node.callee.property);
+          const isPlaywrightMethod = locatorMethods.has(methodName) || pageMethods.has(methodName) && isPageMethod(node, methodName);
+          if (isPlaywrightMethod) {
+            if (!checkValidity(node, /* @__PURE__ */ new Set())) {
+              context.report({
+                data: { name: methodName },
+                messageId: "missingAwait",
+                node
+              });
+            }
+            return;
+          }
+        }
         const call = parseFnCall(context, node);
         if (call?.type !== "step" && call?.type !== "expect") {
           return;
@@ -1038,10 +1165,7 @@ var missing_playwright_await_default = createRule({
     },
     fixable: "code",
     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.",
-      waitFor: "'{{methodName}}' must be awaited or returned."
+      missingAwait: "'{{name}}' must be awaited or returned."
     },
     schema: [
       {
@@ -1050,6 +1174,9 @@ var missing_playwright_await_default = createRule({
           customMatchers: {
             items: { type: "string" },
             type: "array"
+          },
+          includePageLocatorMethods: {
+            type: "boolean"
           }
         },
         type: "object"
@@ -1720,14 +1847,12 @@ var no_raw_locators_default = createRule({
     }
     return {
       CallExpression(node) {
-        if (node.callee.type !== "MemberExpression" || node.arguments[0]?.type === "Identifier") {
+        if (node.callee.type !== "MemberExpression" || !isPropertyAccessor(node.callee, "locator")) {
           return;
         }
-        const method = getStringValue(node.callee.property);
-        const arg = getStringValue(node.arguments[0]);
-        const isLocator = isPageMethod(node, "locator") || method === "locator";
-        if (isLocator && !isAllowed(arg)) {
+        if ((node.arguments.length === 0 || isStringNode(node.arguments[0])) && !isAllowed(getStringValue(node.arguments[0]))) {
           context.report({ messageId: "noRawLocator", node });
+          return;
         }
       }
     };
@@ -1906,7 +2031,7 @@ var no_restricted_roles_default = createRule({
     }
     return {
       CallExpression(node) {
-        if (!isPageMethod(node, "getByRole")) {
+        if (node.callee.type !== "MemberExpression" || !isPropertyAccessor(node.callee, "getByRole")) {
           return;
         }
         const role = getStringValue(node.arguments[0]);
@@ -1964,11 +2089,15 @@ var no_skipped_test_default = createRule({
       CallExpression(node) {
         const options = context.options[0] || {};
         const allowConditional = !!options.allowConditional;
+        const disallowFixme = !!options.disallowFixme;
         const call = parseFnCall(context, node);
         if (call?.group !== "test" && call?.group !== "describe" && call?.group !== "step") {
           return;
         }
-        const skipNode = call.members.find((s) => getStringValue(s) === "skip");
+        const skipNode = call.members.find((member) => {
+          const value = getStringValue(member);
+          return value === "skip" || disallowFixme && value === "fixme";
+        });
         if (!skipNode) {
           return;
         }
@@ -1976,18 +2105,21 @@ var no_skipped_test_default = createRule({
         if (isStandalone && allowConditional && (node.arguments.length !== 0 || findParent(node, "BlockStatement")?.parent?.type === "IfStatement" || findParent(node, "SwitchCase") !== void 0)) {
           return;
         }
+        const annotation = getStringValue(skipNode);
         context.report({
+          data: { annotation },
           messageId: "noSkippedTest",
           node: isStandalone ? node : skipNode,
           suggest: [
             {
+              data: { annotation: getStringValue(skipNode) },
               fix: (fixer) => {
                 return isStandalone ? fixer.remove(node.parent) : fixer.removeRange([
                   skipNode.range[0] - 1,
                   skipNode.range[1] + Number(skipNode.type !== "Identifier")
                 ]);
               },
-              messageId: "removeSkippedTestAnnotation"
+              messageId: "removeAnnotation"
             }
           ]
         });
@@ -2002,8 +2134,8 @@ var no_skipped_test_default = createRule({
     },
     hasSuggestions: true,
     messages: {
-      noSkippedTest: "Unexpected use of the `.skip()` annotation.",
-      removeSkippedTestAnnotation: "Remove the `.skip()` annotation."
+      noSkippedTest: "Unexpected use of the `.{{annotation}}()` annotation.",
+      removeAnnotation: "Remove the `.{{annotation}}()` annotation."
     },
     schema: [
       {
@@ -2012,6 +2144,10 @@ var no_skipped_test_default = createRule({
           allowConditional: {
             default: false,
             type: "boolean"
+          },
+          disallowFixme: {
+            default: false,
+            type: "boolean"
           }
         },
         type: "object"
@@ -2285,7 +2421,7 @@ var no_unused_locators_default = createRule({
   create(context) {
     return {
       CallExpression(node) {
-        if (!isPageMethod(node, LOCATOR_REGEX)) {
+        if (node.callee.type !== "MemberExpression" || !isPropertyAccessor(node.callee, LOCATOR_REGEX)) {
           return;
         }
         if (node.parent.type === "ExpressionStatement" || node.parent.type === "AwaitExpression") {
@@ -2308,7 +2444,7 @@ var no_unused_locators_default = createRule({
 });
 
 // src/rules/no-useless-await.ts
-var locatorMethods = /* @__PURE__ */ new Set([
+var locatorMethods2 = /* @__PURE__ */ new Set([
   "and",
   "first",
   "getByAltText",
@@ -2323,7 +2459,7 @@ var locatorMethods = /* @__PURE__ */ new Set([
   "nth",
   "or"
 ]);
-var pageMethods = /* @__PURE__ */ new Set([
+var pageMethods2 = /* @__PURE__ */ new Set([
   "childFrames",
   "frame",
   "frameLocator",
@@ -2372,7 +2508,7 @@ function isSupportedMethod(node) {
     return false;
   }
   const name = getStringValue(node.callee.property);
-  return locatorMethods.has(name) || pageMethods.has(name) && isPageMethod(node, name);
+  return locatorMethods2.has(name) || pageMethods2.has(name) && isPageMethod(node, name);
 }
 var no_useless_await_default = createRule({
   create(context) {
@@ -2883,7 +3019,7 @@ var prefer_hooks_on_top_default = createRule({
 });
 
 // src/rules/prefer-locator.ts
-var pageMethods2 = /* @__PURE__ */ new Set([
+var pageMethods3 = /* @__PURE__ */ new Set([
   "click",
   "dblclick",
   "dispatchEvent",
@@ -2913,7 +3049,7 @@ function isSupportedMethod2(node) {
     return false;
   }
   const name = getStringValue(node.callee.property);
-  return pageMethods2.has(name) && isPageMethod(node, name);
+  return pageMethods3.has(name) && isPageMethod(node, name);
 }
 var prefer_locator_default = createRule({
   create(context) {
@@ -3086,7 +3222,7 @@ var prefer_native_locators_default = createRule({
           return;
         }
         const query = getStringValue(node.arguments[0]);
-        if (!isPageMethod(node, "locator")) {
+        if (!isPropertyAccessor(node.callee, "locator")) {
           return;
         }
         for (const pattern of patterns) {
@@ -4017,7 +4153,7 @@ var isPromiseMethodThatUsesValue = (node, identifier) => {
   }
   if (node.argument.type === "CallExpression" && node.argument.arguments.length > 0) {
     const nodeName = getNodeName(node.argument);
-    if (["Promise.all", "Promise.allSettled"].includes(nodeName)) {
+    if (/^Promise\.(all|allSettled|race|any)$/.test(nodeName)) {
       const [firstArg] = node.argument.arguments;
       if (firstArg.type === "ArrayExpression" && firstArg.elements.some((nod) => nod && isIdentifier(nod, name))) {
         return true;
@@ -4797,6 +4933,8 @@ var sharedConfig = {
     "playwright/missing-playwright-await": "error",
     "playwright/no-conditional-expect": "warn",
     "playwright/no-conditional-in-test": "warn",
+    "playwright/no-duplicate-hooks": "warn",
+    "playwright/no-duplicate-slow": "warn",
     "playwright/no-element-handle": "warn",
     "playwright/no-eval": "warn",
     "playwright/no-focused-test": "error",
@@ -4813,6 +4951,11 @@ var sharedConfig = {
     "playwright/no-wait-for-navigation": "error",
     "playwright/no-wait-for-selector": "warn",
     "playwright/no-wait-for-timeout": "warn",
+    "playwright/prefer-hooks-in-order": "warn",
+    "playwright/prefer-hooks-on-top": "warn",
+    "playwright/prefer-locator": "warn",
+    "playwright/prefer-to-have-count": "warn",
+    "playwright/prefer-to-have-length": "warn",
     "playwright/prefer-web-first-assertions": "error",
     "playwright/valid-describe-callback": "error",
     "playwright/valid-expect": "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-playwright",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "ESLint plugin for Playwright testing.",
   "license": "MIT",
   "author": "Mark Skelton <mark@mskelton.dev>",