Cypress Env Plugin

An unofficial plugin for loading your environment into your Cypress environment, such as dotenv.

Installation

npm

1npm i -D cypress-env-plugin

yarn

1yarn add -D cypress-env-plugin

Usage

In your cypress/plugins/index.js file:

Basic example

1const { createEnvPlugin } = require('cypress-env-plugin');
2/**
3 * With no prefix a .env of:
4 * SECRET_KEY=SECRET_KEY
5 * CYPRESS_API_URL=https://api.cool.com/api/
6 *
7 * Will expose to Cypress Env:
8 * API_URL=https://api.cool.com/api/
9 */
10// Initialise the plugin
11const envPlugin = createEnvPlugin({
12  env: require('dotenv').config(),
13});
14
15module.exports = (on, config) => {
16  // Add the plugin
17  envPlugin(config);
18  return config;
19};

Remove prefix restriction example

By default, we filter out any environment variables unless they're prefixed with CYPRESS_, if you want to load everything from your .env you can pass null to the prefix property,

1const { createEnvPlugin } = require('cypress-env-plugin');
2/**
3 * With a null prefix a .env of:
4 * SECRET_KEY=SECRET_KEY
5 * CYPRESS_API_URL=https://api.cool.com/api/
6 *
7 * Will expose to Cypress Env:
8 * SECRET_KEY=SECRET_KEY
9 * CYPRESS_API_URL=https://api.cool.com/api/
10 */
11// Initialise the plugin
12const envPlugin = createEnvPlugin({
13  env: require('dotenv').config(),
14});
15
16module.exports = (on, config) => {
17  // Add the plugin
18  envPlugin(config);
19  return config;
20};

Custom prefix example

You can also provide your own prefix:

1const withCustomPrefix = createEnvPlugin({
2  prefix: 'WHATEVER_',
3  env: require('dotenv').config(),
4});

Plain object example

I'm not sure why, but you can also pass a plain object for your environment. process.env maybe?

1const withCustomPrefix = createEnvPlugin({
2  prefix: 'WHATEVER_',
3  env: {
4    WHATEVER_API_KEY: '123578123718923',
5  },
6});

Contributing

Local Development

Below is a list of commands you will probably find useful.

npm start or yarn start

Runs the project in development/watch mode. Your project will be rebuilt upon changes.

npm run build or yarn build

Bundles the package to the dist folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

npm test or yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.