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.

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

{
    "plugins": ["wdio"],
    "extends": [
        "eslint:recommended",
        "plugin:wdio/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.0.8 (2024-09-05)

:rocket: New Feature

• wdio-protocols, webdriverio
  • #13481 feat(webdriverio): set cookies via Bidi if supported (@christian-bromann)

:bug: Bug Fix

• webdriverio
  • #13470 fix(webdriverio): fix script execution (@christian-bromann)
• Other
  • #13478 fix(webdriverio): better detect manually created shadow roots (@christian-bromann)
• eslint-plugin-wdio, wdio-allure-reporter, wdio-appium-service, wdio-browser-runner, wdio-browserstack-service, wdio-cli, wdio-concise-reporter, wdio-config, wdio-cucumber-framework, wdio-dot-reporter, wdio-firefox-profile-service, wdio-globals, wdio-jasmine-framework, wdio-junit-reporter, wdio-lighthouse-service, wdio-local-runner, wdio-logger, wdio-mocha-framework, wdio-repl, wdio-reporter, wdio-runner, wdio-sauce-service, wdio-shared-store-service, wdio-smoke-test-cjs-service, wdio-smoke-test-reporter, wdio-smoke-test-service, wdio-spec-reporter, wdio-static-server-service, wdio-sumologic-reporter, wdio-testingbot-service, wdio-types, wdio-utils, wdio-webdriver-mock-service, webdriver, webdriverio
  • #13482 fix(core): specify minimum node version to be 18.20.0 or higher (@christian-bromann)
• wdio-browser-runner
  • #13489 fix(@wdio/browser-runner): support Firefox using Bidi (@christian-bromann)

:nail_care: Polish

• wdio-browserstack-service
  • #13437 Browserstack Turboscale Observability Integration (@amaanbs)

:memo: Documentation

• wdio-shared-store-service
  • #13514 Added information on typescript types for wdio-shared-store-service (@sauterl)
• Other
  • #13486 Fix addInitScript example in v9 blog post (@Mr0grog)
  • #13483 docs: small typo in BestPractices.md (@alcpereira)
  • #13466 Argos visual testing page (@gregberge)

Committers: 8

• Amaan Hakim (@amaanbs)
• Boris Osipov (@BorisOsipov)
• Christian Bromann (@christian-bromann)
• Greg Bergé (@gregberge)
• Loris Sauter (@sauterl)
• Rob Brackett (@Mr0grog)
• Wim Selles (@wswebcreation)
• @alcpereira