eslint-plugin-playwright 0.20.0 → 0.22.0

package/README.md

@@ -162,6 +162,7 @@ command line option.\
 |     |     |     | [no-restricted-matchers](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-matchers.md)           | Disallow specific matchers & modifiers                            |
 | ✔  |     | 💡  | [no-skipped-test](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-skipped-test.md)                         | Disallow usage of the `.skip` annotation                          |
 | ✔  | 🔧  |     | [no-useless-not](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-not.md)                           | Disallow usage of `not` matchers when a specific matcher exists   |
+| ✔  |     | 💡  | [no-wait-for-selector](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-selector.md)               | Disallow usage of `page.waitForSelector`                          |
 | ✔  |     | 💡  | [no-wait-for-timeout](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-timeout.md)                 | Disallow usage of `page.waitForTimeout`                           |
 |     |     | 💡  | [prefer-strict-equal](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-strict-equal.md)                 | Suggest using `toStrictEqual()`                                   |
 |     | 🔧  |     | [prefer-lowercase-title](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-lowercase-title.md)           | Enforce lowercase test names                                      |

package/dist/index.d.mts

@@ -27,6 +27,7 @@ declare const _default: {
                         'no-skipped-test': eslint.Rule.RuleModule;
                         'no-useless-await': eslint.Rule.RuleModule;
                         'no-useless-not': eslint.Rule.RuleModule;
+                        'no-wait-for-selector': eslint.Rule.RuleModule;
                         'no-wait-for-timeout': eslint.Rule.RuleModule;
                         'prefer-lowercase-title': eslint.Rule.RuleModule;
                         'prefer-strict-equal': eslint.Rule.RuleModule;
@@ -75,6 +76,7 @@ declare const _default: {
                         'no-skipped-test': eslint.Rule.RuleModule;
                         'no-useless-await': eslint.Rule.RuleModule;
                         'no-useless-not': eslint.Rule.RuleModule;
+                        'no-wait-for-selector': eslint.Rule.RuleModule;
                         'no-wait-for-timeout': eslint.Rule.RuleModule;
                         'prefer-lowercase-title': eslint.Rule.RuleModule;
                         'prefer-strict-equal': eslint.Rule.RuleModule;
@@ -106,6 +108,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -155,6 +158,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -182,6 +186,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -207,6 +212,7 @@ declare const _default: {
         'no-skipped-test': eslint.Rule.RuleModule;
         'no-useless-await': eslint.Rule.RuleModule;
         'no-useless-not': eslint.Rule.RuleModule;
+        'no-wait-for-selector': eslint.Rule.RuleModule;
         'no-wait-for-timeout': eslint.Rule.RuleModule;
         'prefer-lowercase-title': eslint.Rule.RuleModule;
         'prefer-strict-equal': eslint.Rule.RuleModule;

package/dist/index.d.ts

@@ -27,6 +27,7 @@ declare const _default: {
                         'no-skipped-test': eslint.Rule.RuleModule;
                         'no-useless-await': eslint.Rule.RuleModule;
                         'no-useless-not': eslint.Rule.RuleModule;
+                        'no-wait-for-selector': eslint.Rule.RuleModule;
                         'no-wait-for-timeout': eslint.Rule.RuleModule;
                         'prefer-lowercase-title': eslint.Rule.RuleModule;
                         'prefer-strict-equal': eslint.Rule.RuleModule;
@@ -75,6 +76,7 @@ declare const _default: {
                         'no-skipped-test': eslint.Rule.RuleModule;
                         'no-useless-await': eslint.Rule.RuleModule;
                         'no-useless-not': eslint.Rule.RuleModule;
+                        'no-wait-for-selector': eslint.Rule.RuleModule;
                         'no-wait-for-timeout': eslint.Rule.RuleModule;
                         'prefer-lowercase-title': eslint.Rule.RuleModule;
                         'prefer-strict-equal': eslint.Rule.RuleModule;
@@ -106,6 +108,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -155,6 +158,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -182,6 +186,7 @@ declare const _default: {
                 'playwright/no-skipped-test': string;
                 'playwright/no-useless-await': string;
                 'playwright/no-useless-not': string;
+                'playwright/no-wait-for-selector': string;
                 'playwright/no-wait-for-timeout': string;
                 'playwright/prefer-web-first-assertions': string;
                 'playwright/valid-expect': string;
@@ -207,6 +212,7 @@ declare const _default: {
         'no-skipped-test': eslint.Rule.RuleModule;
         'no-useless-await': eslint.Rule.RuleModule;
         'no-useless-not': eslint.Rule.RuleModule;
+        'no-wait-for-selector': eslint.Rule.RuleModule;
         'no-wait-for-timeout': eslint.Rule.RuleModule;
         'prefer-lowercase-title': eslint.Rule.RuleModule;
         'prefer-strict-equal': eslint.Rule.RuleModule;

package/dist/index.js

@@ -303,31 +303,27 @@ var playwrightTestMatchers = [
 ];
 function getCallType(node, awaitableMatchers) {
   if (node.callee.type === "MemberExpression" && isIdentifier(node.callee.object, "test") && isPropertyAccessor(node.callee, "step")) {
-    return { messageId: "testStep" };
+    return { messageId: "testStep", node };
   }
   const expectType = getExpectType(node);
   if (!expectType)
     return;
-  if (expectType === "poll") {
-    return { messageId: "expectPoll" };
-  }
   const [lastMatcher] = getMatchers(node).slice(-1);
+  const grandparent = lastMatcher?.parent?.parent;
+  if (grandparent?.type !== "CallExpression")
+    return;
   const matcherName = getStringValue(lastMatcher);
-  if (awaitableMatchers.has(matcherName)) {
-    return { data: { matcherName }, messageId: "expect" };
+  if (expectType === "poll" || awaitableMatchers.has(matcherName)) {
+    return {
+      data: { matcherName },
+      messageId: expectType === "poll" ? "expectPoll" : "expect",
+      node: grandparent
+    };
   }
 }
-function isPromiseAll(node) {
-  return node.type === "ArrayExpression" && node.parent.type === "CallExpression" && node.parent.callee.type === "MemberExpression" && isIdentifier(node.parent.callee.object, "Promise") && isIdentifier(node.parent.callee.property, "all") ? node.parent : null;
-}
-function checkValidity(node) {
-  if (validTypes.has(node.parent.type))
-    return;
-  const promiseAll = isPromiseAll(node.parent);
-  return promiseAll ? checkValidity(promiseAll) : node.parent.type === "MemberExpression" || node.parent.type === "CallExpression" && node.parent.callee === node ? checkValidity(node.parent) : node;
-}
 var missing_playwright_await_default = {
   create(context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode();
     const options = context.options[0] || {};
     const awaitableMatchers = /* @__PURE__ */ new Set([
       ...expectPlaywrightMatchers,
@@ -335,11 +331,33 @@ var missing_playwright_await_default = {
       // Add any custom matchers to the set
       ...options.customMatchers || []
     ]);
+    function checkValidity(node) {
+      if (validTypes.has(node.parent.type))
+        return true;
+      if (node.parent.type === "ArrayExpression") {
+        return checkValidity(node.parent);
+      }
+      if (node.parent.type === "CallExpression" && node.parent.callee.type === "MemberExpression" && isIdentifier(node.parent.callee.object, "Promise") && isIdentifier(node.parent.callee.property, "all")) {
+        return true;
+      }
+      if (node.parent.type === "VariableDeclarator") {
+        const scope = sourceCode.getScope(node.parent.parent);
+        for (const ref of scope.references) {
+          const refParent = ref.identifier.parent;
+          if (validTypes.has(refParent.type))
+            return true;
+          if (checkValidity(refParent))
+            return true;
+        }
+      }
+      return false;
+    }
     return {
       CallExpression(node) {
         const result = getCallType(node, awaitableMatchers);
-        const reportNode = result ? checkValidity(node) : void 0;
-        if (result && reportNode) {
+        console.log(result);
+        const isValid = result ? checkValidity(result.node) : false;
+        if (result && !isValid) {
           context.report({
             data: result.data,
             fix: (fixer) => fixer.insertTextBefore(node, "await "),
@@ -748,14 +766,27 @@ var no_page_pause_default = {
 };
 
 // src/rules/no-raw-locators.ts
+function normalize(str) {
+  const match = /\[([^=]+?)=['"]?([^'"]+?)['"]?\]/.exec(str);
+  return match ? `[${match[1]}=${match[2]}]` : str;
+}
 var no_raw_locators_default = {
   create(context) {
+    const options = {
+      allowed: [],
+      ...context.options?.[0] ?? {}
+    };
+    function isAllowed(arg) {
+      return options.allowed.some((a) => normalize(a) === normalize(arg));
+    }
     return {
       CallExpression(node) {
         if (node.callee.type !== "MemberExpression")
           return;
         const method = getStringValue(node.callee.property);
-        if (isPageMethod(node, "locator") || method === "locator") {
+        const arg = getStringValue(node.arguments[0]);
+        const isLocator = isPageMethod(node, "locator") || method === "locator";
+        if (isLocator && !isAllowed(arg)) {
           context.report({ messageId: "noRawLocator", node });
         }
       }
@@ -771,6 +802,18 @@ var no_raw_locators_default = {
     messages: {
       noRawLocator: "Usage of raw locator detected. Use methods like .getByRole() or .getByText() instead of raw locators."
     },
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          allowed: {
+            items: { type: "string" },
+            type: "array"
+          }
+        },
+        type: "object"
+      }
+    ],
     type: "suggestion"
   }
 };
@@ -1073,6 +1116,44 @@ var no_useless_not_default = {
   }
 };
 
+// src/rules/no-wait-for-selector.ts
+var no_wait_for_selector_default = {
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (isPageMethod(node, "waitForSelector")) {
+          context.report({
+            messageId: "noWaitForSelector",
+            node,
+            suggest: [
+              {
+                fix: (fixer) => fixer.remove(
+                  node.parent && node.parent.type !== "AwaitExpression" ? node.parent : node.parent.parent
+                ),
+                messageId: "removeWaitForSelector"
+              }
+            ]
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Prevent usage of page.waitForSelector()",
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-selector.md"
+    },
+    hasSuggestions: true,
+    messages: {
+      noWaitForSelector: "Unexpected use of page.waitForSelector().",
+      removeWaitForSelector: "Remove the page.waitForSelector() method."
+    },
+    type: "suggestion"
+  }
+};
+
 // src/rules/no-wait-for-timeout.ts
 var no_wait_for_timeout_default = {
   create(context) {
@@ -2061,6 +2142,7 @@ var index = {
     "no-skipped-test": no_skipped_test_default,
     "no-useless-await": no_useless_await_default,
     "no-useless-not": no_useless_not_default,
+    "no-wait-for-selector": no_wait_for_selector_default,
     "no-wait-for-timeout": no_wait_for_timeout_default,
     "prefer-lowercase-title": prefer_lowercase_title_default,
     "prefer-strict-equal": prefer_strict_equal_default,
@@ -2092,6 +2174,7 @@ var sharedConfig = {
     "playwright/no-skipped-test": "warn",
     "playwright/no-useless-await": "warn",
     "playwright/no-useless-not": "warn",
+    "playwright/no-wait-for-selector": "warn",
     "playwright/no-wait-for-timeout": "warn",
     "playwright/prefer-web-first-assertions": "error",
     "playwright/valid-expect": "error",

package/dist/index.mjs

@@ -260,29 +260,24 @@ var init_max_nested_describe = __esm({
 // src/rules/missing-playwright-await.ts
 function getCallType(node, awaitableMatchers) {
   if (node.callee.type === "MemberExpression" && isIdentifier(node.callee.object, "test") && isPropertyAccessor(node.callee, "step")) {
-    return { messageId: "testStep" };
+    return { messageId: "testStep", node };
   }
   const expectType = getExpectType(node);
   if (!expectType)
     return;
-  if (expectType === "poll") {
-    return { messageId: "expectPoll" };
-  }
   const [lastMatcher] = getMatchers(node).slice(-1);
+  const grandparent = lastMatcher?.parent?.parent;
+  if (grandparent?.type !== "CallExpression")
+    return;
   const matcherName = getStringValue(lastMatcher);
-  if (awaitableMatchers.has(matcherName)) {
-    return { data: { matcherName }, messageId: "expect" };
+  if (expectType === "poll" || awaitableMatchers.has(matcherName)) {
+    return {
+      data: { matcherName },
+      messageId: expectType === "poll" ? "expectPoll" : "expect",
+      node: grandparent
+    };
   }
 }
-function isPromiseAll(node) {
-  return node.type === "ArrayExpression" && node.parent.type === "CallExpression" && node.parent.callee.type === "MemberExpression" && isIdentifier(node.parent.callee.object, "Promise") && isIdentifier(node.parent.callee.property, "all") ? node.parent : null;
-}
-function checkValidity(node) {
-  if (validTypes.has(node.parent.type))
-    return;
-  const promiseAll = isPromiseAll(node.parent);
-  return promiseAll ? checkValidity(promiseAll) : node.parent.type === "MemberExpression" || node.parent.type === "CallExpression" && node.parent.callee === node ? checkValidity(node.parent) : node;
-}
 var validTypes, expectPlaywrightMatchers, playwrightTestMatchers, missing_playwright_await_default;
 var init_missing_playwright_await = __esm({
   "src/rules/missing-playwright-await.ts"() {
@@ -341,6 +336,7 @@ var init_missing_playwright_await = __esm({
     ];
     missing_playwright_await_default = {
       create(context) {
+        const sourceCode = context.sourceCode ?? context.getSourceCode();
         const options = context.options[0] || {};
         const awaitableMatchers = /* @__PURE__ */ new Set([
           ...expectPlaywrightMatchers,
@@ -348,11 +344,33 @@ var init_missing_playwright_await = __esm({
           // Add any custom matchers to the set
           ...options.customMatchers || []
         ]);
+        function checkValidity(node) {
+          if (validTypes.has(node.parent.type))
+            return true;
+          if (node.parent.type === "ArrayExpression") {
+            return checkValidity(node.parent);
+          }
+          if (node.parent.type === "CallExpression" && node.parent.callee.type === "MemberExpression" && isIdentifier(node.parent.callee.object, "Promise") && isIdentifier(node.parent.callee.property, "all")) {
+            return true;
+          }
+          if (node.parent.type === "VariableDeclarator") {
+            const scope = sourceCode.getScope(node.parent.parent);
+            for (const ref of scope.references) {
+              const refParent = ref.identifier.parent;
+              if (validTypes.has(refParent.type))
+                return true;
+              if (checkValidity(refParent))
+                return true;
+            }
+          }
+          return false;
+        }
         return {
           CallExpression(node) {
             const result = getCallType(node, awaitableMatchers);
-            const reportNode = result ? checkValidity(node) : void 0;
-            if (result && reportNode) {
+            console.log(result);
+            const isValid = result ? checkValidity(result.node) : false;
+            if (result && !isValid) {
               context.report({
                 data: result.data,
                 fix: (fixer) => fixer.insertTextBefore(node, "await "),
@@ -826,6 +844,10 @@ var init_no_page_pause = __esm({
 });
 
 // src/rules/no-raw-locators.ts
+function normalize(str) {
+  const match = /\[([^=]+?)=['"]?([^'"]+?)['"]?\]/.exec(str);
+  return match ? `[${match[1]}=${match[2]}]` : str;
+}
 var no_raw_locators_default;
 var init_no_raw_locators = __esm({
   "src/rules/no-raw-locators.ts"() {
@@ -833,12 +855,21 @@ var init_no_raw_locators = __esm({
     init_ast();
     no_raw_locators_default = {
       create(context) {
+        const options = {
+          allowed: [],
+          ...context.options?.[0] ?? {}
+        };
+        function isAllowed(arg) {
+          return options.allowed.some((a) => normalize(a) === normalize(arg));
+        }
         return {
           CallExpression(node) {
             if (node.callee.type !== "MemberExpression")
               return;
             const method = getStringValue(node.callee.property);
-            if (isPageMethod(node, "locator") || method === "locator") {
+            const arg = getStringValue(node.arguments[0]);
+            const isLocator = isPageMethod(node, "locator") || method === "locator";
+            if (isLocator && !isAllowed(arg)) {
               context.report({ messageId: "noRawLocator", node });
             }
           }
@@ -854,6 +885,18 @@ var init_no_raw_locators = __esm({
         messages: {
           noRawLocator: "Usage of raw locator detected. Use methods like .getByRole() or .getByText() instead of raw locators."
         },
+        schema: [
+          {
+            additionalProperties: false,
+            properties: {
+              allowed: {
+                items: { type: "string" },
+                type: "array"
+              }
+            },
+            type: "object"
+          }
+        ],
         type: "suggestion"
       }
     };
@@ -1202,6 +1245,51 @@ var init_no_useless_not = __esm({
   }
 });
 
+// src/rules/no-wait-for-selector.ts
+var no_wait_for_selector_default;
+var init_no_wait_for_selector = __esm({
+  "src/rules/no-wait-for-selector.ts"() {
+    "use strict";
+    init_ast();
+    no_wait_for_selector_default = {
+      create(context) {
+        return {
+          CallExpression(node) {
+            if (isPageMethod(node, "waitForSelector")) {
+              context.report({
+                messageId: "noWaitForSelector",
+                node,
+                suggest: [
+                  {
+                    fix: (fixer) => fixer.remove(
+                      node.parent && node.parent.type !== "AwaitExpression" ? node.parent : node.parent.parent
+                    ),
+                    messageId: "removeWaitForSelector"
+                  }
+                ]
+              });
+            }
+          }
+        };
+      },
+      meta: {
+        docs: {
+          category: "Best Practices",
+          description: "Prevent usage of page.waitForSelector()",
+          recommended: true,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-selector.md"
+        },
+        hasSuggestions: true,
+        messages: {
+          noWaitForSelector: "Unexpected use of page.waitForSelector().",
+          removeWaitForSelector: "Remove the page.waitForSelector() method."
+        },
+        type: "suggestion"
+      }
+    };
+  }
+});
+
 // src/rules/no-wait-for-timeout.ts
 var no_wait_for_timeout_default;
 var init_no_wait_for_timeout = __esm({
@@ -2285,6 +2373,7 @@ var require_src = __commonJS({
     init_no_skipped_test();
     init_no_useless_await();
     init_no_useless_not();
+    init_no_wait_for_selector();
     init_no_wait_for_timeout();
     init_prefer_lowercase_title();
     init_prefer_strict_equal();
@@ -2317,6 +2406,7 @@ var require_src = __commonJS({
         "no-skipped-test": no_skipped_test_default,
         "no-useless-await": no_useless_await_default,
         "no-useless-not": no_useless_not_default,
+        "no-wait-for-selector": no_wait_for_selector_default,
         "no-wait-for-timeout": no_wait_for_timeout_default,
         "prefer-lowercase-title": prefer_lowercase_title_default,
         "prefer-strict-equal": prefer_strict_equal_default,
@@ -2348,6 +2438,7 @@ var require_src = __commonJS({
         "playwright/no-skipped-test": "warn",
         "playwright/no-useless-await": "warn",
         "playwright/no-useless-not": "warn",
+        "playwright/no-wait-for-selector": "warn",
         "playwright/no-wait-for-timeout": "warn",
         "playwright/prefer-web-first-assertions": "error",
         "playwright/valid-expect": "error",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
   "author": "Mark Skelton <mark@mskelton.dev>",
   "packageManager": "pnpm@8.12.0",