cypress-dotenv v3.x

- Upgrading Cypress and DotEnv to the latest version
- Dropping support for anything below Node v18
- Minimum version of Cypress is now v10
- Fixing #32

Author: morficus

.env

@@ -3,4 +3,5 @@ NON_CYPRESS_TEST_VAR=goodbye
 CYPRESS_BASE_URL=http://google.com
 CYPRESS_ENV=testing
 CYPRESS_I_AM_NUMBER=100
-CYPRESS_I_AM_BOOLEAN=true
+CYPRESS_I_AM_BOOLEAN=true
+CYPRESS_I_AM_A_NUMBER_WITH_LEADING_ZERO=0100

.github/pull_request_template.md

@@ -10,25 +10,9 @@ Please fill out this section with a description of your changes and your approac
 
 _fill me out 📝_
 
-## How to test/verify these changes
+## Verification Checklist
 
-<!--
-Replace the sample steps below with steps on how a reviewer of this PR can test your changes. This should include things such as (if applicable):
-* Do you need to use a specific account to log in?
-* Is there a particular patient profile that should be used?
--->
-
-1. Clone this branch and run: `npm run cypress`
-1. Next, do thing 1
-1. Now do thing 2
-1. Notice that XYZ has changed
-
-
-## Screenshots and/or video
-
-<!--
-If relevant, make sure to include relevant video or before/after screenshots  that demonstrate the changes.
-If no visuals are required, then please fill out this section with "N/A"
--->
-
-_fill me out 📸_
+- [ ] Provided a good description of the changes introduced with this PR.
+- [ ] Written adequate unit tests (if necessary)
+- [ ] Updated the README (if necessary)
+- [ ] Make sure things still work with v10 and up of Cypress

.github/workflows/pr-quality-checks.yml

@@ -1,6 +1,9 @@
 # Run a number of quality checks ever time a PR is opened
 name: Pull Request Quality Checks
 
+permissions:
+  contents: read
+  pull-requests: read
 on:
   workflow_dispatch:
     inputs:
@@ -60,3 +63,20 @@ jobs:
         env:
           CI: true
           NODE_ENV: test
+
+  integration-testing:
+    name: Integration testing
+    runs-on: ubuntu-latest
+    needs: setup
+    steps:
+      # restore dependencies that were installed in the `setup` job
+      - name: Restore dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ./*
+            ~/.npm
+          key: ${{ github.sha }}
+
+      - name: Cypress Run
+        uses: cypress-io/github-action@v6

.nvmrc

@@ -1 +1 @@
-20
+18

README.md

@@ -1,6 +1,10 @@
 # Cypress dotenv
 
-Cypress plugin that enables compatability with [dotenv](https://www.npmjs.com/package/dotenv).  
+Cypress plugin that enables compatibility with [dotenv](https://www.npmjs.com/package/dotenv).  
+
+> [!NOTE]
+> If you need support for Cypress v9 or below, please use [v2.x of this plugin](https://github.com/morficus/cypress-dotenv/tree/v2.0.2)
+
 
 [![Build Status](https://travis-ci.org/morficus/cypress-dotenv.svg?branch=master)](https://travis-ci.org/morficus/cypress-dotenv)
 [![Maintainability](https://api.codeclimate.com/v1/badges/0d189dae8e924ada81ad/maintainability)](https://codeclimate.com/github/morficus/cypress-dotenv/maintainability)
@@ -35,41 +39,33 @@ yarn add --dev dotenv cypress-dotenv
 
 ## Configure
 
-Cypress (< 10.0.0)
-
-Since this is a plugin, you will need to modify your file `cypress/plugins/index.js` to look something like this:
-
-```javascript
-const dotenvPlugin = require('cypress-dotenv');
-module.exports = (on, config) => {
-  config = dotenvPlugin(config)
-  return config
-}
-```
+Version 3.x of this plugin only supports Cypress v10+. For instructions on how to set up this plugin with older versions of Cypress, please refer to the [v2.x README](https://github.com/morficus/cypress-dotenv/tree/v2.0.2?tab=readme-ov-file#configure)
 
-Cypress (>= 10.0.0)
 
-According to [Migration Guide](https://docs.cypress.io/guides/references/migration-guide#Plugins-File-Removed):
-The setupNodeEvents() config option is functionally equivalent to the function exported from the plugins file
+Since this is a plugin, you will need to modify your `cypress.config.js` to look something like this
 
-```javascript
+```typescript
 import { defineConfig } from 'cypress'
 import dotenvPlugin from 'cypress-dotenv'
 
 export default defineConfig({
-	e2e: {
-                ...
-		setupNodeEvents(on, config) {
-			return dotenvPlugin(config)
-		},
+ e2e: {
+	...
+	setupNodeEvents(on, config) {
+		const updatedConfig = dotenvPlugin(config, null, true)
+		// continue loading other plugins
+		return updatedConfig
+	},
 	},
 	...
 })
 ```
 
-## Options
-This plugin takes three paramaters. The first parameter (which is mandatory) is the Cypress config object. 
 
-The second is an optional [dotenv](https://www.npmjs.com/package/dotenv#config) config object.
 
-The third is an optional [all] boolean parameter, which is set to false by default. If set to true, it returns all available environmental variables, not limited to those prefixed with CYPRESS_.
+## Options
+This plugin takes three parameters:
+
+1. The first parameter (which is mandatory) is the Cypress config object. 
+1. The second is an optional [dotenv](https://www.npmjs.com/package/dotenv#config) config object.
+1. The third (called `all`) is an optional boolean parameter, which is set to false by default. If set to true, it returns all available environmental variables, not limited to those prefixed with CYPRESS_.

cypress.config.js

@@ -0,0 +1,16 @@
+const { defineConfig } = require('cypress')
+const dotenvPlugin = require('./index')
+
+module.exports = defineConfig({
+  video: false,
+  e2e: {
+    // We've imported your old cypress plugins here.
+    // You may want to clean this up later by importing these.
+    setupNodeEvents(on, config) {
+      const updatedConfig = dotenvPlugin(config, null, true)
+      // continue loading other plugins
+
+      return updatedConfig
+    }
+  }
+})