chore: initial commit

Author: KernelPanic92

.eslintignore

@@ -0,0 +1,5 @@
+dist
+package.json
+./node_modules/
+.vscode
+.idea

.eslintrc.json

@@ -0,0 +1,50 @@
+{
+  "root": true,
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "env": {
+    "es6": true
+  },
+  "plugins": ["simple-import-sort"],
+  "overrides": [
+    {
+      "parserOptions": {
+        "project": "./tsconfig.json"
+      },
+      "files": [
+        "lib/src/**/*.ts"
+      ],
+      "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended"
+      ],
+      "rules": {
+        "simple-import-sort/imports": "error",
+        "simple-import-sort/exports": "error",
+        "@typescript-eslint/ban-ts-comment": 0,
+        "max-lines-per-function": [
+          1,
+          {
+            "max": 40
+          }
+        ],
+        "max-lines": [
+          1,
+          {
+            "max": 150
+          }
+        ]
+      }
+    },
+    {
+      "parserOptions": {
+        "project": "./tsconfig.json"
+      },
+      "files": [
+        "lib/src/**/*.ts"
+      ]
+    }
+  ]
+}

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20'
+
+      - name: Setup Corepack
+        run: |
+          corepack enable
+          corepack prepare npm@10.8.1 --activate
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build
+
+      - name: Run Semantic Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.npmignore

@@ -0,0 +1,13 @@
+.idea/
+.github
+.gitignore
+.prettierrc.json
+.DS_Store
+CONTRIBUTE.md
+
+# configuration
+renovate.json
+tsconfig.json
+/.vscode
+.eslintrc.json
+.eslintignore

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "auto",
+  "printWidth": 100
+}

.releaserc.js

@@ -0,0 +1,22 @@
+/**
+ * @type {import('semantic-release').GlobalConfig}
+ */
+const releaseConfig = {
+  branches: ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ]
+};
+
+module.exports = releaseConfig;

README.md

