eslint-plugin-wdio 10.0.0-alpha.18 → 10.0.0

package/AGENTS.md

@@ -0,0 +1,11 @@
+# eslint-plugin-wdio
+
+ESLint rules and the `flat/recommended` config. Read the root [AGENTS.md](../../AGENTS.md) and [packages/AGENTS.md](../AGENTS.md) first.
+
+## Tests
+
+`tests/index.test.ts` owns the public plugin export: meta, `flat/recommended` severities, ignores, parser options, registered rule names, and recommended globals.
+
+Recommended globals are the WebdriverIO names (`$`, `$$`, `browser`, `driver`, `expect`, `multiRemoteBrowser`) plus `globals.mocha` and `globals.node`, spread in that order. Assert that composition. Do not paste a snapshot of every Mocha and Node global. That list fails when the `globals` package adds a name and does not fail when this package changes the contract.
+
+Rule behavior stays in that rule's test (`await-expect`, `no-debug`, `no-pause`) through ESLint `RuleTester`. `tests/await-expect.test.ts` also keeps `MATCHERS` aligned with `expect-webdriverio` custom matchers. Snapshot matchers are not part of that list; the rule tester owns them.

package/README.md

@@ -4,7 +4,7 @@ ESLint rules for [WebdriverIO](https://webdriver.io)
 
 ## Installation
 
-You'll first need to install [ESLint](https://eslint.org):
+You'll first need to install [ESLint](https://eslint.org) 10:
 
 ```sh
 npm i eslint --save-dev
@@ -20,28 +20,9 @@ npm install eslint-plugin-wdio --save-dev
 
 ## Recommended configuration
 
-This plugin exports a recommended configuration that enforces good practices.
-
-### With ESLint v8 and below
-
-To enable this configuration use the `extends` property in your `.eslintrc` config file:
-
-```json
-{
-    "plugins": ["wdio"],
-    "extends": [
-        "eslint:recommended",
-        "plugin:wdio/recommended"
-    ]
-}
-```
-
-### With ESLint v9 and Flat Config
-
-If you are using the latest version of ESLint with the [flat configuration](https://eslint.org/docs/latest/use/configure/migration-guide), you can embed this plugin as follows:
+This plugin exports a flat config that enforces good practices. Add it to `eslint.config.mjs`:
 
 ```js
-// eslint.config.mjs
 import { configs as wdioConfig } from "eslint-plugin-wdio";
 
 export default [
@@ -49,18 +30,42 @@ export default [
 ];
 ```
 
+The eslintrc export `plugin:wdio/recommended` is gone. Flat config is the supported setup.
+
 See [ESLint documentation](https://eslint.org/docs/latest/use/configure/configuration-files) for more information about extending configuration files.
 
 ## TypeScript Support
 
-When `typescript` and `@typescript-eslint/eslint-plugin` are detected, the recommended configuration automatically replaces `wdio/await-expect` with `wdio/no-floating-promise` for stricter, type-aware promise handling.
+When `typescript-eslint` is installed, the recommended configuration automatically replaces `wdio/await-expect` with `wdio/no-floating-promise` for stricter, type-aware promise handling.
 
 To enable this, install the required dependencies:
 
 ```sh
-npm install --save-dev typescript @typescript-eslint/eslint-plugin
+npm install --save-dev typescript typescript-eslint
 ```
 
+By default, ESLint lints only `.js`, `.mjs` and `.cjs` files. Add a `files` pattern so that it also lints your TypeScript specs:
+
+```js
+import { configs as wdioConfig } from "eslint-plugin-wdio";
+
+export default [
+    { files: ['**/*.{ts,mts,cts,tsx}'], ...wdioConfig['flat/recommended'] },
+];
+```
+
+`wdio/no-floating-promise` needs type information, so your spec files must be part of a `tsconfig.json`.
+
+To also lint JavaScript files, such as `wdio.conf.js`, add them to the TypeScript project (`"allowJs": true` and the files in `include`), then widen the pattern:
+
+```js
+export default [
+    { files: ['**/*.{js,mjs,cjs,ts,mts,cts,tsx}'], ...wdioConfig['flat/recommended'] },
+];
+```
+
+If a matched file is not part of the TypeScript project, ESLint reports "was not found by the project service".
+
 ## List of supported rules
 
 

package/build/configs/js-recommended.d.ts

@@ -5,7 +5,6 @@ declare const _default: {
             readonly __filename: false;
             readonly AbortController: false;
             readonly AbortSignal: false;
-            readonly AsyncDisposableStack: false;
             readonly atob: false;
             readonly Blob: false;
             readonly BroadcastChannel: false;
@@ -24,7 +23,6 @@ declare const _default: {
             readonly CryptoKey: false;
             readonly CustomEvent: false;
             readonly DecompressionStream: false;
-            readonly DisposableStack: false;
             readonly DOMException: false;
             readonly ErrorEvent: false;
             readonly Event: false;
@@ -69,7 +67,6 @@ declare const _default: {
             readonly Storage: false;
             readonly structuredClone: false;
             readonly SubtleCrypto: false;
-            readonly SuppressedError: false;
             readonly Temporal: false;
             readonly TextDecoder: false;
             readonly TextDecoderStream: false;
@@ -110,12 +107,15 @@ declare const _default: {
             readonly browser: false;
             readonly driver: false;
             readonly expect: false;
-            readonly multiremotebrowser: false;
             readonly multiRemoteBrowser: false;
         };
     };
     plugins: {
         wdio: {
+            meta: {
+                name: string;
+                version: string;
+            };
             configs: {};
             rules: {
                 'await-expect': import("eslint").Rule.RuleModule;

package/build/configs/ts-recommended.d.ts

@@ -1,10 +1,4 @@
 import type { Rule } from 'eslint';
-export declare const rules: {
-    'no-floating-promise': Rule.RuleModule;
-    'await-expect': Rule.RuleModule;
-    'no-debug': Rule.RuleModule;
-    'no-pause': Rule.RuleModule;
-};
 declare const _default: {
     languageOptions: {
         globals: {
@@ -12,7 +6,6 @@ declare const _default: {
             readonly __filename: false;
             readonly AbortController: false;
             readonly AbortSignal: false;
-            readonly AsyncDisposableStack: false;
             readonly atob: false;
             readonly Blob: false;
             readonly BroadcastChannel: false;
@@ -31,7 +24,6 @@ declare const _default: {
             readonly CryptoKey: false;
             readonly CustomEvent: false;
             readonly DecompressionStream: false;
-            readonly DisposableStack: false;
             readonly DOMException: false;
             readonly ErrorEvent: false;
             readonly Event: false;
@@ -76,7 +68,6 @@ declare const _default: {
             readonly Storage: false;
             readonly structuredClone: false;
             readonly SubtleCrypto: false;
-            readonly SuppressedError: false;
             readonly Temporal: false;
             readonly TextDecoder: false;
             readonly TextDecoderStream: false;
@@ -117,7 +108,6 @@ declare const _default: {
             readonly browser: false;
             readonly driver: false;
             readonly expect: false;
-            readonly multiremotebrowser: false;
             readonly multiRemoteBrowser: false;
         };
         parser: any;
@@ -133,6 +123,10 @@ declare const _default: {
                 'no-debug': Rule.RuleModule;
                 'no-pause': Rule.RuleModule;
             };
+            meta: {
+                name: string;
+                version: string;
+            };
             configs: {};
         };
     };

package/build/configs/ts-recommended.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ts-recommended.d.ts","sourceRoot":"","sources":["../../src/configs/ts-recommended.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAsClC,eAAO,MAAM,KAAK;;;;;CAGyB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3C,wBAAyD"}
+{"version":3,"file":"ts-recommended.d.ts","sourceRoot":"","sources":["../../src/configs/ts-recommended.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsClC,wBAAyD"}

package/build/constants.d.ts.map

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

package/build/globals.d.ts

@@ -3,7 +3,6 @@ export declare const sharedGlobals: {
     readonly __filename: false;
     readonly AbortController: false;
     readonly AbortSignal: false;
-    readonly AsyncDisposableStack: false;
     readonly atob: false;
     readonly Blob: false;
     readonly BroadcastChannel: false;
@@ -22,7 +21,6 @@ export declare const sharedGlobals: {
     readonly CryptoKey: false;
     readonly CustomEvent: false;
     readonly DecompressionStream: false;
-    readonly DisposableStack: false;
     readonly DOMException: false;
     readonly ErrorEvent: false;
     readonly Event: false;
@@ -67,7 +65,6 @@ export declare const sharedGlobals: {
     readonly Storage: false;
     readonly structuredClone: false;
     readonly SubtleCrypto: false;
-    readonly SuppressedError: false;
     readonly Temporal: false;
     readonly TextDecoder: false;
     readonly TextDecoderStream: false;
@@ -108,7 +105,6 @@ export declare const sharedGlobals: {
     readonly browser: false;
     readonly driver: false;
     readonly expect: false;
-    readonly multiremotebrowser: false;
     readonly multiRemoteBrowser: false;
 };
 //# sourceMappingURL=globals.d.ts.map

package/build/globals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../src/globals.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWhB,CAAA"}
+{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../src/globals.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUhB,CAAA"}

package/build/index.cjs

@@ -33,7 +33,7 @@ var index_exports = {};
 __export(index_exports, {
   configs: () => configs,
   default: () => index_default,
-  rules: () => rules2
+  rules: () => rules
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -52,14 +52,10 @@ var MATCHERS = [
   "toBeRequested",
   "toBeRequestedTimes",
   "toBeRequestedWith",
-  "toBeRequestedWithResponse",
   "toBeSelected",
   "toExist",
-  "toHaveAttr",
   "toHaveAttribute",
-  "toHaveAttributeAndValue",
   "toHaveChildren",
-  "toHaveClass",
   "toHaveClipboardText",
   "toHaveComputedLabel",
   "toHaveComputedRole",
@@ -86,7 +82,6 @@ var rule = {
     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
     },
@@ -142,7 +137,6 @@ var rule2 = {
     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
     },
@@ -189,7 +183,6 @@ var rule3 = {
     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
     },
@@ -230,8 +223,70 @@ var rule3 = {
 };
 var no_pause_default = rule3;
 
+// package.json
+var package_default = {
+  name: "eslint-plugin-wdio",
+  version: "9.31.3",
+  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",
+  main: "./build/index.cjs",
+  module: "./build/index.js",
+  types: "./build/index.d.ts",
+  exports: {
+    ".": {
+      types: "./build/index.d.ts",
+      import: "./build/index.js",
+      require: "./build/index.cjs"
+    }
+  },
+  type: "module",
+  typeScriptVersion: "6.0.3",
+  engines: {
+    node: ">=22.19.0"
+  },
+  repository: {
+    type: "git",
+    url: "git+https://github.com/webdriverio/webdriverio.git",
+    directory: "packages/eslint-plugin-wdio"
+  },
+  keywords: [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "webdriver",
+    "wdio"
+  ],
+  bugs: {
+    url: "https://github.com/webdriverio/webdriverio/issues"
+  },
+  devDependencies: {
+    "@types/estree": "^1.0.9",
+    "@wdio/types": "workspace:*",
+    eslint: "^10.11.0",
+    "expect-webdriverio": "^8.0.0-alpha.3",
+    globals: "^17.12.0",
+    "typescript-eslint": "^8.71.0"
+  },
+  peerDependencies: {
+    eslint: "^10.0.0",
+    globals: "^16.5.0 || ^17.0.0",
+    "typescript-eslint": "^8.56.0"
+  },
+  peerDependenciesMeta: {
+    "typescript-eslint": {
+      optional: true
+    }
+  }
+};
+
 // src/plugin.ts
 var index = {
+  meta: {
+    name: package_default.name,
+    version: package_default.version
+  },
   configs: {},
   rules: {
     "await-expect": await_expect_default,
@@ -249,7 +304,6 @@ var sharedGlobals = {
   browser: false,
   driver: false,
   expect: false,
-  multiremotebrowser: false,
   multiRemoteBrowser: false,
   // To be more user friendly we add mocha and node globals as well, else the use need to configure themself
   ...import_globals.default.mocha,
@@ -277,16 +331,14 @@ var import_node_module3 = require("node:module");
 // src/rules/no-floating-promise.ts
 var import_node_module = require("node:module");
 var require2 = (0, import_node_module.createRequire)(__importMetaUrl);
-var tryRequire = (moduleName) => {
+var loadTsRule = () => {
   try {
-    return require2(moduleName);
+    return require2("typescript-eslint").plugin.rules["no-floating-promises"];
   } catch {
     return null;
   }
 };
-var tsEslintPlugin = tryRequire("@typescript-eslint/eslint-plugin");
-var tsRule = tsEslintPlugin?.rules["no-floating-promises"];
-var error;
+var tsRule = loadTsRule();
 var rule4 = {
   meta: tsRule?.meta ?? {
     type: "problem",
@@ -297,10 +349,13 @@ var rule4 = {
     schema: []
   },
   create: function(context) {
+    if (!tsRule) {
+      throw new Error('wdio/no-floating-promise needs the "typescript-eslint" package. Install it with "npm install --save-dev typescript-eslint".');
+    }
     try {
-      return tsRule?.create(context) ?? {};
-    } catch {
-      console.error("Error in no-floating-promise rule:", error);
+      return tsRule.create(context);
+    } catch (err) {
+      console.error("Error in no-floating-promise rule:", err);
       return {};
     }
   }
@@ -351,92 +406,21 @@ var tsRecommended = () => {
     ignores: ["eslint.config.js", "eslint.config.cjs", "eslint.config.mjs"]
   };
 };
-var rules = {
-  ...plugin_default.rules,
-  "no-floating-promise": no_floating_promise_default
-};
 var ts_recommended_default = isTypeAware ? tsRecommended() : void 0;
 
-// package.json
-var package_default = {
-  name: "eslint-plugin-wdio",
-  version: "9.31.3",
-  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",
-  main: "./build/index.cjs",
-  module: "./build/index.js",
-  types: "./build/index.d.ts",
-  exports: {
-    ".": {
-      types: "./build/index.d.ts",
-      import: "./build/index.js",
-      require: "./build/index.cjs"
-    }
-  },
-  type: "module",
-  typeScriptVersion: "3.8.3",
-  engines: {
-    node: ">=18.20.0"
-  },
-  repository: {
-    type: "git",
-    url: "git+https://github.com/webdriverio/webdriverio.git",
-    directory: "packages/eslint-plugin-wdio"
-  },
-  keywords: [
-    "eslint",
-    "eslintplugin",
-    "eslint-plugin",
-    "webdriver",
-    "wdio"
-  ],
-  bugs: {
-    url: "https://github.com/webdriverio/webdriverio/issues"
-  },
-  devDependencies: {
-    "@types/estree": "^1.0.8",
-    eslint: "^9.39.2",
-    "expect-webdriverio": "^7.0.1",
-    globals: "^17.7.0",
-    "typescript-eslint": "^8.54.0"
-  },
-  peerDependencies: {
-    eslint: "^9.39.2 || ^10.0.0",
-    globals: "^16.5.0 || ^17.0.0",
-    "typescript-eslint": "^8.54.0"
-  },
-  peerDependenciesMeta: {
-    "typescript-eslint": {
-      optional: true
-    }
-  }
-};
-
 // src/index.ts
-var legacyConfig = {
-  rules: {
-    "wdio/await-expect": "error",
-    "wdio/no-debug": "error",
-    "wdio/no-pause": "error"
-  },
-  globals: sharedGlobals,
-  plugins: ["wdio"]
-};
 var flatConfig = ts_recommended_default ?? js_recommended_default;
 var configs = {
-  "flat/recommended": flatConfig,
-  recommended: legacyConfig
+  "flat/recommended": flatConfig
 };
-var rules2 = ts_recommended_default?.rules ?? plugin_default.rules;
+var rules = ts_recommended_default?.rules ?? plugin_default.rules;
 var index_default = {
   meta: {
     name: package_default.name,
     version: package_default.version
   },
   configs,
-  rules: rules2
+  rules
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {