eslint-plugin-wdio 7.17.3 → 7.17.4

package/README.md

@@ -22,15 +22,23 @@ npm install eslint-plugin-wdio --save-dev
 
 This plugin export a recommended configuration that enforce good practices.
 
-To enable this configuration use the extends property in your .eslintrc config file:
+To enable this configuration use the extends property in your `.eslintrc` config file:
 
 ```json
 {
-  "plugins": [
-    "wdio"
-  ],
-  "extends": "plugin:wdio/recommended"
+    "extends": [
+        "eslint:recommended",
+        "plugin:wdio/recommended"
+    ]
 }
 ```
 
 See [ESLint documentation](https://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information about extending configuration files.
+
+## List of supported rules
+
+| Rule | Description |
+| :--- | :--- |
+| [wdio/await-expect](docs/rules/await-expect.md) | `expect` calls must be prefixed with an `await` |
+| [wdio/no-debug](docs/rules/no-debug.md) | Don't allow `browser.debug()` statements |
+| [wdio/no-pause](docs/rules/no-pause.md) | Don't allow `browser.pause(<number>)` statements |

package/build/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const MATCHERS: string[];
+//# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,UAgCpB,CAAA"}

package/build/constants.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MATCHERS = void 0;
+exports.MATCHERS = [
+    'toHaveTitle',
+    'toHaveTitleContaining',
+    'toHaveUrl',
+    'toHaveUrlContaining',
+    'toBeClickable',
+    'toBeDisabled',
+    'toBeDisplayed',
+    'toBeDisplayedInViewport',
+    'toBeEnabled',
+    'toBeExisting',
+    'toBeFocused',
+    'toBeSelected',
+    'toHaveAttribute',
+    'toHaveAttributeContaining',
+    'toHaveChildren',
+    'toHaveElementClass',
+    'toHaveElementClassContaining',
+    'toHaveElementProperty',
+    'toHaveHref',
+    'toHaveHrefContaining',
+    'toHaveId',
+    'toHaveStyle',
+    'toHaveText',
+    'toHaveTextContaining',
+    'toHaveValue',
+    'toHaveValueContaining',
+    'toBeElementsArrayOfSize',
+    'toBeRequested',
+    'toBeRequestedTimes',
+    'toBeRequestedWith',
+    'toBeRequestedWithResponse'
+];

package/build/index.d.ts

@@ -13,7 +13,11 @@ declare const configs: {
             expect: boolean;
             multiremotebrowser: boolean;
         };
-        rules: {};
+        rules: {
+            'await-expect': import("eslint").Rule.RuleModule;
+            'no-debug': import("eslint").Rule.RuleModule;
+            'no-pause': import("eslint").Rule.RuleModule;
+        };
     };
 };
 export { rules, configs, };

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,KAAK;;;;CAIV,CAAA;AAED,QAAA,MAAM,OAAO;;;;;;;;;;;;CAYZ,CAAA;AAED,OAAO,EACH,KAAK,EACL,OAAO,GACV,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,KAAK;;;;CAIV,CAAA;AAED,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;CAYZ,CAAA;AAED,OAAO,EACH,KAAK,EACL,OAAO,GACV,CAAA"}

package/build/index.js

@@ -23,8 +23,7 @@ const configs = {
             expect: false,
             multiremotebrowser: false,
         },
-        rules: {}
+        rules
     }
 };
 exports.configs = configs;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsd0VBQThDO0FBQzlDLGdFQUEwQztBQUMxQyxnRUFBMEM7QUFFMUMsTUFBTSxLQUFLLEdBQUc7SUFDVixjQUFjLEVBQUcsc0JBQVc7SUFDNUIsVUFBVSxFQUFPLGtCQUFPO0lBQ3hCLFVBQVUsRUFBTyxrQkFBTztDQUMzQixDQUFBO0FBaUJHLHNCQUFLO0FBZlQsTUFBTSxPQUFPLEdBQUc7SUFDWixXQUFXLEVBQUU7UUFDVCxPQUFPLEVBQUU7WUFDTCxDQUFDLEVBQW9CLEtBQUs7WUFDMUIsRUFBRSxFQUFtQixLQUFLO1lBQzFCLE9BQU8sRUFBYyxLQUFLO1lBQzFCLE1BQU0sRUFBZSxLQUFLO1lBQzFCLE1BQU0sRUFBZSxLQUFLO1lBQzFCLGtCQUFrQixFQUFHLEtBQUs7U0FDN0I7UUFDRCxLQUFLLEVBQUcsRUFBRTtLQUNiO0NBQ0osQ0FBQTtBQUlHLDBCQUFPIn0=

