eslint-plugin-playwright 0.5.2 → 0.8.0

package/README.md

@@ -43,7 +43,7 @@ This plugin bundles two configurations to work with both `@playwright/test` or `
 
 ### `missing-playwright-await` 🔧
 
-Enforce Playwright expect statements to be awaited.
+Identify false positives when async Playwright APIs are not properly awaited.
 
 #### Example
 
@@ -51,17 +51,25 @@ Example of **incorrect** code for this rule:
 
 ```js
 expect(page).toMatchText("text");
+
+test.step("clicks the button", async () => {
+  await page.click("button");
+});
 ```
 
 Example of **correct** code for this rule:
 
 ```js
 await expect(page).toMatchText("text");
+
+await test.step("clicks the button", async () => {
+  await page.click("button");
+});
 ```
 
 #### Options
 
-The rule accepts a non-required option which can be used to specify custom matchers which this rule should also warn about. This is useful when creating your own async matchers.
+The rule accepts a non-required option which can be used to specify custom matchers which this rule should also warn about. This is useful when creating your own async `expect` matchers.
 
 ```json
 {
@@ -71,3 +79,22 @@ The rule accepts a non-required option which can be used to specify custom match
   ]
 }
 ```
+### `no-page-pause`
+
+Prevent usage of `page.pause()`.
+
+#### Example
+
+Example of **incorrect** code for this rule:
+
+```js
+await page.click('button');
+await page.pause();
+```
+
+Example of **correct** code for this rule:
+
+```js
+await page.click('button');
+```
+

package/lib/index.js

@@ -1,4 +1,5 @@
 const missingPlaywrightAwait = require("./rules/missing-playwright-await");
+const noPagePause = require("./rules/no-page-pause");
 
 module.exports = {
   configs: {
@@ -10,6 +11,7 @@ module.exports = {
       rules: {
         "no-empty-pattern": "off",
         "playwright/missing-playwright-await": "error",
+        "playwright/no-page-pause": "warn",
       },
     },
     "jest-playwright": {
@@ -20,6 +22,7 @@ module.exports = {
       },
       rules: {
         "playwright/missing-playwright-await": "error",
+        "playwright/no-page-pause": "warn",
         "jest/no-standalone-expect": [
           "error",
           {
@@ -46,5 +49,6 @@ module.exports = {
   },
   rules: {
     "missing-playwright-await": missingPlaywrightAwait,
+    "no-page-pause": noPagePause,
   },
 };

package/lib/rules/missing-playwright-await.js

@@ -1,18 +1,25 @@
-function getPromiseMemberExpressionNode(node, matchers) {
-  if (node.property.type === "Identifier" && matchers.has(node.property.name)) {
-    return node;
+function getMemberPartName(node, part) {
+  return node[part].type === "Identifier" ? node[part].name : undefined;
+}
+
+function getMemberExpressionNode(node, matchers) {
+  const propertyName = getMemberPartName(node, "property");
+
+  if (getMemberPartName(node, "object") === "test") {
+    return propertyName === "step" ? { node, type: "testStep" } : undefined;
   }
+
+  return matchers.has(propertyName) ? { node, type: "expect" } : undefined;
 }
 
-function isValidExpect(node) {
-  const parentType =
+function isValid(node) {
+  const grandparentType =
     node.parent && node.parent.parent && node.parent.parent.type;
 
-  // Don't report on nodes which are already awaited or returned
   return (
-    parentType === "AwaitExpression" ||
-    parentType === "ReturnStatement" ||
-    parentType === "ArrowFunctionExpression"
+    grandparentType === "AwaitExpression" ||
+    grandparentType === "ReturnStatement" ||
+    grandparentType === "ArrowFunctionExpression"
   );
 }
 
@@ -51,11 +58,11 @@ const playwrightTestMatchers = [
   "toHaveCSS",
   "toHaveId",
   "toHaveJSProperty",
+  "toBeOK",
   "toHaveText",
   "toHaveTitle",
   "toHaveURL",
   "toHaveValue",
-  "toMatchSnapshot",
 ];
 
 module.exports = {
@@ -70,28 +77,28 @@ module.exports = {
 
     return {
       MemberExpression(statement) {
-        const node = getPromiseMemberExpressionNode(statement, matchers);
-        if (!node || isValidExpect(node)) return;
+        const result = getMemberExpressionNode(statement, matchers);
 
-        context.report({
-          fix(fixer) {
-            return fixer.insertTextBefore(node, "await ");
-          },
-          messageId: "missingAwait",
-          node,
-        });
+        if (result && !isValid(result.node)) {
+          context.report({
+            fix: (fixer) => fixer.insertTextBefore(result.node, "await "),
+            messageId: result.type,
+            node: result.node,
+          });
+        }
       },
     };
   },
   meta: {
     docs: {
       category: "Possible Errors",
-      description: "Enforce expect-playwright matchers to be awaited.",
+      description: `Identify false positives when async Playwright APIs are not properly awaited.`,
       recommended: true,
     },
     fixable: "code",
     messages: {
-      missingAwait: "expect-playwright matchers must be awaited or returned.",
+      expect: "'expect' matchers must be awaited or returned.",
+      testStep: "'test.step' must be awaited or returned.",
     },
     schema: [
       {

package/lib/rules/no-page-pause.js

@@ -0,0 +1,22 @@
+module.exports = {
+  create(context) {
+    return {
+      MemberExpression(node) {
+        if (node.object.name === "page" && node.property.name === "pause") {
+          context.report({ messageId: "noPagePause", node });
+        }
+      },
+    };
+  },
+  meta: {
+    docs: {
+      category: "Possible Errors",
+      description: "Prevent usage of page.pause()",
+      recommended: true,
+    },
+    messages: {
+      noPagePause: "Unexpected use of page.pause().",
+    },
+    type: "problem",
+  },
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "0.5.2",
+  "version": "0.8.0",
   "main": "lib/index.js",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
   "author": "Max Schmitt <max@schmitt.mx>",
@@ -13,8 +13,8 @@
     "test": "jest"
   },
   "devDependencies": {
-    "eslint": "^7.25.0",
-    "jest": "^27.0.6"
+    "eslint": "^8.4.1",
+    "jest": "^27.4.5"
   },
   "peerDependencies": {
     "eslint": ">=7",