eslint-plugin-playwright 1.5.0 → 1.5.2

package/README.md

@@ -37,7 +37,7 @@ This plugin bundles two configurations to work with both `@playwright/test` or
 (**eslint.config.js**)
 
 ```javascript
-import playwright from 'eslint-plugin-playwright';
+import playwright from 'eslint-plugin-playwright'
 
 export default [
   playwright.configs['flat/recommended'],
@@ -47,7 +47,7 @@ export default [
       // ...
     },
   },
-];
+]
 ```
 
 [Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)
@@ -65,8 +65,8 @@ export default [
 (**eslint.config.js**)
 
 ```javascript
-import playwright from 'eslint-plugin-playwright';
-import jest from 'eslint-plugin-jest';
+import playwright from 'eslint-plugin-playwright'
+import jest from 'eslint-plugin-jest'
 
 export default [
   playwright.configs['flat/jest-playwright'],
@@ -79,7 +79,7 @@ export default [
       // ...
     },
   },
-];
+]
 ```
 
 [Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)

package/dist/index.js

@@ -637,7 +637,8 @@ var missing_playwright_await_default = {
     docs: {
       category: "Possible Errors",
       description: `Identify false positives when async Playwright APIs are not properly awaited.`,
-      recommended: true
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/missing-playwright-await.md"
     },
     fixable: "code",
     messages: {
@@ -1220,7 +1221,8 @@ var no_networkidle_default = {
     docs: {
       category: "Possible Errors",
       description: "Prevent usage of the networkidle option",
-      recommended: true
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-networkidle.md"
     },
     messages: {
       noNetworkidle: "Unexpected use of networkidle."
@@ -1280,7 +1282,8 @@ var no_page_pause_default = {
     docs: {
       category: "Possible Errors",
       description: "Prevent usage of page.pause()",
-      recommended: true
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-page-pause.md"
     },
     messages: {
       noPagePause: "Unexpected use of page.pause()."
@@ -1728,7 +1731,8 @@ var no_useless_await_default = {
     docs: {
       category: "Possible Errors",
       description: "Disallow unnecessary awaits for Playwright methods",
-      recommended: true
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md"
     },
     fixable: "code",
     messages: {
@@ -2005,7 +2009,8 @@ var prefer_comparison_matcher_default = {
     docs: {
       category: "Best Practices",
       description: "Suggest using the built-in comparison matchers",
-      recommended: false
+      recommended: false,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparision-matcher.md"
     },
     fixable: "code",
     messages: {
@@ -2781,7 +2786,7 @@ var require_hook_default = {
         if (!isTypeOfFnCall(context, node, ["describe"])) {
           return;
         }
-        const [, testFn] = node.arguments;
+        const testFn = node.arguments.at(-1);
         if (!isFunction(testFn) || testFn.body.type !== "BlockStatement") {
           return;
         }
@@ -2974,26 +2979,24 @@ var valid_describe_callback_default = {
         if (call.members.some((s) => getStringValue(s) === "configure")) {
           return;
         }
-        if (node.arguments.length < 1) {
+        const callback = node.arguments.at(-1);
+        if (!callback) {
           return context.report({
             loc: node.loc,
-            messageId: "nameAndCallback"
+            messageId: "missingCallback"
           });
         }
-        const [, callback] = node.arguments;
-        if (!callback) {
-          context.report({
+        if (node.arguments.length === 1 && isStringLiteral(callback)) {
+          return context.report({
             loc: paramsLocation(node.arguments),
-            messageId: "nameAndCallback"
+            messageId: "missingCallback"
           });
-          return;
         }
         if (!isFunction(callback)) {
-          context.report({
+          return context.report({
             loc: paramsLocation(node.arguments),
-            messageId: "secondArgumentMustBeFunction"
+            messageId: "invalidCallback"
           });
-          return;
         }
         if (callback.async) {
           context.report({
@@ -3001,7 +3004,7 @@ var valid_describe_callback_default = {
             node: callback
           });
         }
-        if (call.members.every((s) => getStringValue(s) !== "each") && callback.params.length) {
+        if (callback.params.length) {
           context.report({
             loc: paramsLocation(callback.params),
             messageId: "unexpectedDescribeArgument"
@@ -3034,9 +3037,9 @@ var valid_describe_callback_default = {
       url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-describe-callback.md"
     },
     messages: {
-      nameAndCallback: "Describe requires name and callback arguments",
+      invalidCallback: "Callback argument must be a function",
+      missingCallback: "Describe requires a callback",
       noAsyncDescribeCallback: "No async describe callback",
-      secondArgumentMustBeFunction: "Second argument must be function",
       unexpectedDescribeArgument: "Unexpected argument(s) in describe callback",
       unexpectedReturnInDescribe: "Unexpected return statement in describe callback"
     },

package/dist/index.mjs

@@ -661,7 +661,8 @@ var init_missing_playwright_await = __esm({
         docs: {
           category: "Possible Errors",
           description: `Identify false positives when async Playwright APIs are not properly awaited.`,
-          recommended: true
+          recommended: true,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/missing-playwright-await.md"
         },
         fixable: "code",
         messages: {
@@ -1331,7 +1332,8 @@ var init_no_networkidle = __esm({
         docs: {
           category: "Possible Errors",
           description: "Prevent usage of the networkidle option",
-          recommended: true
+          recommended: true,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-networkidle.md"
         },
         messages: {
           noNetworkidle: "Unexpected use of networkidle."
@@ -1405,7 +1407,8 @@ var init_no_page_pause = __esm({
         docs: {
           category: "Possible Errors",
           description: "Prevent usage of page.pause()",
-          recommended: true
+          recommended: true,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-page-pause.md"
         },
         messages: {
           noPagePause: "Unexpected use of page.pause()."
@@ -1905,7 +1908,8 @@ var init_no_useless_await = __esm({
         docs: {
           category: "Possible Errors",
           description: "Disallow unnecessary awaits for Playwright methods",
-          recommended: true
+          recommended: true,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md"
         },
         fixable: "code",
         messages: {
@@ -2221,7 +2225,8 @@ var init_prefer_comparison_matcher = __esm({
         docs: {
           category: "Best Practices",
           description: "Suggest using the built-in comparison matchers",
-          recommended: false
+          recommended: false,
+          url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparision-matcher.md"
         },
         fixable: "code",
         messages: {
@@ -3086,7 +3091,7 @@ var init_require_hook = __esm({
             if (!isTypeOfFnCall(context, node, ["describe"])) {
               return;
             }
-            const [, testFn] = node.arguments;
+            const testFn = node.arguments.at(-1);
             if (!isFunction(testFn) || testFn.body.type !== "BlockStatement") {
               return;
             }
@@ -3311,26 +3316,24 @@ var init_valid_describe_callback = __esm({
             if (call.members.some((s) => getStringValue(s) === "configure")) {
               return;
             }
-            if (node.arguments.length < 1) {
+            const callback = node.arguments.at(-1);
+            if (!callback) {
               return context.report({
                 loc: node.loc,
-                messageId: "nameAndCallback"
+                messageId: "missingCallback"
               });
             }
-            const [, callback] = node.arguments;
-            if (!callback) {
-              context.report({
+            if (node.arguments.length === 1 && isStringLiteral(callback)) {
+              return context.report({
                 loc: paramsLocation(node.arguments),
-                messageId: "nameAndCallback"
+                messageId: "missingCallback"
               });
-              return;
             }
             if (!isFunction(callback)) {
-              context.report({
+              return context.report({
                 loc: paramsLocation(node.arguments),
-                messageId: "secondArgumentMustBeFunction"
+                messageId: "invalidCallback"
               });
-              return;
             }
             if (callback.async) {
               context.report({
@@ -3338,7 +3341,7 @@ var init_valid_describe_callback = __esm({
                 node: callback
               });
             }
-            if (call.members.every((s) => getStringValue(s) !== "each") && callback.params.length) {
+            if (callback.params.length) {
               context.report({
                 loc: paramsLocation(callback.params),
                 messageId: "unexpectedDescribeArgument"
@@ -3371,9 +3374,9 @@ var init_valid_describe_callback = __esm({
           url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-describe-callback.md"
         },
         messages: {
-          nameAndCallback: "Describe requires name and callback arguments",
+          invalidCallback: "Callback argument must be a function",
+          missingCallback: "Describe requires a callback",
           noAsyncDescribeCallback: "No async describe callback",
-          secondArgumentMustBeFunction: "Second argument must be function",
           unexpectedDescribeArgument: "Unexpected argument(s) in describe callback",
           unexpectedReturnInDescribe: "Unexpected return statement in describe callback"
         },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
   "author": "Mark Skelton <mark@mskelton.dev>",
   "packageManager": "pnpm@8.12.0",
@@ -32,8 +32,8 @@
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --out-dir dist",
     "lint": "eslint .",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
+    "fmt": "prettier --write .",
+    "fmt:check": "prettier --check .",
     "test": "vitest",
     "test:watch": "vitest --reporter=dot",
     "ts": "tsc --noEmit"