package/build/rules/await-expect.d.ts

@@ -1,4 +1,4 @@
-import { Rule } from 'eslint';
+import type { Rule } from 'eslint';
 declare const rule: Rule.RuleModule;
 export default rule;
 //# sourceMappingURL=await-expect.d.ts.map

package/build/rules/await-expect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"await-expect.d.ts","sourceRoot":"","sources":["../../lib/rules/await-expect.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAO7B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+BhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"await-expect.d.ts","sourceRoot":"","sources":["../../src/rules/await-expect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAKlC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8ChB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/build/rules/await-expect.js

@@ -1,14 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const glob_1 = __importDefault(require("glob"));
-// Get all the matches in the expect-webdriverio package based on filenames
-const expectPath = require.resolve('expect-webdriverio');
-const matchesGlob = path_1.default.resolve(expectPath, '../../lib/matchers/**');
-const matchers = glob_1.default.sync(matchesGlob, { nodir: true, }).map(file => path_1.default.basename(file).replace(/(\.js|\.ts)/, ''));
+const constants_1 = require("../constants");
 const rule = {
     meta: {
         type: 'problem',
@@ -25,20 +17,30 @@ const rule = {
     },
     create: function (context) {
         return {
-            MemberExpression(node) {
-                var _a, _b, _c, _d, _e, _f;
-                const object = (_b = (_a = node.object) === null || _a === void 0 ? void 0 : _a.callee) === null || _b === void 0 ? void 0 : _b.name;
-                const property = (_c = node.property) === null || _c === void 0 ? void 0 : _c.name;
-                const parentType = (_f = (_e = (_d = node === null || node === void 0 ? void 0 : node.parent) === null || _d === void 0 ? void 0 : _d.parent) === null || _e === void 0 ? void 0 : _e.type) !== null && _f !== void 0 ? _f : false;
-                if (object === 'expect' && matchers.includes(property) && parentType !== 'AwaitExpression') {
-                    context.report({
-                        node,
-                        messageId: 'missingAwait',
-                    });
+            CallExpression(node) {
+                /**
+                 * validate we have an expect statement that
+                 * calls some of the WebdriverIO matchers
+                 */
+                if (node.callee.type !== 'MemberExpression' ||
+                    node.callee.object.type !== 'CallExpression' ||
+                    node.callee.object.callee.name !== 'expect' ||
+                    !constants_1.MATCHERS.includes(node.callee.property.name)) {
+                    return;
+                }
+                /**
+                 * fail rule if:
+                 */
+                if (
+                /**
+                 * expect is called without an `await` and as part of an
+                 * expression
+                 */
+                node.parent.type === 'ExpressionStatement') {
+                    context.report({ node, messageId: 'missingAwait' });
                 }
             }
         };
     }
 };
 exports.default = rule;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXdhaXQtZXhwZWN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vbGliL3J1bGVzL2F3YWl0LWV4cGVjdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLGdEQUF1QjtBQUN2QixnREFBdUI7QUFHdkIsMkVBQTJFO0FBQzNFLE1BQU0sVUFBVSxHQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtBQUN6RCxNQUFNLFdBQVcsR0FBRyxjQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSx1QkFBdUIsQ0FBQyxDQUFBO0FBQ3JFLE1BQU0sUUFBUSxHQUFNLGNBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksR0FBSSxDQUFDLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsY0FBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxPQUFPLENBQUMsYUFBYSxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUE7QUFFekgsTUFBTSxJQUFJLEdBQW9CO0lBQzFCLElBQUksRUFBRztRQUNILElBQUksRUFBRyxTQUFTO1FBQ2hCLElBQUksRUFBRztZQUNILFdBQVcsRUFBRyxvQ0FBb0M7WUFDbEQsUUFBUSxFQUFNLGlCQUFpQjtZQUMvQixHQUFHLEVBQVcsdUZBQXVGO1lBQ3JHLFdBQVcsRUFBRyxLQUFLO1NBQ3RCO1FBQ0QsUUFBUSxFQUFHO1lBQ1AsWUFBWSxFQUFHLDBDQUEwQztTQUM1RDtRQUNELGNBQWMsRUFBRyxJQUFJO0tBQ3hCO0lBRUQsTUFBTSxFQUFHLFVBQVMsT0FBeUI7UUFDdkMsT0FBTztZQUNILGdCQUFnQixDQUFDLElBQVM7O2dCQUN0QixNQUFNLE1BQU0sR0FBTyxNQUFBLE1BQUEsSUFBSSxDQUFDLE1BQU0sMENBQUUsTUFBTSwwQ0FBRSxJQUFJLENBQUE7Z0JBQzVDLE1BQU0sUUFBUSxHQUFLLE1BQUEsSUFBSSxDQUFDLFFBQVEsMENBQUUsSUFBSSxDQUFBO2dCQUN0QyxNQUFNLFVBQVUsR0FBRyxNQUFBLE1BQUEsTUFBQSxJQUFJLGFBQUosSUFBSSx1QkFBSixJQUFJLENBQUUsTUFBTSwwQ0FBRSxNQUFNLDBDQUFFLElBQUksbUNBQUksS0FBSyxDQUFBO2dCQUV0RCxJQUFJLE1BQU0sS0FBSyxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsSUFBSSxVQUFVLEtBQUssaUJBQWlCLEVBQUU7b0JBQ3hGLE9BQU8sQ0FBQyxNQUFNLENBQUM7d0JBQ1gsSUFBSTt3QkFDSixTQUFTLEVBQUcsY0FBYztxQkFDN0IsQ0FBQyxDQUFBO2lCQUNMO1lBQ0wsQ0FBQztTQUNKLENBQUE7SUFDTCxDQUFDO0NBQ0osQ0FBQTtBQUVELGtCQUFlLElBQUksQ0FBQSJ9

package/build/rules/no-debug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-debug.d.ts","sourceRoot":"","sources":["../../lib/rules/no-debug.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4BhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"no-debug.d.ts","sourceRoot":"","sources":["../../src/rules/no-debug.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyBhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/build/rules/no-debug.js

@@ -20,14 +20,10 @@ const rule = {
         return {
             CallExpression(node) {
                 if ((0, helpers_1.isCommand)(node, 'debug')) {
-                    context.report({
-                        node,
-                        messageId: 'unexpectedDebug'
-                    });
+                    context.report({ node, messageId: 'unexpectedDebug' });
                 }
             }
         };
     }
 };
 exports.default = rule;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm8tZGVidWcuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9saWIvcnVsZXMvbm8tZGVidWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSw4Q0FBNEM7QUFFNUMsTUFBTSxJQUFJLEdBQW9CO0lBQzFCLElBQUksRUFBRztRQUNILElBQUksRUFBRyxTQUFTO1FBQ2hCLElBQUksRUFBRztZQUNILFdBQVcsRUFBRyxtQ0FBbUM7WUFDakQsUUFBUSxFQUFNLGlCQUFpQjtZQUMvQixHQUFHLEVBQVcsbUZBQW1GO1lBQ2pHLFdBQVcsRUFBRyxLQUFLO1NBQ3RCO1FBQ0QsUUFBUSxFQUFHO1lBQ1AsZUFBZSxFQUFHLHdDQUF3QztTQUM3RDtRQUNELGNBQWMsRUFBRyxJQUFJO1FBQ3JCLE1BQU0sRUFBRyxFQUFFO0tBQ2Q7SUFFRCxNQUFNLEVBQUcsVUFBUyxPQUF5QjtRQUN2QyxPQUFPO1lBQ0gsY0FBYyxDQUFDLElBQUk7Z0JBQ2YsSUFBSSxJQUFBLG1CQUFTLEVBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxFQUFFO29CQUMxQixPQUFPLENBQUMsTUFBTSxDQUFDO3dCQUNYLElBQUk7d0JBQ0osU0FBUyxFQUFHLGlCQUFpQjtxQkFDaEMsQ0FBQyxDQUFBO2lCQUNMO1lBQ0wsQ0FBQztTQUNKLENBQUE7SUFDTCxDQUFDO0NBQ0osQ0FBQTtBQUVELGtCQUFlLElBQUksQ0FBQSJ9

package/build/rules/no-pause.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-pause.d.ts","sourceRoot":"","sources":["../../lib/rules/no-pause.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4BhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"no-pause.d.ts","sourceRoot":"","sources":["../../src/rules/no-pause.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyBhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/build/rules/no-pause.js

@@ -20,14 +20,10 @@ const rule = {
         return {
             CallExpression(node) {
                 if ((0, helpers_1.isCommand)(node, 'pause')) {
-                    context.report({
-                        node,
-                        messageId: 'unexpectedPause'
-                    });
+                    context.report({ node, messageId: 'unexpectedPause' });
                 }
             }
         };
     }
 };
 exports.default = rule;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm8tcGF1c2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9saWIvcnVsZXMvbm8tcGF1c2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSw4Q0FBNEM7QUFFNUMsTUFBTSxJQUFJLEdBQW9CO0lBQzFCLElBQUksRUFBRztRQUNILElBQUksRUFBRyxTQUFTO1FBQ2hCLElBQUksRUFBRztZQUNILFdBQVcsRUFBRyxtQ0FBbUM7WUFDakQsUUFBUSxFQUFNLGlCQUFpQjtZQUMvQixHQUFHLEVBQVcsbUZBQW1GO1lBQ2pHLFdBQVcsRUFBRyxLQUFLO1NBQ3RCO1FBQ0QsUUFBUSxFQUFHO1lBQ1AsZUFBZSxFQUFHLHdDQUF3QztTQUM3RDtRQUNELGNBQWMsRUFBRyxJQUFJO1FBQ3JCLE1BQU0sRUFBRyxFQUFFO0tBQ2Q7SUFFRCxNQUFNLEVBQUcsVUFBUyxPQUF5QjtRQUN2QyxPQUFPO1lBQ0gsY0FBYyxDQUFDLElBQUk7Z0JBQ2YsSUFBSSxJQUFBLG1CQUFTLEVBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxFQUFFO29CQUMxQixPQUFPLENBQUMsTUFBTSxDQUFDO3dCQUNYLElBQUk7d0JBQ0osU0FBUyxFQUFHLGlCQUFpQjtxQkFDaEMsQ0FBQyxDQUFBO2lCQUNMO1lBQ0wsQ0FBQztTQUNKLENBQUE7SUFDTCxDQUFDO0NBQ0osQ0FBQTtBQUVELGtCQUFlLElBQUksQ0FBQSJ9

package/build/utils/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/utils/helpers.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,eAAwB,GAAG,WAAW,OAAO,GAAG,OAAO,KAAG,OAQ/E,CAAA"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,eAAwB,GAAG,WAAW,OAAO,GAAG,OAAO,KAAG,OAQ/E,CAAA"}

package/build/utils/helpers.js

@@ -10,4 +10,3 @@ const isCommand = function (expression, command) {
         ((_b = callee === null || callee === void 0 ? void 0 : callee.property) === null || _b === void 0 ? void 0 : _b.name) === command);
 };
 exports.isCommand = isCommand;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi91dGlscy9oZWxwZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwyREFBMkQ7OztBQUVwRCxNQUFNLFNBQVMsR0FBRyxVQUFTLFVBQWUsRUFBRSxPQUEwQjs7SUFDekUsTUFBTSxNQUFNLEdBQUcsVUFBVSxhQUFWLFVBQVUsdUJBQVYsVUFBVSxDQUFFLE1BQU0sQ0FBQTtJQUVqQyxPQUFPLENBQ0gsTUFBTTtRQUNOLENBQUEsTUFBQSxNQUFNLGFBQU4sTUFBTSx1QkFBTixNQUFNLENBQUUsTUFBTSwwQ0FBRSxJQUFJLE1BQUssU0FBUztRQUNsQyxDQUFBLE1BQUEsTUFBTSxhQUFOLE1BQU0sdUJBQU4sTUFBTSxDQUFFLFFBQVEsMENBQUUsSUFBSSxNQUFLLE9BQU8sQ0FDckMsQ0FBQTtBQUNMLENBQUMsQ0FBQTtBQVJZLFFBQUEsU0FBUyxhQVFyQiJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-wdio",
-  "version": "7.17.3",
+  "version": "7.17.4",
   "description": "Eslint rules for WebdriverIO",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio",
@@ -23,9 +23,9 @@
   "bugs": {
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
-  "dependencies": {
-    "expect-webdriverio": "^3.1.4",
-    "glob": "^7.2.0"
+  "devDependencies": {
+    "@types/estree": "^0.0.51",
+    "eslint": "^8.10.0"
   },
-  "gitHead": "2bcb589dbdd10ca181f301a269b4dd158faab257"
+  "gitHead": "7243b24766d60a8b4c7d92aec757238c96590172"
 }

package/src/constants.ts

@@ -0,0 +1,33 @@
+export const MATCHERS = [
+    'toHaveTitle',
+    'toHaveTitleContaining',
+    'toHaveUrl',
+    'toHaveUrlContaining',
+    'toBeClickable',
+    'toBeDisabled',
+    'toBeDisplayed',
+    'toBeDisplayedInViewport',
+    'toBeEnabled',
+    'toBeExisting',
+    'toBeFocused',
+    'toBeSelected',
+    'toHaveAttribute',
+    'toHaveAttributeContaining',
+    'toHaveChildren',
+    'toHaveElementClass',
+    'toHaveElementClassContaining',
+    'toHaveElementProperty',
+    'toHaveHref',
+    'toHaveHrefContaining',
+    'toHaveId',
+    'toHaveStyle',
+    'toHaveText',
+    'toHaveTextContaining',
+    'toHaveValue',
+    'toHaveValueContaining',
+    'toBeElementsArrayOfSize',
+    'toBeRequested',
+    'toBeRequestedTimes',
+    'toBeRequestedWith',
+    'toBeRequestedWithResponse'
+]

package/src/index.ts

@@ -0,0 +1,28 @@
+import awaitExpect from './rules/await-expect'
+import noDebug     from './rules/no-debug'
+import noPause     from './rules/no-pause'
+
+const rules = {
+    'await-expect' : awaitExpect,
+    'no-debug'     : noDebug,
+    'no-pause'     : noPause
+}
+
+const configs = {
+    recommended: {
+        globals: {
+            $                  : false,
+            $$                 : false,
+            browser            : false,
+            driver             : false,
+            expect             : false,
+            multiremotebrowser : false,
+        },
+        rules
+    }
+}
+
+export {
+    rules,
+    configs,
+}

package/src/rules/await-expect.ts

@@ -0,0 +1,54 @@
+import type { Rule } from 'eslint'
+import type { Identifier } from 'estree'
+
+import { MATCHERS } from '../constants'
+
+const rule: Rule.RuleModule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'expect must be prefixed with await',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/packages/eslint-plugin-wdio/docs/rules/await-expect.md',
+            recommended: false,
+        },
+        messages: {
+            missingAwait: 'Missing await before an expect statement'
+        },
+        hasSuggestions: true
+    },
+
+    create: function (context: Rule.RuleContext): Rule.RuleListener {
+        return {
+            CallExpression(node): void {
+                /**
+                 * validate we have an expect statement that
+                 * calls some of the WebdriverIO matchers
+                 */
+                if (
+                    node.callee.type !== 'MemberExpression' ||
+                    node.callee.object.type !== 'CallExpression' ||
+                    (node.callee.object.callee as Identifier).name !== 'expect' ||
+                    !MATCHERS.includes((node.callee.property as Identifier).name)
+                ) {
+                    return
+                }
+
+                /**
+                 * fail rule if:
+                 */
+                if (
+                    /**
+                     * expect is called without an `await` and as part of an
+                     * expression
+                     */
+                    node.parent.type === 'ExpressionStatement'
+                ) {
+                    context.report({ node, messageId: 'missingAwait' })
+                }
+            }
+        }
+    }
+}
+
+export default rule

