eslint-plugin-playwright 2.0.1 → 2.2.0

package/README.md

@@ -139,6 +139,7 @@ CLI option\
 | [no-raw-locators](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-raw-locators.md)                         | Disallow using raw locators                                        |     |     |     |
 | [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-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-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               | ✅  | 🔧  |     |

package/dist/index.cjs

@@ -95,10 +95,12 @@ var VALID_CHAINS = /* @__PURE__ */ new Set([
   // Test
   "test",
   "test.fail",
+  "test.fail.only",
   "test.fixme",
   "test.only",
   "test.skip",
   "test.step",
+  "test.step.skip",
   "test.slow",
   "test.use"
 ]);
@@ -484,7 +486,7 @@ var expect_expect_default = createRule({
       },
       "Program:exit"() {
         unchecked.forEach((node) => {
-          context.report({ messageId: "noAssertions", node });
+          context.report({ messageId: "noAssertions", node: node.callee });
         });
       }
     };
@@ -663,6 +665,7 @@ var expectPlaywrightMatchers = [
   "toPass"
 ];
 var playwrightTestMatchers = [
+  "toBeAttached",
   "toBeChecked",
   "toBeDisabled",
   "toBeEditable",
@@ -670,23 +673,23 @@ var playwrightTestMatchers = [
   "toBeEnabled",
   "toBeFocused",
   "toBeHidden",
+  "toBeInViewport",
+  "toBeOK",
   "toBeVisible",
   "toContainText",
+  "toHaveAccessibleErrorMessage",
   "toHaveAttribute",
+  "toHaveCSS",
   "toHaveClass",
   "toHaveCount",
-  "toHaveCSS",
   "toHaveId",
   "toHaveJSProperty",
-  "toBeOK",
   "toHaveScreenshot",
   "toHaveText",
   "toHaveTitle",
   "toHaveURL",
   "toHaveValue",
-  "toHaveValues",
-  "toBeAttached",
-  "toBeInViewport"
+  "toHaveValues"
 ];
 function getReportNode(node) {
   const parent = getParent(node);
@@ -1253,18 +1256,11 @@ var no_hooks_default = createRule({
 });
 
 // src/rules/no-nested-step.ts
-function isStepCall(node) {
-  const inner = node.type === "CallExpression" ? node.callee : node;
-  if (inner.type !== "MemberExpression") {
-    return false;
-  }
-  return isPropertyAccessor(inner, "step");
-}
 var no_nested_step_default = createRule({
   create(context) {
     const stack = [];
     function pushStepCallback(node) {
-      if (node.parent.type !== "CallExpression" || !isStepCall(node.parent)) {
+      if (node.parent.type !== "CallExpression" || !isTypeOfFnCall(context, node.parent, ["step"])) {
         return;
       }
       stack.push(0);
@@ -1277,7 +1273,7 @@ var no_nested_step_default = createRule({
     }
     function popStepCallback(node) {
       const { parent } = node;
-      if (parent.type === "CallExpression" && isStepCall(parent)) {
+      if (parent.type === "CallExpression" && isTypeOfFnCall(context, parent, ["step"])) {
         stack.pop();
       }
     }
@@ -1537,7 +1533,7 @@ var no_skipped_test_default = createRule({
         const options = context.options[0] || {};
         const allowConditional = !!options.allowConditional;
         const call = parseFnCall(context, node);
-        if (call?.group !== "test" && call?.group !== "describe") {
+        if (call?.group !== "test" && call?.group !== "describe" && call?.group !== "step") {
           return;
         }
         const skipNode = call.members.find((s) => getStringValue(s) === "skip");
@@ -1593,6 +1589,70 @@ var no_skipped_test_default = createRule({
   }
 });
 
+// src/rules/no-slowed-test.ts
+var no_slowed_test_default = createRule({
+  create(context) {
+    return {
+      CallExpression(node) {
+        const options = context.options[0] || {};
+        const allowConditional = !!options.allowConditional;
+        const call = parseFnCall(context, node);
+        if (call?.group !== "test") {
+          return;
+        }
+        const slowNode = call.members.find((s) => getStringValue(s) === "slow");
+        if (!slowNode)
+          return;
+        const isStandalone = call.type === "config";
+        if (isStandalone && allowConditional) {
+          return;
+        }
+        context.report({
+          messageId: "noSlowedTest",
+          node: isStandalone ? node : slowNode,
+          suggest: [
+            {
+              fix: (fixer) => {
+                return isStandalone ? fixer.remove(node.parent) : fixer.removeRange([
+                  slowNode.range[0] - 1,
+                  slowNode.range[1] + Number(slowNode.type !== "Identifier")
+                ]);
+              },
+              messageId: "removeSlowedTestAnnotation"
+            }
+          ]
+        });
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Prevent usage of the `.slow()` slow test annotation.",
+      recommended: true,
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-slowed-test.md"
+    },
+    hasSuggestions: true,
+    messages: {
+      noSlowedTest: "Unexpected use of the `.slow()` annotation.",
+      removeSlowedTestAnnotation: "Remove the `.slow()` annotation."
+    },
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          allowConditional: {
+            default: false,
+            type: "boolean"
+          }
+        },
+        type: "object"
+      }
+    ],
+    type: "suggestion"
+  }
+});
+
 // src/rules/no-standalone-expect.ts
 var getBlockType = (context, statement) => {
   const func = getParent(statement);
@@ -2164,7 +2224,7 @@ var prefer_comparison_matcher_default = createRule({
       category: "Best Practices",
       description: "Suggest using the built-in comparison matchers",
       recommended: false,
-      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparision-matcher.md"
+      url: "https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-comparison-matcher.md"
     },
     fixable: "code",
     messages: {
@@ -3972,6 +4032,7 @@ var index = {
     "no-raw-locators": no_raw_locators_default,
     "no-restricted-matchers": no_restricted_matchers_default,
     "no-skipped-test": no_skipped_test_default,
+    "no-slowed-test": no_slowed_test_default,
     "no-standalone-expect": no_standalone_expect_default,
     "no-unsafe-references": no_unsafe_references_default,
     "no-useless-await": no_useless_await_default,

package/package.json

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