@wdio/config

What is @wdio/config?

The @wdio/config package is part of the WebdriverIO testing framework, which provides utilities for managing and configuring WebDriver sessions for automated testing of web applications. It is primarily used to handle and manipulate the configuration of WebdriverIO tests, making it easier to set up different testing environments and integrate various services or plugins.

What are @wdio/config's main functionalities?

Configuration Merging

This feature allows users to merge multiple configuration objects into one. It is useful for combining default settings with user-provided settings, ensuring flexibility and customization of test setups.

const { merge } = require('@wdio/config');
const defaultConfig = { baseUrl: 'http://localhost' };
const userConfig = { baseUrl: 'http://example.com' };
const finalConfig = merge(defaultConfig, userConfig);
console.log(finalConfig);

Configuration Validation

This feature ensures that the configuration object meets the necessary schema requirements set by WebdriverIO. It helps in catching configuration errors early in the setup process, thus avoiding runtime errors during test execution.

const { validateConfig } = require('@wdio/config');
const wdioConfig = { specs: ['./tests/specs/*'], capabilities: [{ browserName: 'chrome' }] };
validateConfig(wdioConfig);
console.log('Configuration is valid!');

Other packages similar to @wdio/config

protractor

Protractor is an end-to-end test framework for Angular and AngularJS applications. It works as a solution integrator combining powerful tools and technologies such as Selenium, Jasmine, Webdriver, etc. While it also manages WebDriver configurations, it is specifically tailored for Angular applications, unlike @wdio/config which is more generic and framework-agnostic.

nightwatch

Nightwatch.js is an automated testing framework for web applications and websites, using the W3C WebDriver API. It has its own test runner and asserts library, but like @wdio/config, it allows for configuration of WebDriver sessions. Nightwatch is less modular compared to WebdriverIO and @wdio/config, which can integrate with a wider variety of other tools and frameworks.

README

WDIO Configurations Utility

A helper utility to parse and validate WebdriverIO options

Changelog

v9.0.4 (2024-08-19)

:bug: Bug Fix

• webdriverio
  • #13389 fix(webdriverio): execute command when using bidi (@christian-bromann)
  • #13388 fix(webdriverio): update getHTML docs (@christian-bromann)
• wdio-reporter, wdio-webdriver-mock-service
  • #13219 fix(@wdio/reporter): transform scripts in TestStats (#13209) (@johnp)

:house: Internal

• wdio-browser-runner, wdio-cucumber-framework, wdio-mocha-framework, wdio-smoke-test-cjs-service, wdio-smoke-test-service, wdio-utils, webdriverio
  • #13385 fix(infra): retry type generation (@christian-bromann)
• Other
  • #13383 feat: pkg.pr.new (@Aslemammad)

Committers: 3

• Christian Bromann (@christian-bromann)
• Johannes Pfrang (@johnp)
• Mohammad Bagher Abiyat (@Aslemammad)