package/src/rules/no-debug.ts

@@ -0,0 +1,31 @@
+import { Rule } from 'eslint'
+import { isCommand } from '../utils/helpers'
+
+const rule: Rule.RuleModule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow browser.debug() in tests',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/packages/eslint-plugin-wdio/docs/rules/no-debug.md',
+            recommended: false,
+        },
+        messages: {
+            unexpectedDebug: 'Unexpected browser.debug() not allowed'
+        },
+        hasSuggestions: true,
+        schema: [],
+    },
+
+    create: function (context: Rule.RuleContext): Rule.RuleListener {
+        return {
+            CallExpression(node): void {
+                if (isCommand(node, 'debug')) {
+                    context.report({ node, messageId: 'unexpectedDebug' })
+                }
+            }
+        }
+    }
+}
+
+export default rule

package/src/rules/no-pause.ts

@@ -0,0 +1,31 @@
+import { Rule } from 'eslint'
+import { isCommand } from '../utils/helpers'
+
+const rule: Rule.RuleModule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow browser.pause() in tests',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/packages/eslint-plugin-wdio/docs/rules/no-pause.md',
+            recommended: false,
+        },
+        messages: {
+            unexpectedPause: 'Unexpected browser.pause() not allowed'
+        },
+        hasSuggestions: true,
+        schema: [],
+    },
+
+    create: function (context: Rule.RuleContext): Rule.RuleListener {
+        return {
+            CallExpression(node): void {
+                if (isCommand(node, 'pause')) {
+                    context.report({ node, messageId: 'unexpectedPause' })
+                }
+            }
+        }
+    }
+}
+
+export default rule

package/src/utils/helpers.ts

@@ -0,0 +1,12 @@
+// import type { TSESTree } from '@typescript-eslint/utils'
+
+export const isCommand = function(expression: any, command: 'pause' | 'debug'): boolean {
+    const callee = expression?.callee
+
+    return (
+        callee &&
+        callee?.object?.name === 'browser' &&
+        callee?.property?.name === command
+    )
+}
+