eslint-plugin-wdio 9.4.4 → 9.9.1

package/README.md

@@ -42,7 +42,7 @@ If you are using the latest version of Eslint with the [flat configuration](http
 
 ```js
 // eslint.config.mjs
-import { config as wdioConfig } from "eslint-plugin-wdio";
+import { configs as wdioConfig } from "eslint-plugin-wdio";
 
 export default [
     {
@@ -58,8 +58,15 @@ See [ESLint documentation](https://eslint.org/docs/latest/use/configure/configur
 
 ## 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 |
+
+- [`wdio/await-expect`](./docs/async-methods.md)
+
+`expect` calls must be prefixed with an `await`
+
+- [`wdio/no-debug`](./docs/no-debug.md)
+
+Don't allow `browser.debug()` statements
+
+- [`wdio/no-pause`](./docs/no-pause.md)
+
+Don't allow `browser.pause(<number>)` statements

package/build/index.cjs

@@ -19,12 +19,12 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   configs: () => configs,
   rules: () => rules
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/constants.ts
 var MATCHERS = [
@@ -93,9 +93,9 @@ var rule = {
 var await_expect_default = rule;
 
 // src/utils/helpers.ts
-var isCommand = function(expression, command) {
+var isCommand = function(expression, command, instances = ["browser"]) {
   const callee = expression?.callee;
-  return callee && "object" in callee && "name" in callee.object && callee.object?.name === "browser" && "property" in callee && "name" in callee.property && callee.property?.name === command;
+  return callee && "object" in callee && "name" in callee.object && instances.includes(callee.object?.name) && "property" in callee && "name" in callee.property && callee.property?.name === command;
 };
 
 // src/rules/no-debug.ts
@@ -112,13 +112,32 @@ var rule2 = {
       unexpectedDebug: "Unexpected browser.debug() not allowed"
     },
     hasSuggestions: true,
-    schema: []
+    schema: [{
+      type: "object",
+      properties: {
+        instances: {
+          type: "array",
+          items: {
+            type: "string"
+          },
+          description: 'List of browser instances to check (default: ["browser"])',
+          default: ["browser"]
+        }
+      },
+      additionalProperties: false
+    }]
   },
   create: function(context) {
+    const options = context.options[0] || {};
+    const instances = options.instances || ["browser"];
     return {
       CallExpression(node) {
-        if (isCommand(node, "debug")) {
-          context.report({ node, messageId: "unexpectedDebug" });
+        if (isCommand(node, "debug", instances)) {
+          context.report({
+            node,
+            messageId: "unexpectedDebug",
+            data: { instance: instances.join(", ") }
+          });
         }
       }
     };
@@ -140,13 +159,32 @@ var rule3 = {
       unexpectedPause: "Unexpected browser.pause() not allowed"
     },
     hasSuggestions: true,
-    schema: []
+    schema: [{
+      type: "object",
+      properties: {
+        instances: {
+          type: "array",
+          items: {
+            type: "string"
+          },
+          description: 'List of browser instances to check (default: ["browser"])',
+          default: ["browser"]
+        }
+      },
+      additionalProperties: false
+    }]
   },
   create: function(context) {
+    const options = context.options[0] || {};
+    const instances = options.instances || ["browser"];
     return {
       CallExpression(node) {
-        if (isCommand(node, "pause")) {
-          context.report({ node, messageId: "unexpectedPause" });
+        if (isCommand(node, "pause", instances)) {
+          context.report({
+            node,
+            messageId: "unexpectedPause",
+            data: { instance: instances.join(", ") }
+          });
         }
       }
     };

package/build/index.js

@@ -65,9 +65,9 @@ var rule = {
 var await_expect_default = rule;
 
 // src/utils/helpers.ts
-var isCommand = function(expression, command) {
+var isCommand = function(expression, command, instances = ["browser"]) {
   const callee = expression?.callee;
-  return callee && "object" in callee && "name" in callee.object && callee.object?.name === "browser" && "property" in callee && "name" in callee.property && callee.property?.name === command;
+  return callee && "object" in callee && "name" in callee.object && instances.includes(callee.object?.name) && "property" in callee && "name" in callee.property && callee.property?.name === command;
 };
 
 // src/rules/no-debug.ts
@@ -84,13 +84,32 @@ var rule2 = {
       unexpectedDebug: "Unexpected browser.debug() not allowed"
     },
     hasSuggestions: true,
-    schema: []
+    schema: [{
+      type: "object",
+      properties: {
+        instances: {
+          type: "array",
+          items: {
+            type: "string"
+          },
+          description: 'List of browser instances to check (default: ["browser"])',
+          default: ["browser"]
+        }
+      },
+      additionalProperties: false
+    }]
   },
   create: function(context) {
+    const options = context.options[0] || {};
+    const instances = options.instances || ["browser"];
     return {
       CallExpression(node) {
-        if (isCommand(node, "debug")) {
-          context.report({ node, messageId: "unexpectedDebug" });
+        if (isCommand(node, "debug", instances)) {
+          context.report({
+            node,
+            messageId: "unexpectedDebug",
+            data: { instance: instances.join(", ") }
+          });
         }
       }
     };
@@ -112,13 +131,32 @@ var rule3 = {
       unexpectedPause: "Unexpected browser.pause() not allowed"
     },
     hasSuggestions: true,
-    schema: []
+    schema: [{
+      type: "object",
+      properties: {
+        instances: {
+          type: "array",
+          items: {
+            type: "string"
+          },
+          description: 'List of browser instances to check (default: ["browser"])',
+          default: ["browser"]
+        }
+      },
+      additionalProperties: false
+    }]
   },
   create: function(context) {
+    const options = context.options[0] || {};
+    const instances = options.instances || ["browser"];
     return {
       CallExpression(node) {
-        if (isCommand(node, "pause")) {
-          context.report({ node, messageId: "unexpectedPause" });
+        if (isCommand(node, "pause", instances)) {
+          context.report({
+            node,
+            messageId: "unexpectedPause",
+            data: { instance: instances.join(", ") }
+          });
         }
       }
     };

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

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

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

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

package/build/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 import type { Rule } from 'eslint';
 type CallExpression = Parameters<NonNullable<Rule.NodeListener['CallExpression']>>[0];
-export declare const isCommand: (expression: CallExpression, command: "pause" | "debug") => boolean;
+export declare const isCommand: (expression: CallExpression, command: "pause" | "debug", instances?: string[]) => boolean;
 export {};
 //# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAElC,KAAK,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAErF,eAAO,MAAM,SAAS,eAAwB,cAAc,WAAW,OAAO,GAAG,OAAO,KAAG,OAY1F,CAAA"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAElC,KAAK,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAErF,eAAO,MAAM,SAAS,eACN,cAAc,WACjB,OAAO,GAAG,OAAO,cACf,MAAM,EAAE,KACpB,OAWF,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-wdio",
-  "version": "9.4.4",
+  "version": "9.9.1",
   "description": "Eslint rules for WebdriverIO",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio",
@@ -39,5 +39,5 @@
     "@types/estree": "^1.0.1",
     "eslint": "^9.0.0"
   },
-  "gitHead": "d327d86e07d16eaa0ecdf0656c1868ba73261393"
+  "gitHead": "a7f0c07b223c9a4a7774fead36ec82296a99177f"
 }

package/src/rules/no-debug.ts

@@ -14,14 +14,33 @@ const rule: Rule.RuleModule = {
             unexpectedDebug: 'Unexpected browser.debug() not allowed'
         },
         hasSuggestions: true,
-        schema: [],
+        schema: [{
+            type: 'object',
+            properties: {
+                instances: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'List of browser instances to check (default: ["browser"])',
+                    default: ['browser'],
+                },
+            },
+            additionalProperties: false,
+        }],
     },
 
     create: function (context: Rule.RuleContext): Rule.RuleListener {
+        const options = context.options[0] || {}
+        const instances = options.instances || ['browser']
         return {
             CallExpression(node): void {
-                if (isCommand(node, 'debug')) {
-                    context.report({ node, messageId: 'unexpectedDebug' })
+                if (isCommand(node, 'debug', instances)) {
+                    context.report({
+                        node,
+                        messageId: 'unexpectedDebug',
+                        data: { instance: instances.join(', ') }
+                    })
                 }
             }
         }

package/src/rules/no-pause.ts

@@ -14,14 +14,33 @@ const rule: Rule.RuleModule = {
             unexpectedPause: 'Unexpected browser.pause() not allowed'
         },
         hasSuggestions: true,
-        schema: [],
+        schema: [{
+            type: 'object',
+            properties: {
+                instances: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'List of browser instances to check (default: ["browser"])',
+                    default: ['browser'],
+                },
+            },
+            additionalProperties: false,
+        }],
     },
 
     create: function (context: Rule.RuleContext): Rule.RuleListener {
+        const options = context.options[0] || {}
+        const instances = options.instances || ['browser']
         return {
             CallExpression(node): void {
-                if (isCommand(node, 'pause')) {
-                    context.report({ node, messageId: 'unexpectedPause' })
+                if (isCommand(node, 'pause', instances)) {
+                    context.report({
+                        node,
+                        messageId: 'unexpectedPause',
+                        data: { instance: instances.join(', ') }
+                    })
                 }
             }
         }

package/src/utils/helpers.ts

@@ -2,14 +2,17 @@ import type { Rule } from 'eslint'
 
 type CallExpression = Parameters<NonNullable<Rule.NodeListener['CallExpression']>>[0]
 
-export const isCommand = function(expression: CallExpression, command: 'pause' | 'debug'): boolean {
+export const isCommand = function(
+    expression: CallExpression,
+    command: 'pause' | 'debug',
+    instances: string[] = ['browser']
+): boolean {
     const callee = expression?.callee
-
     return (
         callee &&
         'object' in callee &&
         'name' in callee.object &&
-        callee.object?.name === 'browser' &&
+        instances.includes(callee.object?.name) &&
         'property' in callee &&
         'name' in callee.property &&
         callee.property?.name === command