eslint-plugin-playwright 2.3.0 → 2.4.1

package/LICENSE

@@ -1,21 +1,20 @@
 MIT License
 
-Copyright (c) 2024 Max Schmitt
+Copyright (c) 2024 Mark Skelton
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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)

package/dist/index.cjs

@@ -435,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) {
@@ -447,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);
         }
@@ -481,6 +494,10 @@ var expect_expect_default = createRule({
           assertFunctionNames: {
             items: [{ type: "string" }],
             type: "array"
+          },
+          assertFunctionPatterns: {
+            items: [{ type: "string" }],
+            type: "array"
           }
         },
         type: "object"
@@ -693,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;
@@ -709,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;
         }
       }
@@ -723,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,
@@ -899,6 +921,9 @@ var no_conditional_expect_default = createRule({
 var no_conditional_in_test_default = createRule({
   create(context) {
     function checkConditional(node) {
+      if (node.type === "LogicalExpression" && node.operator === "??") {
+        return;
+      }
       const call = findParent(node, "CallExpression");
       if (!call)
         return;
@@ -1702,13 +1727,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();
         }
       }

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "2.3.0",
-  "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
+  "version": "2.4.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mskelton/eslint-plugin-playwright.git"
+  },
   "author": "Mark Skelton <mark@mskelton.dev>",
+  "packageManager": "pnpm@8.12.0",
   "contributors": [
     "Max Schmitt <max@schmitt.mx>"
   ],
@@ -26,10 +30,33 @@
     "index.cjs",
     "index.d.ts"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs --out-dir dist",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest --run --hideSkippedTests",
+    "test:watch": "vitest --reporter=dot --run",
+    "ts": "tsc --noEmit"
+  },
   "peerDependencies": {
     "eslint": ">=8.40.0"
   },
   "dependencies": {
     "globals": "^16.4.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",
+    "eslint": "^9.13.0",
+    "prettier": "^3.0.3",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "semantic-release": "^25.0.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.2.2",
+    "vitest": "^1.6.1"
   }
 }