feat: Add no-restricted-locators rule

Fixes #407

Author: mskelton

README.md

@@ -138,6 +138,7 @@ CLI option\
 | [no-nth-methods](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-nth-methods.md)                           | Disallow usage of `first()`, `last()`, and `nth()` methods         |     |     |     |
 | [no-page-pause](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-page-pause.md)                             | Disallow using `page.pause()`                                      | ✅  |     |     |
 | [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-locators](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-restricted-locators.md)           | Disallow specific locator methods                                  |     |     |     |
 | [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                           |     |     | 💡  |

docs/rules/no-restricted-locators.md

@@ -0,0 +1,128 @@
+## Disallow specific locator methods (`no-restricted-locators`)
+
+This rule bans specific locator methods from being used, and can suggest
+alternatives.
+
+## Rule Details
+
+Bans are expressed in the form of an array, where each element can be either:
+
+- A string: the method name to restrict (uses default message)
+- An object: `{ type: "methodName", message: "Custom message" }` (optional
+  message)
+
+By default, the array is empty, meaning no locator methods are banned.
+
+For example:
+
+```json
+{
+  "playwright/no-restricted-locators": [
+    "error",
+    [
+      "getByTestId",
+      {
+        "type": "getByTitle",
+        "message": "Prefer getByRole or getByLabel instead"
+      }
+    ]
+  ]
+}
+```
+
+Examples of **incorrect** code for this rule with the above configuration:
+
+```javascript
+test('find button', async () => {
+  await page.getByTestId('submit-button')
+})
+
+test('find tooltip', async () => {
+  await page.getByTitle('Additional info')
+})
+```
+
+Examples of **correct** code for this rule with the above configuration:
+
+```javascript
+test('find button', async () => {
+  await page.getByRole('button', { name: 'Submit' })
+})
+
+test('find tooltip', async () => {
+  await page.getByLabel('Additional info')
+})
+```
+
+## Options
+
+The rule accepts an array where each element can be:
+
+### String format
+
+A simple string with the method name to restrict:
+
+```json
+{
+  "playwright/no-restricted-locators": ["error", ["getByTestId", "getByTitle"]]
+}
+```
+
+### Object format
+
+An object with `type` (required) and optional `message`:
+
+```json
+{
+  "playwright/no-restricted-locators": [
+    "error",
+    [
+      {
+        "type": "getByTestId",
+        "message": "Prefer getByRole or getByLabel instead"
+      },
+      { "type": "getByTitle" }
+    ]
+  ]
+}
+```
+
+### Mixed format
+
+You can mix string and object entries in the same array:
+
+```json
+{
+  "playwright/no-restricted-locators": [
+    "error",
+    [
+      "getByTestId",
+      {
+        "type": "getByTitle",
+        "message": "Prefer getByRole or getByLabel instead"
+      }
+    ]
+  ]
+}
+```
+
+## Common Locator Methods
+
+Common locator methods that can be restricted:
+
+- `getByTestId` - Find elements by test ID attribute
+- `getByTitle` - Find elements by title attribute
+- `getByAltText` - Find elements by alt text
+- `getByPlaceholder` - Find elements by placeholder text
+- `getByLabel` - Find elements by label
+- `getByRole` - Find elements by ARIA role
+- `getByText` - Find elements by text content
+
+## When to Use This Rule
+
+This rule is useful when:
+
+- Your team wants to discourage certain locator methods (e.g., `getByTestId` for
+  accessibility reasons)
+- You want to enforce consistent locator strategies across your test suite
+- You need to provide custom guidance on which alternatives to use

src/index.ts

@@ -18,6 +18,7 @@ import noNetworkidle from './rules/no-networkidle.js'
 import noNthMethods from './rules/no-nth-methods.js'
 import noPagePause from './rules/no-page-pause.js'
 import noRawLocators from './rules/no-raw-locators.js'
+import noRestrictedLocators from './rules/no-restricted-locators.js'
 import noRestrictedMatchers from './rules/no-restricted-matchers.js'
 import noSkippedTest from './rules/no-skipped-test.js'
 import noSlowedTest from './rules/no-slowed-test.js'
@@ -74,6 +75,7 @@ const index = {
     'no-nth-methods': noNthMethods,
     'no-page-pause': noPagePause,
     'no-raw-locators': noRawLocators,
+    'no-restricted-locators': noRestrictedLocators,
     'no-restricted-matchers': noRestrictedMatchers,
     'no-skipped-test': noSkippedTest,
     'no-slowed-test': noSlowedTest,