eslint-plugin-playwright 2.2.2 → 2.4.0

package/README.md

@@ -38,19 +38,19 @@ file patterns.
 (**eslint.config.js**)
 
 ```javascript
+import { defineConfig } from '@eslint/config'
 import playwright from 'eslint-plugin-playwright'
 
-export default [
+export default defineConfig([
   {
-    ...playwright.configs['flat/recommended'],
     files: ['tests/**'],
+    extends: [playwright.configs['flat/recommended']],
     rules: {
-      ...playwright.configs['flat/recommended'].rules,
       // Customize Playwright rules
       // ...
     },
   },
-]
+])
 ```
 
 [Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)
@@ -142,6 +142,7 @@ CLI option\
 | [no-slowed-test](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-slowed-test.md)                           | Disallow usage of the `.slow` annotation                           |     |     | 💡  |
 | [no-standalone-expect](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-standalone-expect.md)               | Disallow using expect outside of `test` blocks                     | ✅  |     |     |
 | [no-unsafe-references](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-unsafe-references.md)               | Prevent unsafe variable references in `page.evaluate()`            | ✅  | 🔧  |     |
+| [no-unused-locators](https://github.com/playwright-community/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/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md)                       | Disallow unnecessary `await`s for Playwright methods               | ✅  | 🔧  |     |
 | [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-navigation](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-navigation.md)           | Disallow usage of `page.waitForNavigation()`                       | ✅  |     | 💡  |

package/dist/index.cjs

@@ -21,28 +21,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var __privateMethod = (obj, member, method) => {
-  __accessCheck(obj, member, "access private method");
-  return method;
-};
 
 // src/index.ts
 var import_globals = __toESM(require("globals"), 1);
@@ -106,43 +84,38 @@ var VALID_CHAINS = /* @__PURE__ */ new Set([
 ]);
 var joinChains = (a, b) => a && b ? [...a, ...b] : null;
 var isSupportedAccessor = (node, value) => isIdentifier(node, value) || isStringNode(node, value);
-var _nodes, _leaves, _buildChain, buildChain_fn;
 var Chain = class {
+  #nodes = null;
+  #leaves = /* @__PURE__ */ new WeakSet();
   constructor(node) {
-    __privateAdd(this, _buildChain);
-    __privateAdd(this, _nodes, null);
-    __privateAdd(this, _leaves, /* @__PURE__ */ new WeakSet());
-    __privateSet(this, _nodes, __privateMethod(this, _buildChain, buildChain_fn).call(this, node));
+    this.#nodes = this.#buildChain(node);
   }
   isLeaf(node) {
-    return __privateGet(this, _leaves).has(node);
+    return this.#leaves.has(node);
   }
   get nodes() {
-    return __privateGet(this, _nodes);
+    return this.#nodes;
   }
-};
-_nodes = new WeakMap();
-_leaves = new WeakMap();
-_buildChain = new WeakSet();
-buildChain_fn = function(node, insideCall = false) {
-  if (isSupportedAccessor(node)) {
-    if (insideCall) {
-      __privateGet(this, _leaves).add(node);
+  #buildChain(node, insideCall = false) {
+    if (isSupportedAccessor(node)) {
+      if (insideCall) {
+        this.#leaves.add(node);
+      }
+      return [node];
+    }
+    switch (node.type) {
+      case "TaggedTemplateExpression":
+        return this.#buildChain(node.tag);
+      case "MemberExpression":
+        return joinChains(
+          this.#buildChain(node.object),
+          this.#buildChain(node.property, insideCall)
+        );
+      case "CallExpression":
+        return this.#buildChain(node.callee, true);
+      default:
+        return null;
     }
-    return [node];
-  }
-  switch (node.type) {
-    case "TaggedTemplateExpression":
-      return __privateMethod(this, _buildChain, buildChain_fn).call(this, node.tag);
-    case "MemberExpression":
-      return joinChains(
-        __privateMethod(this, _buildChain, buildChain_fn).call(this, node.object),
-        __privateMethod(this, _buildChain, buildChain_fn).call(this, node.property, insideCall)
-      );
-    case "CallExpression":
-      return __privateMethod(this, _buildChain, buildChain_fn).call(this, node.callee, true);
-    default:
-      return null;
   }
 };
 var resolvePossibleAliasedGlobal = (context, global) => {
@@ -462,8 +435,12 @@ var expect_expect_default = createRule({
   create(context) {
     const options = {
       assertFunctionNames: [],
+      assertFunctionPatterns: [],
       ...context.options?.[0] ?? {}
     };
+    const patterns = options.assertFunctionPatterns.map(
+      (pattern) => new RegExp(pattern)
+    );
     const unchecked = [];
     function checkExpressions(nodes) {
       for (const node of nodes) {
@@ -474,12 +451,21 @@ var expect_expect_default = createRule({
         }
       }
     }
+    function matches(node) {
+      if (options.assertFunctionNames.some((name) => dig(node.callee, name))) {
+        return true;
+      }
+      if (patterns.some((pattern) => dig(node.callee, pattern))) {
+        return true;
+      }
+      return false;
+    }
     return {
       CallExpression(node) {
         const call = parseFnCall(context, node);
         if (call?.type === "test") {
           unchecked.push(node);
-        } else if (call?.type === "expect" || options.assertFunctionNames.find((name) => dig(node.callee, name))) {
+        } else if (call?.type === "expect" || matches(node)) {
           const ancestors = context.sourceCode.getAncestors(node);
           checkExpressions(ancestors);
         }
@@ -508,6 +494,10 @@ var expect_expect_default = createRule({
           assertFunctionNames: {
             items: [{ type: "string" }],
             type: "array"
+          },
+          assertFunctionPatterns: {
+            items: [{ type: "string" }],
+            type: "array"
           }
         },
         type: "object"
@@ -720,14 +710,17 @@ var missing_playwright_await_default = createRule({
       // Add any custom matchers to the set
       ...options.customMatchers || []
     ]);
-    function checkValidity(node) {
+    function checkValidity(node, visited) {
       const parent = getParent(node);
       if (!parent)
         return false;
+      if (visited.has(parent))
+        return false;
+      visited.add(parent);
       if (validTypes.has(parent.type))
         return true;
       if (parent.type === "ArrayExpression") {
-        return checkValidity(parent);
+        return checkValidity(parent, visited);
       }
       if (parent.type === "CallExpression" && parent.callee.type === "MemberExpression" && isIdentifier(parent.callee.object, "Promise") && isIdentifier(parent.callee.property, "all")) {
         return true;
@@ -736,9 +729,11 @@ var missing_playwright_await_default = createRule({
         const scope = context.sourceCode.getScope(parent.parent);
         for (const ref of scope.references) {
           const refParent = ref.identifier.parent;
+          if (visited.has(refParent))
+            continue;
           if (validTypes.has(refParent.type))
             return true;
-          if (checkValidity(refParent))
+          if (checkValidity(refParent, visited))
             return true;
         }
       }
@@ -750,7 +745,7 @@ var missing_playwright_await_default = createRule({
         if (call?.type !== "step" && call?.type !== "expect")
           return;
         const result = getCallType(call, awaitableMatchers);
-        const isValid = result ? checkValidity(node) : false;
+        const isValid = result ? checkValidity(node, /* @__PURE__ */ new Set()) : false;
         if (result && !isValid) {
           context.report({
             data: result.data,
@@ -982,7 +977,7 @@ var no_duplicate_hooks_default = createRule({
         }
         const currentLayer = hookContexts[hookContexts.length - 1];
         const name = node.callee.type === "MemberExpression" ? getStringValue(node.callee.property) : "";
-        currentLayer[name] || (currentLayer[name] = 0);
+        currentLayer[name] ||= 0;
         currentLayer[name] += 1;
         if (currentLayer[name] > 1) {
           context.report({
@@ -1729,13 +1724,16 @@ var no_standalone_expect_default = createRule({
         if (call?.type === "hook") {
           callStack.push("hook");
         }
+        if (node.callee.type === "MemberExpression" && isPropertyAccessor(node.callee, "extend")) {
+          callStack.push("fixture");
+        }
         if (node.callee.type === "TaggedTemplateExpression") {
           callStack.push("template");
         }
       },
       "CallExpression:exit"(node) {
         const top = callStack.at(-1);
-        if (top === "test" && isTypeOfFnCall(context, node, ["test"]) && node.callee.type !== "MemberExpression" || top === "template" && node.callee.type === "TaggedTemplateExpression") {
+        if (top === "test" && isTypeOfFnCall(context, node, ["test"]) && node.callee.type !== "MemberExpression" || top === "template" && node.callee.type === "TaggedTemplateExpression" || top === "fixture" && node.callee.type === "MemberExpression" && isPropertyAccessor(node.callee, "extend")) {
           callStack.pop();
         }
       }
@@ -1856,6 +1854,35 @@ var no_unsafe_references_default = createRule({
   }
 });
 
+// src/rules/no-unused-locators.ts
+var LOCATOR_REGEX = /locator|getBy(Role|Text|Label|Placeholder|AltText|Title|TestId)/;
+var no_unused_locators_default = createRule({
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (!isPageMethod(node, LOCATOR_REGEX)) {
+          return;
+        }
+        if (node.parent.type === "ExpressionStatement" || node.parent.type === "AwaitExpression") {
+          context.report({ messageId: "noUnusedLocator", node });
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Possible Errors",
+      description: `Disallow usage of page locators that are not used`,
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-unused-locators.md"
+    },
+    messages: {
+      noUnusedLocator: "Unused locator"
+    },
+    type: "problem"
+  }
+});
+
 // src/rules/no-useless-await.ts
 var locatorMethods = /* @__PURE__ */ new Set([
   "and",
@@ -3857,6 +3884,9 @@ var valid_test_tags_default = createRule({
         );
       }
     }
+    const extractTagsFromTitle = (title) => {
+      return title.match(/@[\S]+/g) || [];
+    };
     const validateTag = (tag, node) => {
       if (!tag.startsWith("@")) {
         context.report({
@@ -3899,6 +3929,15 @@ var valid_test_tags_default = createRule({
         const { type } = call;
         if (type !== "test" && type !== "describe" && type !== "step")
           return;
+        if (node.arguments.length > 0) {
+          const titleArg = node.arguments[0];
+          if (titleArg && titleArg.type === "Literal" && typeof titleArg.value === "string") {
+            const titleTags = extractTagsFromTitle(titleArg.value);
+            for (const tag of titleTags) {
+              validateTag(tag, node);
+            }
+          }
+        }
         if (node.arguments.length < 2)
           return;
         const optionsArg = node.arguments[1];
@@ -3938,7 +3977,7 @@ var valid_test_tags_default = createRule({
   },
   meta: {
     docs: {
-      description: "Enforce valid tag format in Playwright test blocks",
+      description: "Enforce valid tag format in Playwright test blocks and titles",
       recommended: true
     },
     messages: {
@@ -4231,6 +4270,7 @@ var index = {
     "no-slowed-test": no_slowed_test_default,
     "no-standalone-expect": no_standalone_expect_default,
     "no-unsafe-references": no_unsafe_references_default,
+    "no-unused-locators": no_unused_locators_default,
     "no-useless-await": no_useless_await_default,
     "no-useless-not": no_useless_not_default,
     "no-wait-for-navigation": no_wait_for_navigation_default,
@@ -4278,6 +4318,7 @@ var sharedConfig = {
     "playwright/no-skipped-test": "warn",
     "playwright/no-standalone-expect": "error",
     "playwright/no-unsafe-references": "error",
+    "playwright/no-unused-locators": "error",
     "playwright/no-useless-await": "warn",
     "playwright/no-useless-not": "warn",
     "playwright/no-wait-for-navigation": "error",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "2.2.2",
+  "version": "2.4.0",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
   "author": "Mark Skelton <mark@mskelton.dev>",
   "contributors": [
@@ -9,7 +9,7 @@
   ],
   "license": "MIT",
   "engines": {
-    "node": ">=16.6.0"
+    "node": ">=16.9.0"
   },
   "type": "module",
   "types": "./index.d.ts",
@@ -30,6 +30,6 @@
     "eslint": ">=8.40.0"
   },
   "dependencies": {
-    "globals": "^13.23.0"
+    "globals": "^16.4.0"
   }
 }