Add no page pause rule (#35)

Author: mskelton

README.md

@@ -79,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');
+```
+

lib/index.js

@@ -10,6 +10,7 @@ module.exports = {
       rules: {
         "no-empty-pattern": "off",
         "playwright/missing-playwright-await": "error",
+        "playwright/no-page-pause": "warn",
       },
     },
     "jest-playwright": {
@@ -20,6 +21,7 @@ module.exports = {
       },
       rules: {
         "playwright/missing-playwright-await": "error",
+        "playwright/no-page-pause": "warn",
         "jest/no-standalone-expect": [
           "error",
           {
@@ -46,5 +48,6 @@ module.exports = {
   },
   rules: {
     "missing-playwright-await": missingPlaywrightAwait,
+    "no-page-pause": noPagePause,
   },
 };

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",
+  },
+};

test/no-page-pause.spec.js

@@ -0,0 +1,27 @@
+const { RuleTester } = require("eslint");
+const rule = require("../lib/rules/no-page-pause");
+
+RuleTester.setDefaultConfig({
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+});
+
+const wrapInTest = (input) => `test('a', async () => { ${input} })`;
+
+const invalid = (code) => ({
+  code: wrapInTest(code),
+  errors: [{ messageId: "noPagePause" }],
+});
+
+const valid = (code) => ({
+  code: wrapInTest(code),
+});
+
+new RuleTester().run("no-page-pause", rule, {
+  invalid: [invalid("await page.pause()")],
+  valid: [
+    valid("await page.click()"),
+    valid("await expect(page).toBePaused()"),
+  ],
+});