eslint-plugin-wdio

ESLint rules for WebdriverIO

Installation

You'll first need to install ESLint:

``sh
npm i eslint --save-dev
`

Next, install eslint-plugin-wdio:

`sh
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.

$3

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

`json
{
"plugins": ["wdio"],
"extends": [
"eslint:recommended",
"plugin:wdio/recommended"
]
}
`

$3

If you are using the latest version of Eslint with the flat configuration, 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'],
// ...
]
}
];
`

See ESLint documentation for more information about extending configuration files.

List of supported rules


- 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()` statements