@@ -0,0 +1,106 @@
+# @devmy/cypress-dotenv
+
+`@devmy/cypress-dotenv` is a TypeScript library designed to integrate `dotenv` configuration with `@dotenv-run/core` into your Cypress setup, simplifying the management of environment variables for both component and end-to-end (E2E) tests.
+
+- ✅ Load environment variables from .env files
+- ✅ Load environment variables from .env.vault files
+- ✅ Expand environment variables API_URL=$API_BASE/users
+- ✅ Define environment variables for a specific environment (e.g. .env.production)
+- ✅ Load priorities of .env.* files (e.g. .env.production > .env)
+- ✅ Hierarchical cascading configuration in monorepo projects (Nx, Turbo, etc.) apps/next-app/.env > apps/.env > .env
+
+## Installation
+
+Install the package via npm:
+
+```bash
+npm install @devmy/cypress-dotenv
+```
+
+or via yarn:
+
+```bash
+yarn add @devmy/cypress-dotenv
+```
+
+or via pnpm:
+
+```bash
+pnpm add @devmy/cypress-dotenv
+```
+
+## Usage
+
+### Dotenv Configuration
+The `dotenv` configuration options in this library use `DotenvRunOptions` of [dotenv-run/core](https://www.npmjs.com/package/@dotenv-run/core).
+
+### `defineConfigWithDotenv`
+
+The `defineConfigWithDotenv` function invokes Cypress's `defineConfig`, loading environment variables from `dotenv`.
+
+#### Example:
+
+```typescript
+import { defineConfigWithDotenv } from '@devmy/cypress-dotenv';
+
+export default defineConfigWithDotenv({
+   dotenv: {
+    prefix: 'FRONTEND_E2E_',
+    root: '../../',
+  },
+  component: {
+    specPattern: 'src/**/*.cy.ts',
+  },
+  e2e: {
+    baseUrl: 'http://localhost:3000',
+  },
+});
+```
+
+### `dotenvComponentPreset`
+
+The `dotenvComponentPreset` function loads `dotenv` for component tests in Cypress.
+
+#### Example:
+
+```typescript
+import { dotenvComponentPreset } from '@devmy/cypress-dotenv';
+
+export default dotenvComponentPreset({
+  dotenv: {
+    prefix: 'FRONTEND_E2E_',
+    root: '../../',
+  },
+  devServer: {
+    framework: 'react',
+    bundler: 'webpack',
+  },
+});
+```
+
+### `dotenvE2EPreset`
+
+The `dotenvE2EPreset` function loads `dotenv` for E2E tests in Cypress.
+
+#### Example:
+
+```typescript
+import { dotenvE2EPreset } from '@devmy/cypress-dotenv';
+
+export default dotenvE2EPreset({
+  dotenv: {
+    prefix: 'FRONTEND_E2E_',
+    root: '../../',
+  },
+  baseUrl: 'http://localhost:3000',
+});
+```
+
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any changes.

lib/src/define-config.ts

@@ -0,0 +1,25 @@
+import { DotenvRunOptions } from '@dotenv-run/core';
+import { defineConfig } from 'cypress';
+
+import { parseEnvVariables } from './utilities';
+
+export type CyDefineConfig = Parameters<typeof defineConfig>[0];
+
+export type DotenvConfigOptions = CyDefineConfig & {
+  dotenv: DotenvRunOptions;
+};
+
+export const defineConfigWithDotenv = (
+  dotenvConfigOptions: DotenvConfigOptions,
+): CyDefineConfig => {
+  const { dotenv, ...config } = dotenvConfigOptions;
+  const oldSetupNodeEvents = config.setupNodeEvents;
+
+  config.setupNodeEvents = (onPluginEvent, pluginConfigOptions) => {
+    const nextPluginConfigOptions = parseEnvVariables(dotenv, pluginConfigOptions);
+
+    return oldSetupNodeEvents?.(onPluginEvent, nextPluginConfigOptions);
+  };
+
+  return defineConfig(config);
+};

lib/src/index.ts

@@ -0,0 +1,3 @@
+export * from './define-config';
+export * from './presets';
+export * from './utilities';

lib/src/presets/component-preset.ts

@@ -0,0 +1,26 @@
+import type { DotenvRunOptions } from '@dotenv-run/core';
+import { defineConfig } from 'cypress';
+
+import { parseEnvVariables } from '../utilities';
+
+export type CyDefineComponentConfig = Parameters<typeof defineConfig>[0]['component'];
+
+export type DotenvComponentPresetConfigOptions = CyDefineComponentConfig & {
+  dotenv?: DotenvRunOptions;
+};
+
+export const dotenvComponentPreset = (
+  dotenvComponentPresetConfigOptions: DotenvComponentPresetConfigOptions,
+): CyDefineComponentConfig => {
+  const { dotenv, ...config } = dotenvComponentPresetConfigOptions;
+
+  const oldSetupNodeEvents = config.setupNodeEvents;
+
+  config.setupNodeEvents = (onPluginEvent, pluginConfigOptions) => {
+    const nextPluginConfigOptions = parseEnvVariables(dotenv, pluginConfigOptions);
+
+    return oldSetupNodeEvents?.(onPluginEvent, nextPluginConfigOptions);
+  };
+
+  return config;
+};

lib/src/presets/e2e-preset.ts

@@ -0,0 +1,26 @@
+import type { DotenvRunOptions } from '@dotenv-run/core';
+import { defineConfig } from 'cypress';
+
+import { parseEnvVariables } from '../utilities';
+
+export type CyDefineE2EConfig = Parameters<typeof defineConfig>[0]['e2e'];
+
+export type DotenvE2EPresetConfigOptions = CyDefineE2EConfig & {
+  dotenv?: DotenvRunOptions;
+};
+
+export const dotenvE2EPreset = (
+  dotenvE2EPresetConfigOptions: DotenvE2EPresetConfigOptions,
+): CyDefineE2EConfig => {
+  const { dotenv, ...config } = dotenvE2EPresetConfigOptions;
+
+  const oldSetupNodeEvents = config.setupNodeEvents;
+
+  config.setupNodeEvents = (onPluginEvent, pluginConfigOptions) => {
+    const nextPluginConfigOptions = parseEnvVariables(dotenv, pluginConfigOptions);
+
+    return oldSetupNodeEvents?.(onPluginEvent, nextPluginConfigOptions);
+  };
+
+  return config;
+};

lib/src/presets/index.ts

@@ -0,0 +1,2 @@
+export * from './component-preset';
+export * from './e2e-preset';

lib/src/utilities/index.ts

@@ -0,0 +1 @@
+export * from './parse-env-variables';

lib/src/utilities/parse-env-variables.ts

@@ -0,0 +1,16 @@
+import { DotenvRunOptions, env } from '@dotenv-run/core';
+import { cloneDeep, entries } from 'lodash';
+
+export const parseEnvVariables = (
+  options: DotenvRunOptions | undefined,
+  config: Cypress.PluginConfigOptions,
+) => {
+  const dotenvRun = env(options);
+
+  const enhancedConfig = cloneDeep(config);
+  enhancedConfig.env = enhancedConfig.env ?? {};
+
+  entries(dotenvRun.raw).forEach(([key, value]) => (enhancedConfig.env[key] = value));
+
+  return enhancedConfig;
+};