eslint-plugin-webdriverio

1.0.1 verified Sat Apr 25 auth: no javascript

ESLint plugin that provides environment settings for WebdriverIO globals (browser, $, $$). Current stable version is 1.0.1. It is a small, focused plugin that adds a custom environment 'webdriverio/wdio' to ESLint, preventing no-undef errors when using WebdriverIO's globally available helpers. Unlike generic globals configuration, this plugin allows granular control by scoping to the 'wdio' environment, making it easy to combine with other environments like Mocha. Primarily used in WebdriverIO test projects.

Common errors

error Parsing error: The keyword 'env' is reserved ↓

cause Using 'env' property incorrectly in .eslintrc (e.g. without proper JSON structure).

fix

Ensure .eslintrc is valid JSON and 'env' is an object.

error Environment key "webdriverio/wdio" is unknown ↓

cause The plugin is not added to the 'plugins' array.

fix

Add 'plugins: ["webdriverio"]' to your ESLint config.

Warnings

gotcha Environment must be 'webdriverio/wdio' not just 'wdio' ↓

fix Use 'webdriverio/wdio' in env or eslint-env comment.

gotcha Plugin name in plugins array must be 'webdriverio' not 'eslint-plugin-webdriverio' ↓

fix Use 'webdriverio' in plugins array.

Install

npm install eslint-plugin-webdriverio

yarn add eslint-plugin-webdriverio

pnpm add eslint-plugin-webdriverio

Imports

plugin (eslint-plugin)
wrong
```
plugins: ['eslint-plugin-webdriverio']
```
correct
```
plugins: ['webdriverio']
```
ESLint plugin names are specified without the 'eslint-plugin-' prefix.
environment (webdriverio/wdio)
wrong
```
env: { wdio: true }
```
correct
```
env: { 'webdriverio/wdio': true }
```
The environment key includes the plugin name prefix, as 'webdriverio/wdio'.
environment directive
wrong
```
/* eslint-env wdio */
```
correct
```
/* eslint-env webdriverio/wdio */
```
Inline environment directives must also use the full 'webdriverio/wdio' name.

Quickstart

Shows how to configure ESLint with the webdriverio environment to avoid no-undef errors for WebdriverIO globals.

// .eslintrc.json
{
  "plugins": ["webdriverio"],
  "env": {
    "webdriverio/wdio": true,
    "mocha": true
  }
}

// test.spec.js
/* eslint-env webdriverio/wdio, mocha */
describe('My test', () => {
  it('should work', () => {
    browser.url('https://example.com');
    const heading = $('h1');
    console.log(heading.getText());
  });
});