eslint-plugin-wdio 9.16.2 → 9.25.0

package/README.md

@@ -20,11 +20,11 @@ npm install eslint-plugin-wdio --save-dev
 
 ## Recommended configuration
 
-This plugin export a recommended configuration that enforce good practices.
+This plugin exports a recommended configuration that enforces good practices.
 
-### With Eslint v8 and below
+### With ESLint v8 and below
 
-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
 {
@@ -36,37 +36,46 @@ To enable this configuration use the extends property in your `.eslintrc` config
 }
 ```
 
-### With Eslint v9 and Flat Config
+### 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:
+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:
 
 ```js
 // eslint.config.mjs
 import { configs as wdioConfig } from "eslint-plugin-wdio";
 
 export default [
-    {
-        extends: [
-            wdioConfig['flat/recommended'],
-            // ...
-        ]
-    }
+    wdioConfig['flat/recommended'],
 ];
 ```
 
 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.
+
+To enable this, install the required dependencies:
+
+```sh
+npm install --save-dev typescript @typescript-eslint/eslint-plugin
+```
+
 ## List of supported rules
 
 
-- [`wdio/await-expect`](./docs/async-methods.md)
+- [`wdio/await-expect`](./docs/rules/await-expect.md)
 
 `expect` calls must be prefixed with an `await`
 
-- [`wdio/no-debug`](./docs/no-debug.md)
+- [`wdio/no-debug`](./docs/rules/no-debug.md)
 
 Don't allow `browser.debug()` statements
 
-- [`wdio/no-pause`](./docs/no-pause.md)
+- [`wdio/no-pause`](./docs/rules/no-pause.md)
 
 Don't allow `browser.pause(<number>)` statements
+
+- [`wdio/no-floating-promise`](./docs/rules/no-floating-promise.md)
+
+Check for unhandled promises

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

@@ -0,0 +1,132 @@
+declare const _default: {
+    languageOptions: {
+        globals: {
+            readonly __dirname: false;
+            readonly __filename: false;
+            readonly AbortController: false;
+            readonly AbortSignal: false;
+            readonly AsyncDisposableStack: false;
+            readonly atob: false;
+            readonly Blob: false;
+            readonly BroadcastChannel: false;
+            readonly btoa: false;
+            readonly Buffer: false;
+            readonly ByteLengthQueuingStrategy: false;
+            readonly clearImmediate: false;
+            readonly clearInterval: false;
+            readonly clearTimeout: false;
+            readonly CloseEvent: false;
+            readonly CompressionStream: false;
+            readonly console: false;
+            readonly CountQueuingStrategy: false;
+            readonly crypto: false;
+            readonly Crypto: false;
+            readonly CryptoKey: false;
+            readonly CustomEvent: false;
+            readonly DecompressionStream: false;
+            readonly DisposableStack: false;
+            readonly DOMException: false;
+            readonly ErrorEvent: false;
+            readonly Event: false;
+            readonly EventTarget: false;
+            readonly exports: true;
+            readonly fetch: false;
+            readonly File: false;
+            readonly FormData: false;
+            readonly global: false;
+            readonly Headers: false;
+            readonly localStorage: false;
+            readonly MessageChannel: false;
+            readonly MessageEvent: false;
+            readonly MessagePort: false;
+            readonly module: false;
+            readonly navigator: false;
+            readonly Navigator: false;
+            readonly performance: false;
+            readonly Performance: false;
+            readonly PerformanceEntry: false;
+            readonly PerformanceMark: false;
+            readonly PerformanceMeasure: false;
+            readonly PerformanceObserver: false;
+            readonly PerformanceObserverEntryList: false;
+            readonly PerformanceResourceTiming: false;
+            readonly process: false;
+            readonly queueMicrotask: false;
+            readonly ReadableByteStreamController: false;
+            readonly ReadableStream: false;
+            readonly ReadableStreamBYOBReader: false;
+            readonly ReadableStreamBYOBRequest: false;
+            readonly ReadableStreamDefaultController: false;
+            readonly ReadableStreamDefaultReader: false;
+            readonly Request: false;
+            readonly require: false;
+            readonly Response: false;
+            readonly sessionStorage: false;
+            readonly setImmediate: false;
+            readonly setInterval: false;
+            readonly setTimeout: false;
+            readonly Storage: false;
+            readonly structuredClone: false;
+            readonly SubtleCrypto: false;
+            readonly SuppressedError: false;
+            readonly TextDecoder: false;
+            readonly TextDecoderStream: false;
+            readonly TextEncoder: false;
+            readonly TextEncoderStream: false;
+            readonly TransformStream: false;
+            readonly TransformStreamDefaultController: false;
+            readonly URL: false;
+            readonly URLPattern: false;
+            readonly URLSearchParams: false;
+            readonly WebAssembly: false;
+            readonly WebSocket: false;
+            readonly WritableStream: false;
+            readonly WritableStreamDefaultController: false;
+            readonly WritableStreamDefaultWriter: false;
+            readonly after: false;
+            readonly afterEach: false;
+            readonly before: false;
+            readonly beforeEach: false;
+            readonly context: false;
+            readonly describe: false;
+            readonly it: false;
+            readonly mocha: false;
+            readonly run: false;
+            readonly setup: false;
+            readonly specify: false;
+            readonly suite: false;
+            readonly suiteSetup: false;
+            readonly suiteTeardown: false;
+            readonly teardown: false;
+            readonly test: false;
+            readonly xcontext: false;
+            readonly xdescribe: false;
+            readonly xit: false;
+            readonly xspecify: false;
+            readonly $: false;
+            readonly $$: false;
+            readonly browser: false;
+            readonly driver: false;
+            readonly expect: false;
+            readonly multiremotebrowser: false;
+            readonly multiRemoteBrowser: false;
+        };
+    };
+    plugins: {
+        wdio: {
+            configs: {};
+            rules: {
+                'await-expect': import("eslint").Rule.RuleModule;
+                'no-debug': import("eslint").Rule.RuleModule;
+                'no-pause': import("eslint").Rule.RuleModule;
+            };
+        };
+    };
+    rules: {
+        'wdio/await-expect': string;
+        'wdio/no-debug': string;
+        'wdio/no-pause': string;
+    };
+};
+export default _default;
+//# sourceMappingURL=js-recommended.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"js-recommended.d.ts","sourceRoot":"","sources":["../../src/configs/js-recommended.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,wBAaC"}

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

@@ -0,0 +1,146 @@
+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: {
+            readonly __dirname: false;
+            readonly __filename: false;
+            readonly AbortController: false;
+            readonly AbortSignal: false;
+            readonly AsyncDisposableStack: false;
+            readonly atob: false;
+            readonly Blob: false;
+            readonly BroadcastChannel: false;
+            readonly btoa: false;
+            readonly Buffer: false;
+            readonly ByteLengthQueuingStrategy: false;
+            readonly clearImmediate: false;
+            readonly clearInterval: false;
+            readonly clearTimeout: false;
+            readonly CloseEvent: false;
+            readonly CompressionStream: false;
+            readonly console: false;
+            readonly CountQueuingStrategy: false;
+            readonly crypto: false;
+            readonly Crypto: false;
+            readonly CryptoKey: false;
+            readonly CustomEvent: false;
+            readonly DecompressionStream: false;
+            readonly DisposableStack: false;
+            readonly DOMException: false;
+            readonly ErrorEvent: false;
+            readonly Event: false;
+            readonly EventTarget: false;
+            readonly exports: true;
+            readonly fetch: false;
+            readonly File: false;
+            readonly FormData: false;
+            readonly global: false;
+            readonly Headers: false;
+            readonly localStorage: false;
+            readonly MessageChannel: false;
+            readonly MessageEvent: false;
+            readonly MessagePort: false;
+            readonly module: false;
+            readonly navigator: false;
+            readonly Navigator: false;
+            readonly performance: false;
+            readonly Performance: false;
+            readonly PerformanceEntry: false;
+            readonly PerformanceMark: false;
+            readonly PerformanceMeasure: false;
+            readonly PerformanceObserver: false;
+            readonly PerformanceObserverEntryList: false;
+            readonly PerformanceResourceTiming: false;
+            readonly process: false;
+            readonly queueMicrotask: false;
+            readonly ReadableByteStreamController: false;
+            readonly ReadableStream: false;
+            readonly ReadableStreamBYOBReader: false;
+            readonly ReadableStreamBYOBRequest: false;
+            readonly ReadableStreamDefaultController: false;
+            readonly ReadableStreamDefaultReader: false;
+            readonly Request: false;
+            readonly require: false;
+            readonly Response: false;
+            readonly sessionStorage: false;
+            readonly setImmediate: false;
+            readonly setInterval: false;
+            readonly setTimeout: false;
+            readonly Storage: false;
+            readonly structuredClone: false;
+            readonly SubtleCrypto: false;
+            readonly SuppressedError: false;
+            readonly TextDecoder: false;
+            readonly TextDecoderStream: false;
+            readonly TextEncoder: false;
+            readonly TextEncoderStream: false;
+            readonly TransformStream: false;
+            readonly TransformStreamDefaultController: false;
+            readonly URL: false;
+            readonly URLPattern: false;
+            readonly URLSearchParams: false;
+            readonly WebAssembly: false;
+            readonly WebSocket: false;
+            readonly WritableStream: false;
+            readonly WritableStreamDefaultController: false;
+            readonly WritableStreamDefaultWriter: false;
+            readonly after: false;
+            readonly afterEach: false;
+            readonly before: false;
+            readonly beforeEach: false;
+            readonly context: false;
+            readonly describe: false;
+            readonly it: false;
+            readonly mocha: false;
+            readonly run: false;
+            readonly setup: false;
+            readonly specify: false;
+            readonly suite: false;
+            readonly suiteSetup: false;
+            readonly suiteTeardown: false;
+            readonly teardown: false;
+            readonly test: false;
+            readonly xcontext: false;
+            readonly xdescribe: false;
+            readonly xit: false;
+            readonly xspecify: false;
+            readonly $: false;
+            readonly $$: false;
+            readonly browser: false;
+            readonly driver: false;
+            readonly expect: false;
+            readonly multiremotebrowser: false;
+            readonly multiRemoteBrowser: false;
+        };
+        parser: any;
+        parserOptions: {
+            projectService: boolean;
+        };
+    };
+    plugins: {
+        wdio: {
+            rules: {
+                'no-floating-promise': Rule.RuleModule;
+                'await-expect': Rule.RuleModule;
+                'no-debug': Rule.RuleModule;
+                'no-pause': Rule.RuleModule;
+            };
+            configs: {};
+        };
+    };
+    rules: {
+        'wdio/await-expect': string;
+        'wdio/no-debug': string;
+        'wdio/no-pause': string;
+        'wdio/no-floating-promise': string;
+    };
+    ignores: string[];
+} | undefined;
+export default _default;
+//# sourceMappingURL=ts-recommended.d.ts.map

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

@@ -0,0 +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"}

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,UA2BpB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,UAwCpB,CAAA"}

package/build/globals.d.ts

@@ -0,0 +1,112 @@
+export declare const sharedGlobals: {
+    readonly __dirname: false;
+    readonly __filename: false;
+    readonly AbortController: false;
+    readonly AbortSignal: false;
+    readonly AsyncDisposableStack: false;
+    readonly atob: false;
+    readonly Blob: false;
+    readonly BroadcastChannel: false;
+    readonly btoa: false;
+    readonly Buffer: false;
+    readonly ByteLengthQueuingStrategy: false;
+    readonly clearImmediate: false;
+    readonly clearInterval: false;
+    readonly clearTimeout: false;
+    readonly CloseEvent: false;
+    readonly CompressionStream: false;
+    readonly console: false;
+    readonly CountQueuingStrategy: false;
+    readonly crypto: false;
+    readonly Crypto: false;
+    readonly CryptoKey: false;
+    readonly CustomEvent: false;
+    readonly DecompressionStream: false;
+    readonly DisposableStack: false;
+    readonly DOMException: false;
+    readonly ErrorEvent: false;
+    readonly Event: false;
+    readonly EventTarget: false;
+    readonly exports: true;
+    readonly fetch: false;
+    readonly File: false;
+    readonly FormData: false;
+    readonly global: false;
+    readonly Headers: false;
+    readonly localStorage: false;
+    readonly MessageChannel: false;
+    readonly MessageEvent: false;
+    readonly MessagePort: false;
+    readonly module: false;
+    readonly navigator: false;
+    readonly Navigator: false;
+    readonly performance: false;
+    readonly Performance: false;
+    readonly PerformanceEntry: false;
+    readonly PerformanceMark: false;
+    readonly PerformanceMeasure: false;
+    readonly PerformanceObserver: false;
+    readonly PerformanceObserverEntryList: false;
+    readonly PerformanceResourceTiming: false;
+    readonly process: false;
+    readonly queueMicrotask: false;
+    readonly ReadableByteStreamController: false;
+    readonly ReadableStream: false;
+    readonly ReadableStreamBYOBReader: false;
+    readonly ReadableStreamBYOBRequest: false;
+    readonly ReadableStreamDefaultController: false;
+    readonly ReadableStreamDefaultReader: false;
+    readonly Request: false;
+    readonly require: false;
+    readonly Response: false;
+    readonly sessionStorage: false;
+    readonly setImmediate: false;
+    readonly setInterval: false;
+    readonly setTimeout: false;
+    readonly Storage: false;
+    readonly structuredClone: false;
+    readonly SubtleCrypto: false;
+    readonly SuppressedError: false;
+    readonly TextDecoder: false;
+    readonly TextDecoderStream: false;
+    readonly TextEncoder: false;
+    readonly TextEncoderStream: false;
+    readonly TransformStream: false;
+    readonly TransformStreamDefaultController: false;
+    readonly URL: false;
+    readonly URLPattern: false;
+    readonly URLSearchParams: false;
+    readonly WebAssembly: false;
+    readonly WebSocket: false;
+    readonly WritableStream: false;
+    readonly WritableStreamDefaultController: false;
+    readonly WritableStreamDefaultWriter: false;
+    readonly after: false;
+    readonly afterEach: false;
+    readonly before: false;
+    readonly beforeEach: false;
+    readonly context: false;
+    readonly describe: false;
+    readonly it: false;
+    readonly mocha: false;
+    readonly run: false;
+    readonly setup: false;
+    readonly specify: false;
+    readonly suite: false;
+    readonly suiteSetup: false;
+    readonly suiteTeardown: false;
+    readonly teardown: false;
+    readonly test: false;
+    readonly xcontext: false;
+    readonly xdescribe: false;
+    readonly xit: false;
+    readonly xspecify: false;
+    readonly $: false;
+    readonly $$: false;
+    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

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