Skip to content

kellen-xavier/cypress-plugin-dotenv

 
 

Repository files navigation

cypress-plugin-dotenv

npm version   TypeScript   tests

⚙️ Install

  • npm:
npm install cypress-plugin-dotenv
  • yarn:
yarn add cypress-plugin-dotenv
  • pnpm:
pnpm add cypress-plugin-dotenv

🧪 Usage

Import the plugin into your config file:

import { dotenv } from 'cypress-plugin-dotenv';
// or
const dotenv = require('cypress-plugin-dotenv');

export default defineConfig({
  e2e: {
    setupNodeEvents: (_, config) => {
      return dotenv(config);
    }
  }
});

🔧 Dynamic Types

Automate TypeScript definitions for .env with:

import { generateEnvTypes } from 'cypress-plugin-dotenv';

on('before:browser:launch', (browser, launchOptions) => {
  generateEnvTypes(outputPath, options);

  // your code
});

⚠️ Important: Run Cypress once after setup to initialize the types.

📐 Example

Take a look at cypress folder

License

This project is licensed under the terms of the MIT license.

About

Load .env variables in Cypress

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 93.2%
  • Shell 6.8%