@wdio/repl

What is @wdio/repl?

@wdio/repl is a package that provides a Read-Eval-Print Loop (REPL) interface for WebdriverIO. It allows users to interactively run WebDriver commands in a Node.js REPL environment, making it easier to debug and test WebDriver scripts.

What are @wdio/repl's main functionalities?

Interactive Command Execution

This feature allows users to start a REPL session with a WebDriver instance, enabling them to execute WebDriver commands interactively.

const { remote } = require('webdriverio');
const repl = require('@wdio/repl');

(async () => {
    const browser = await remote({
        capabilities: { browserName: 'chrome' }
    });

    await repl.start(browser);
})();

Custom REPL Commands

This feature allows users to define custom commands that can be executed within the REPL session, providing more flexibility and control over the WebDriver instance.

const { remote } = require('webdriverio');
const repl = require('@wdio/repl');

(async () => {
    const browser = await remote({
        capabilities: { browserName: 'chrome' }
    });

    const customCommands = {
        'screenshot': async () => {
            const screenshot = await browser.takeScreenshot();
            console.log('Screenshot taken:', screenshot);
        }
    };

    await repl.start(browser, customCommands);
})();

Other packages similar to @wdio/repl

selenium-webdriver

selenium-webdriver is a popular package for controlling web browsers through the WebDriver protocol. It provides a comprehensive API for browser automation but does not include a built-in REPL interface like @wdio/repl.

nightwatch

Nightwatch is an end-to-end testing framework that uses the WebDriver protocol. It includes a built-in REPL interface for interactive command execution, similar to @wdio/repl, but is more focused on providing a complete testing framework.

cypress

Cypress is a modern end-to-end testing framework that provides a rich interactive environment for running tests. While it does not use the WebDriver protocol, it offers a similar interactive experience for debugging and testing web applications.

README

WDIO Repl

A WDIO helper utility to provide a repl interface WebdriverIO

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