Feature add no force option rule (playwright-community#47)

* rule: add new noElementHandle rule

* chore: move end range to const

* fix: getRange method for non-awaiting statements

* test: add additional tests for the noElementHandle rule

* chore: improve noElementHandle rule

* docs: update the wording of noElementHandle rule

* rule: update message to match with other rule naming conventions

* rule: change noElementHandle to warn level

* rule: noElementHandle change fixable to suggestion

* test: add valid tests for noElementHandle rule

* rule: change type for noElementHandle to suggestion

* rule: update noElementHandle rule's message for suggestions

* rule: update noElementHandle with getRange method

* rule: add noForceOption

* docs: change Example > Examples

* test: add wrapInTest function

* chore: use helper function

Author: elaichenkov

README.md

@@ -246,3 +246,27 @@ test.describe('two tests', () => {
   test('two', async ({ page }) => {});
 });
 ```
+
+### `no-force-option`
+
+Disallow usage of the `{ force: true }` option.
+
+Examples of **incorrect** code for this rule:
+
+```js
+await page.locator('button').click({ force: true });
+
+await page.locator('check').check({ force: true });
+
+await page.locator('input').fill('something', { force: true });
+```
+
+Examples of **correct** code for this rule:
+
+```js
+await page.locator('button').click();
+
+await page.locator('check').check();
+
+await page.locator('input').fill('something');
+```

lib/index.js

@@ -5,6 +5,7 @@ const noEval = require("./rules/no-eval");
 const noFocusedTest = require("./rules/no-focused-test");
 const noSkippedTest = require("./rules/no-skipped-test");
 const noWaitForTimeout = require("./rules/no-wait-for-timeout");
+const noForceOption = require("./rules/no-force-option");
 
 module.exports = {
   configs: {
@@ -22,6 +23,7 @@ module.exports = {
         "playwright/no-focused-test": "error",
         "playwright/no-skipped-test": "warn",
         "playwright/no-wait-for-timeout": "warn",
+        "playwright/no-force-option": "warn",
       },
     },
     "jest-playwright": {
@@ -65,5 +67,6 @@ module.exports = {
     "no-focused-test": noFocusedTest,
     "no-skipped-test": noSkippedTest,
     "no-wait-for-timeout": noWaitForTimeout,
+    "no-force-option": noForceOption,
   },
 };

lib/rules/no-force-option.js

@@ -0,0 +1,52 @@
+function isForceOptionEnabled({ parent }) {
+  return (
+    parent &&
+    parent.arguments &&
+    parent.arguments.length &&
+    parent.arguments.some(
+      (argument) =>
+        argument.type === 'ObjectExpression' &&
+        argument.properties.some(({ key, value }) => key && key.name === 'force' && value && value.value === true)
+    )
+  );
+}
+
+// https://playwright.dev/docs/api/class-locator
+const methodsWithForceOption = new Set([
+  'check',
+  'uncheck',
+  'click',
+  'dblclick',
+  'dragTo',
+  'fill',
+  'hover',
+  'selectOption',
+  'selectText',
+  'setChecked',
+  'tap',
+]);
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  create(context) {
+    return {
+      MemberExpression(node) {
+        if (node.property && methodsWithForceOption.has(node.property.name) && isForceOptionEnabled(node)) {
+          context.report({ messageId: 'noForceOption', node });
+        }
+      },
+    };
+  },
+  meta: {
+    docs: {
+      category: 'Best Practices',
+      description: 'Prevent usage of `{ force: true }` option.',
+      recommended: true,
+      url: 'https://github.com/playwright-community/eslint-plugin-playwright#no-force-option',
+    },
+    messages: {
+      noForceOption: 'Unexpected use of { force: true } option.',
+    },
+    type: 'suggestion',
+  },
+};

test/no-force-option.spec.js

@@ -0,0 +1,46 @@
+const { runRuleTester, wrapInTest } = require('../lib/utils/rule-tester');
+const rule = require('../lib/rules/no-force-option');
+
+const invalid = (code) => ({
+  code: wrapInTest(code),
+  errors: [{ messageId: 'noForceOption' }],
+});
+
+const valid = (code) => ({
+  code: wrapInTest(code),
+});
+
+runRuleTester('no-force-option', rule, {
+  invalid: [
+    invalid('await page.locator("check").check({ force: true })'),
+    invalid('await page.locator("check").uncheck({ force: true })'),
+    invalid('await page.locator("button").click({ force: true })'),
+    invalid('const button = page.locator("button"); await button.click({ force: true })'),
+    invalid('await page.locator("button").locator("btn").click({ force: true })'),
+    invalid('await page.locator("button").dblclick({ force: true })'),
+    invalid('await page.locator("input").dragTo({ force: true })'),
+    invalid('await page.locator("input").fill("test", { force: true })'),
+    invalid('await page.locator("elm").hover({ force: true })'),
+    invalid('await page.locator("select").selectOption({ label: "Blue" }, { force: true })'),
+    invalid('await page.locator("select").selectText({ force: true })'),
+    invalid('await page.locator("checkbox").setChecked(true, { force: true })'),
+    invalid('await page.locator("button").tap({ force: true })'),
+  ],
+  valid: [
+    valid("await page.locator('check').check()"),
+    valid("await page.locator('check').uncheck()"),
+    valid("await page.locator('button').click()"),
+    valid("await page.locator('button').locator('btn').click()"),
+    valid("await page.locator('button').click({ delay: 500, noWaitAfter: true })"),
+    valid("await page.locator('button').dblclick()"),
+    valid("await page.locator('input').dragTo()"),
+    valid("await page.locator('input').fill('something', { timeout: 1000 })"),
+    valid("await page.locator('elm').hover()"),
+    valid("await page.locator('select').selectOption({ label: 'Blue' })"),
+    valid("await page.locator('select').selectText()"),
+    valid("await page.locator('checkbox').setChecked(true)"),
+    valid("await page.locator('button').tap()"),
+    valid('doSomething({ force: true })'),
+    valid('await doSomething({ force: true })'),
+  ],
+});