@codeceptjs/configure

What is @codeceptjs/configure?

@codeceptjs/configure is a utility package for configuring CodeceptJS, a popular end-to-end testing framework. It simplifies the process of setting up and managing configurations for CodeceptJS tests, allowing users to easily switch between different configurations and environments.

What are @codeceptjs/configure's main functionalities?

Set Configuration

This feature allows you to set configurations based on environment variables. In this example, the `setHeadlessWhen` function sets the browser to headless mode if the `HEADLESS` environment variable is true.

const { setHeadlessWhen } = require('@codeceptjs/configure');
setHeadlessWhen(process.env.HEADLESS);

Customize Configuration

This feature allows you to customize the window size for your tests. The `setWindowSize` function sets the browser window size to 1920x1080.

const { setWindowSize } = require('@codeceptjs/configure');
setWindowSize(1920, 1080);

Load Environment Variables

This feature allows you to load environment variables from a file. The `loadEnv` function loads environment variables from a `.env` file.

const { loadEnv } = require('@codeceptjs/configure');
loadEnv('.env');

Other packages similar to @codeceptjs/configure

dotenv

dotenv is a zero-dependency module that loads environment variables from a .env file into process.env. It is similar to the `loadEnv` feature of @codeceptjs/configure but does not provide other configuration utilities.

config

config is a configuration manager for Node.js applications. It allows you to define a set of default parameters and override them with environment-specific values. It provides more comprehensive configuration management compared to @codeceptjs/configure.

cross-env

cross-env allows you to set environment variables across different platforms. It is useful for setting environment variables in a way that works for both Windows and Unix-based systems. It is similar to the environment variable management features of @codeceptjs/configure.

README

Configuring CodeceptJS with Hooks

This package container useful hooks to solve common configuration issues:

useHeadlessWhen

This hook enables headless mode for Puppeteer, WebDriver, TestCafe, and Nightmare.

Usage:

const { useHeadlessWhen } = require('@codeceptjs/configure');

// enable headless only if environment variable HEADLESS exist
useHeadlessWhen(process.env.HEADLESS); 

// enable headless on CI
useHeadlessWhen(process.env.CI); 

exports.config = {
  helpers: {
    // standard config goes here
  }
}