Utils: add runRuleTester helper function

lib/utils/rule-tester.js

@@ -0,0 +1,34 @@
+const { RuleTester } = require('eslint');
+
+/**
+ *
+ * @param {string} name - The name of the rule
+ * @param {string} rule - Path to the rule to test
+ * @param {Object} tests - The tests to run
+ * @param {string[]} tests.valid - Valid tests
+ * @param {string[]} tests.invalid - Invalid tests
+ *
+ * @example
+ * const rule = require('../lib/rules/missing-playwright-await');
+ *
+ * runRuleTester('missing-playwright-await', rule, {
+ *   valid: ['await expect(page.locator('checkbox')).toBeChecked()'],
+ *   invalid: ['expect(page.locator('checkbox')).toBeChecked()'],
+ * });
+ */
+function runRuleTester(name, rule, tests) {
+  const config = {
+    parserOptions: {
+      ecmaVersion: 2018,
+    },
+  };
+
+  return new RuleTester(config).run(name, rule, tests);
+}
+
+const wrapInTest = (input) => `test('test', async () => { ${input} })`;
+
+module.exports = {
+  runRuleTester,
+  wrapInTest,
+};

test/missing-playwright-await.spec.js

@@ -1,13 +1,5 @@
-const { RuleTester } = require("eslint");
-const rule = require("../lib/rules/missing-playwright-await");
-
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
-const wrapInTest = (input) => `test('a', async () => { ${input} })`;
+const { runRuleTester, wrapInTest } = require('../lib/utils/rule-tester');
+const rule = require('../lib/rules/missing-playwright-await');
 
 const invalid = (messageId, code, output, options = []) => ({
   code: wrapInTest(code),
@@ -21,53 +13,28 @@ const valid = (code, options = []) => ({
   options,
 });
 
-const options = [{ customMatchers: ["toBeCustomThing"] }];
+const options = [{ customMatchers: ['toBeCustomThing'] }];
 
-new RuleTester().run("missing-playwright-await", rule, {
+runRuleTester('missing-playwright-await', rule, {
   invalid: [
-    invalid(
-      "expect",
-      "expect(page).toBeChecked()",
-      "await expect(page).toBeChecked()"
-    ),
-    invalid(
-      "expect",
-      "expect(page).not.toBeEnabled()",
-      "await expect(page).not.toBeEnabled()"
-    ),
+    invalid('expect', 'expect(page).toBeChecked()', 'await expect(page).toBeChecked()'),
+    invalid('expect', 'expect(page).not.toBeEnabled()', 'await expect(page).not.toBeEnabled()'),
 
     // Custom matchers
+    invalid('expect', 'expect(page).toBeCustomThing(false)', 'await expect(page).toBeCustomThing(false)', options),
     invalid(
-      "expect",
-      "expect(page).toBeCustomThing(false)",
-      "await expect(page).toBeCustomThing(false)",
-      options
-    ),
-    invalid(
-      "expect",
-      "expect(page).not.toBeCustomThing(true)",
-      "await expect(page).not.toBeCustomThing(true)",
+      'expect',
+      'expect(page).not.toBeCustomThing(true)',
+      'await expect(page).not.toBeCustomThing(true)',
       options
     ),
 
     // expect.soft
-    invalid(
-      "expect",
-      "expect.soft(page).toBeChecked()",
-      "await expect.soft(page).toBeChecked()"
-    ),
-    invalid(
-      "expect",
-      "expect.soft(page).toBeChecked()",
-      "await expect.soft(page).toBeChecked()"
-    ),
+    invalid('expect', 'expect.soft(page).toBeChecked()', 'await expect.soft(page).toBeChecked()'),
+    invalid('expect', 'expect.soft(page).toBeChecked()', 'await expect.soft(page).toBeChecked()'),
 
     // test.step
-    invalid(
-      "testStep",
-      "test.step('foo', async () => {})",
-      "await test.step('foo', async () => {})"
-    ),
+    invalid('testStep', "test.step('foo', async () => {})", "await test.step('foo', async () => {})"),
   ],
   valid: [
     valid('await expect(page).toEqualTitle("text")'),
@@ -81,11 +48,11 @@ new RuleTester().run("missing-playwright-await", rule, {
     },
 
     // Custom matchers
-    valid("await expect(page).toBeCustomThing(true)", options),
-    valid("await expect(page).toBeCustomThing(true)", options),
-    valid("await expect(page).toBeCustomThing(true)", options),
-    valid("await expect(page).toBeCustomThing(true)"),
-    valid("expect(page).toBeCustomThing(true)"),
+    valid('await expect(page).toBeCustomThing(true)', options),
+    valid('await expect(page).toBeCustomThing(true)', options),
+    valid('await expect(page).toBeCustomThing(true)', options),
+    valid('await expect(page).toBeCustomThing(true)'),
+    valid('expect(page).toBeCustomThing(true)'),
 
     // expect.soft
     valid('await expect.soft(page).toHaveText("text")'),

test/no-element-handle.spec.js

@@ -1,14 +1,6 @@
-const { RuleTester } = require('eslint');
+const { runRuleTester, wrapInTest } = require('../lib/utils/rule-tester');
 const rule = require('../lib/rules/no-element-handle');
 
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
-const wrapInTest = (input) => `test('verify noElementHandle rule', async () => { ${input} })`;
-
 const invalid = (code, output) => ({
   code: wrapInTest(code),
   errors: [
@@ -28,7 +20,7 @@ const valid = (code) => ({
   code: wrapInTest(code),
 });
 
-new RuleTester().run('no-element-handle', rule, {
+runRuleTester('no-element-handle', rule, {
   invalid: [
     // element handle as const
     invalid('const handle = await page.$("text=Submit");', 'const handle = page.locator("text=Submit");'),

test/no-eval.spec.js

@@ -1,14 +1,6 @@
-const { RuleTester } = require('eslint');
+const { runRuleTester, wrapInTest } = require('../lib/utils/rule-tester');
 const rule = require('../lib/rules/no-eval');
 
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
-const wrapInTest = (input) => `test('verify noEval rule', async () => { ${input} })`;
-
 const invalid = (code) => ({
   code: wrapInTest(code),
   errors: [{ messageId: code.includes('page.$eval') ? 'noEval' : 'noEvalAll' }],
@@ -18,7 +10,7 @@ const valid = (code) => ({
   code: wrapInTest(code),
 });
 
-new RuleTester().run('no-eval', rule, {
+runRuleTester('no-eval', rule, {
   invalid: [
     // $eval with no arguments as const
     invalid('const searchValue = await page.$eval("#search", el => el.value);'),

test/no-focused-test.spec.js

@@ -1,12 +1,6 @@
-const { RuleTester } = require('eslint');
+const { runRuleTester } = require('../lib/utils/rule-tester');
 const rule = require('../lib/rules/no-focused-test');
 
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
 const invalid = (code, output) => ({
   code,
   errors: [
@@ -17,12 +11,9 @@ const invalid = (code, output) => ({
   ],
 });
 
-new RuleTester().run('no-focused-test', rule, {
+runRuleTester('no-focused-test', rule, {
   invalid: [
-    invalid(
-      'test.describe.only("skip this describe", () => {});',
-      'test.describe("skip this describe", () => {});'
-    ),
+    invalid('test.describe.only("skip this describe", () => {});', 'test.describe("skip this describe", () => {});'),
 
     invalid(
       'test.describe.parallel.only("skip this describe", () => {});',
@@ -34,10 +25,7 @@ new RuleTester().run('no-focused-test', rule, {
       'test.describe.serial("skip this describe", () => {});'
     ),
 
-    invalid(
-      'test.only("skip this test", async ({ page }) => {});',
-      'test("skip this test", async ({ page }) => {});'
-    ),
+    invalid('test.only("skip this test", async ({ page }) => {});', 'test("skip this test", async ({ page }) => {});'),
   ],
   valid: [
     'test.describe("describe tests", () => {});',

test/no-page-pause.spec.js

@@ -1,27 +1,16 @@
-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 { runRuleTester, wrapInTest } = require('../lib/utils/rule-tester');
+const rule = require('../lib/rules/no-page-pause');
 
 const invalid = (code) => ({
   code: wrapInTest(code),
-  errors: [{ messageId: "noPagePause" }],
+  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()"),
-  ],
+runRuleTester('no-page-pause', rule, {
+  invalid: [invalid('await page.pause()')],
+  valid: [valid('await page.click()'), valid('await expect(page).toBePaused()')],
 });

test/no-skipped-test.spec.js

@@ -1,12 +1,6 @@
-const { RuleTester } = require('eslint');
+const { runRuleTester } = require('../lib/utils/rule-tester');
 const rule = require('../lib/rules/no-skipped-test');
 
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
 const invalid = (code, output) => ({
   code,
   errors: [
@@ -17,7 +11,7 @@ const invalid = (code, output) => ({
   ],
 });
 
-new RuleTester().run('no-skipped-test', rule, {
+runRuleTester('no-skipped-test', rule, {
   invalid: [
     invalid('test.skip("skip this test", async ({ page }) => {});', 'test("skip this test", async ({ page }) => {});'),
     invalid('test.describe.skip("skip this describe", () => {});', 'test.describe("skip this describe", () => {});'),

test/no-wait-for-timeout.spec.js

@@ -1,12 +1,6 @@
-const { RuleTester } = require('eslint');
+const { runRuleTester } = require('../lib/utils/rule-tester');
 const rule = require('../lib/rules/no-wait-for-timeout');
 
-RuleTester.setDefaultConfig({
-  parserOptions: {
-    ecmaVersion: 2018,
-  },
-});
-
 const invalid = (code, output) => ({
   code,
   errors: [
@@ -17,7 +11,7 @@ const invalid = (code, output) => ({
   ],
 });
 
-new RuleTester().run('no-wait-for-timeout', rule, {
+runRuleTester('no-wait-for-timeout', rule, {
   invalid: [
     invalid(`async function fn() { await page.waitForTimeout(1000) }`, 'async function fn() {  }'),
     invalid('async function fn() { return page.waitForTimeout(1000); }', 'async function fn() {  }'),