eslint-plugin-playwright 0.15.2 → 0.16.0

package/README.md

@@ -47,6 +47,32 @@ This plugin bundles two configurations to work with both `@playwright/test` or
 }
 ```
 
+## Global Settings
+
+The plugin reads global settings from your ESLint configuration's shared data
+under the `playwright` key. It supports the following settings:
+
+- `additionalAssertFunctionNames`: an array of function names to treat as
+  assertion functions for the case of rules like `expect-expect`, which enforces
+  the presence of at least one assertion per test case. This allows such rules
+  to recognise custom assertion functions as valid assertions. The global
+  setting applies to all modules. The
+  [`expect-expect` rule accepts an option by the same name](./rules/expect-expect.md#additionalassertfunctionnames)
+  to enable per-module configuration (.e.g, for module-specific custom assert
+  functions).
+
+You can configure these settings like so:
+
+```json
+{
+  "settings": {
+    "playwright": {
+      "additionalAssertFunctionNames": ["assertCustomCondition"]
+    }
+  }
+}
+```
+
 ## List of Supported Rules
 
 ✔: Enabled in the recommended configuration.\

package/lib/index.js

@@ -11,6 +11,7 @@ const no_nested_step_1 = require("./rules/no-nested-step");
 const no_networkidle_1 = require("./rules/no-networkidle");
 const no_nth_methods_1 = require("./rules/no-nth-methods");
 const no_page_pause_1 = require("./rules/no-page-pause");
+const no_raw_locators_1 = require("./rules/no-raw-locators");
 const no_restricted_matchers_1 = require("./rules/no-restricted-matchers");
 const no_skipped_test_1 = require("./rules/no-skipped-test");
 const no_useless_await_1 = require("./rules/no-useless-await");
@@ -101,6 +102,7 @@ module.exports = {
         'no-networkidle': no_networkidle_1.default,
         'no-nth-methods': no_nth_methods_1.default,
         'no-page-pause': no_page_pause_1.default,
+        'no-raw-locators': no_raw_locators_1.default,
         'no-restricted-matchers': no_restricted_matchers_1.default,
         'no-skipped-test': no_skipped_test_1.default,
         'no-useless-await': no_useless_await_1.default,

package/lib/rules/expect-expect.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ast_1 = require("../utils/ast");
+const misc_1 = require("../utils/misc");
+function isAssertionCall(node, additionalAssertFunctionNames) {
+    return ((0, ast_1.isExpectCall)(node) ||
+        additionalAssertFunctionNames.find((name) => (0, ast_1.isIdentifier)(node.callee, name)));
+}
 exports.default = {
     create(context) {
         const unchecked = [];
+        const additionalAssertFunctionNames = (0, misc_1.getAdditionalAssertFunctionNames)(context);
         function checkExpressions(nodes) {
             for (const node of nodes) {
                 const index = node.type === 'CallExpression' ? unchecked.indexOf(node) : -1;
@@ -18,7 +24,7 @@ exports.default = {
                 if ((0, ast_1.isTest)(node, ['fixme', 'only', 'skip'])) {
                     unchecked.push(node);
                 }
-                else if ((0, ast_1.isExpectCall)(node)) {
+                else if (isAssertionCall(node, additionalAssertFunctionNames)) {
                     checkExpressions(context.getAncestors());
                 }
             },
@@ -39,6 +45,18 @@ exports.default = {
         messages: {
             noAssertions: 'Test has no assertions',
         },
+        schema: [
+            {
+                additionalProperties: false,
+                properties: {
+                    additionalAssertFunctionNames: {
+                        items: [{ type: 'string' }],
+                        type: 'array',
+                    },
+                },
+                type: 'object',
+            },
+        ],
         type: 'problem',
     },
 };

package/lib/rules/no-raw-locators.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ast_1 = require("../utils/ast");
+exports.default = {
+    create(context) {
+        return {
+            CallExpression(node) {
+                if (node.callee.type !== 'MemberExpression')
+                    return;
+                const method = (0, ast_1.getStringValue)(node.callee.property);
+                if ((0, ast_1.isPageMethod)(node, 'locator') || method === 'locator') {
+                    context.report({ messageId: 'noRawLocator', node });
+                }
+            },
+        };
+    },
+    meta: {
+        docs: {
+            category: 'Best Practices',
+            description: 'Disallows the usage of raw locators',
+            recommended: false,
+            url: 'https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-raw-locators.md',
+        },
+        messages: {
+            noRawLocator: 'Usage of raw locator detected. Use methods like .getByRole() or .getByText() instead of raw locators.',
+        },
+        type: 'suggestion',
+    },
+};

package/lib/utils/ast.js

@@ -95,7 +95,7 @@ function isTestHook(node) {
 exports.isTestHook = isTestHook;
 const expectSubCommands = new Set(['soft', 'poll']);
 function getExpectType(node) {
-    if (isIdentifier(node.callee, /^expect|Expect$/)) {
+    if (isIdentifier(node.callee, /(^expect|Expect)$/)) {
         return 'standalone';
     }
     if (node.callee.type === 'MemberExpression' &&

package/lib/utils/misc.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAmountData = void 0;
+exports.getAdditionalAssertFunctionNames = exports.getAmountData = void 0;
 const getAmountData = (amount) => ({
     amount: amount.toString(),
     s: amount === 1 ? '' : 's',
 });
 exports.getAmountData = getAmountData;
+function getAdditionalAssertFunctionNames(context) {
+    const globalSettings = context.settings.playwright?.additionalAssertFunctionNames ??
+        [];
+    const ruleSettings = context.options[0]
+        ?.additionalAssertFunctionNames ?? [];
+    return [...globalSettings, ...ruleSettings];
+}
+exports.getAdditionalAssertFunctionNames = getAdditionalAssertFunctionNames;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "0.15.2",
+  "version": "0.16.0",
   "packageManager": "pnpm@8.4.0",
   "main": "lib/index.js",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",