eslint-plugin-wdio 8.0.0 → 8.0.7

package/cjs/constants.js

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

package/cjs/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
+const await_expect_js_1 = __importDefault(require("./rules/await-expect.js"));
+const no_debug_js_1 = __importDefault(require("./rules/no-debug.js"));
+const no_pause_js_1 = __importDefault(require("./rules/no-pause.js"));
+const rules = {
+    'await-expect': await_expect_js_1.default,
+    'no-debug': no_debug_js_1.default,
+    'no-pause': no_pause_js_1.default
+};
+exports.rules = rules;
+const configs = {
+    recommended: {
+        globals: {
+            $: false,
+            $$: false,
+            browser: false,
+            driver: false,
+            expect: false,
+            multiremotebrowser: false,
+        },
+        rules: {
+            'wdio/await-expect': 'error',
+            'wdio/no-debug': 'error',
+            'wdio/no-pause': 'error',
+        }
+    }
+};
+exports.configs = configs;

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/cjs/rules/await-expect.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_js_1 = require("../constants.js");
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'expect must be prefixed with await',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/webdriverio/blob/main/packages/eslint-plugin-wdio/docs/rules/await-expect.md',
+            recommended: false,
+        },
+        messages: {
+            missingAwait: 'Missing await before an expect statement'
+        },
+        hasSuggestions: true
+    },
+    create: function (context) {
+        return {
+            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_js_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;

package/cjs/rules/no-debug.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_js_1 = require("../utils/helpers.js");
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow browser.debug() in tests',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/webdriverio/blob/main/packages/eslint-plugin-wdio/docs/rules/no-debug.md',
+            recommended: false,
+        },
+        messages: {
+            unexpectedDebug: 'Unexpected browser.debug() not allowed'
+        },
+        hasSuggestions: true,
+        schema: [],
+    },
+    create: function (context) {
+        return {
+            CallExpression(node) {
+                if ((0, helpers_js_1.isCommand)(node, 'debug')) {
+                    context.report({ node, messageId: 'unexpectedDebug' });
+                }
+            }
+        };
+    }
+};
+exports.default = rule;

package/cjs/rules/no-pause.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_js_1 = require("../utils/helpers.js");
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow browser.pause() in tests',
+            category: 'Possible Errors',
+            url: 'https://github.com/webdriverio/webdriverio/blob/main/packages/eslint-plugin-wdio/docs/rules/no-pause.md',
+            recommended: false,
+        },
+        messages: {
+            unexpectedPause: 'Unexpected browser.pause() not allowed'
+        },
+        hasSuggestions: true,
+        schema: [],
+    },
+    create: function (context) {
+        return {
+            CallExpression(node) {
+                if ((0, helpers_js_1.isCommand)(node, 'pause')) {
+                    context.report({ node, messageId: 'unexpectedPause' });
+                }
+            }
+        };
+    }
+};
+exports.default = rule;

package/cjs/utils/helpers.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCommand = void 0;
+const isCommand = function (expression, command) {
+    const callee = expression?.callee;
+    return (callee &&
+        callee?.object?.name === 'browser' &&
+        callee?.property?.name === command);
+};
+exports.isCommand = isCommand;

package/package.json

@@ -1,13 +1,24 @@
 {
   "name": "eslint-plugin-wdio",
-  "version": "8.0.0",
+  "version": "8.0.7",
   "description": "Eslint rules for WebdriverIO",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio",
   "license": "MIT",
   "type": "module",
-  "exports": "./build/index.js",
+  "main": "./cjs/index.js",
+  "module": "./build/index.js",
   "types": "./build/index.d.ts",
+  "exports": {
+    ".": [
+      {
+        "types": "./build/index.d.ts",
+        "import": "./build/index.js",
+        "require": "./cjs/index.js"
+      },
+      "./cjs/index.js"
+    ]
+  },
   "typeScriptVersion": "3.8.3",
   "engines": {
     "node": "^16.13 || >=18"
@@ -31,5 +42,5 @@
     "@types/estree": "^0.0.52",
     "eslint": "^8.10.0"
   },
-  "gitHead": "a9b5954c62b7dff2af701159ff7837eb98a9b258"
+  "gitHead": "a874a82a727634d1323fff05c17455ba0907a020"
 }