eslint-plugin-wdio

eslint-plugin-wdio

ESLint rules for WebdriverIO

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-wdio:

npm install eslint-plugin-wdio --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-wdio globally.

Recommended configuration

This plugin export a recommended configuration that enforce good practices.

With Eslint v8 and below

To enable this configuration use the extends property in your .eslintrc config file:

{
    "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, you can embed this plugin as follows:

// eslint.config.mjs
import { config as wdioConfig } from "eslint-plugin-wdio";

export default [
    {
        extends: [
            wdioConfig['flat/recommended'],
            // ...
        ]
    }
];

See ESLint documentation for more information about extending configuration files.

List of supported rules

Rule	Description
wdio/await-expect	expect calls must be prefixed with an await
wdio/no-debug	Don't allow browser.debug() statements
wdio/no-pause	Don't allow browser.pause(<number>) statements

Changelog

v9.2.11 (2024-11-07)

:bug: Bug Fix

• webdriverio
  • #13863 fix(webdriverio): properly handle unresolved element on switchFrame input in non-BIDI scenario (@gavvvr)
  • #13857 fix(webdriverio): switchWindow supports exact window handle match (@jan-molak)
• wdio-browserstack-service
  • #13858 fix: stacktrace for testobservability (@07souravkunda)
  • #13833 Build Unification - WDIO Mocha, Cucumber, Jasmine - Browserstack Test Observability, Accessibility & Percy (@amaanbs)

:nail_care: Polish

• wdio-browserstack-service
  • #13864 Show complete error (@07souravkunda)

:memo: Documentation

• eslint-plugin-wdio
  • #13866 docs(eslint-plugin-wdio): add example to use Eslint v9 (@christian-bromann)
• wdio-cli
  • #13865 docs: various documentation fixes (@gavvvr)

Committers: 6

• Amaan Hakim (@amaanbs)
• Christian Bromann (@christian-bromann)
• Jan Molak (@jan-molak)
• Kirill Gavrilov (@gavvvr)
• Sourav Kunda (@07souravkunda)
• Wim Selles (@wswebcreation)