feat(testing): support vite configOverrides for cypress

[TimvdEijnden]

We'd like to use shared cypress commands, but that's currently not working because vite cannot resolve the import.
By allowing to pass options to the vite config we have the possibility to add an alias or a plugin to fix this.

This adds support for an optional viteConfigOverrides object.

Current Behavior

cypress.config.ts:

import { nxE2EPreset } from '@nx/cypress/plugins/cypress-preset';
import { defineConfig } from 'cypress';

export default defineConfig({
  e2e: {
    ...nxE2EPreset(__filename, { cypressDir: 'cypress', bundler: 'vite' }),
  },
});

Expected Behavior

cypress.config.ts:

import { nxE2EPreset } from '@nx/cypress/plugins/cypress-preset';
import { defineConfig } from 'cypress';

const viteConfigOverrides = {
  resolve: {
    alias: {
      '@cypress-shared-commands': '../../../shared-cypress-commands',
    },
  },
};

export default defineConfig({
  e2e: {
    ...nxE2EPreset(__filename, { cypressDir: 'cypress', bundler: 'vite', viteConfigOverrides }),
  },
});

Related Issue(s)

Fixes #

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	Jul 22, 2024 3:52pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1bfecfe. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 5 targets

• nx affected --targets=e2e,e2e-ci --base=199ffd1d54e0710b492fe48d4e84bdef61b29125 --head=1bfecfe5b969d153ec59338ba20bbf9b43d9fddc --parallel=1
• nx affected --targets=lint,test,build --base=199ffd1d54e0710b492fe48d4e84bdef61b29125 --head=1bfecfe5b969d153ec59338ba20bbf9b43d9fddc --parallel=3
• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=199ffd1d54e0710b492fe48d4e84bdef61b29125 --head=1bfecfe5b969d153ec59338ba20bbf9b43d9fddc
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[TimvdEijnden]

@jaysoo @ndcunningham @Coly010 @isaacplmann Could someone from nx review this PR? Because we would like to make use of this feature 😃

[TimvdEijnden]

@AgentEnder @mandarini @FrozenPandaz @Cammisuli @jdpearce @xiongemi @MaxKless

It would be great if someone could please review this rather small change, we could really make use of it 😀

[jaysoo]

Usages of vitePreprocessor('/path/to/vite.config.ts') will break right? Do we need to overload the function or deprecate something?

[jaysoo]

Nevermind, it's an internal API. :)

[TimvdEijnden]

Thanks for merging 😊

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.