NX - Currents Documentation

Running cypress tests in NX project with Currents
​Nx is a next generation build system with first class monorepo support and powerful integrations. You can run cypress tests on Currents using @currents/nx plugin and defining a few configuration options.
How to setup cypress tests in NX project
First, install @currens/nx npm package.
npm i --save-dev @currents/nx
Add currents target to your project configuration.
{
// ...
"targets": {
  "currents": {
    "executor": "@currents/nx:currents",
    "options": {
      "cypressExecutor": "e2e" // target name that runs "@nrwl/cypress:cypress"
    }
  },
 "e2e"
    "executor": "@nrwl/cypress:cypress",
    "options": {
      // record: true,
      // parallel: true,
      // key: "currents dashboard key"
      // ...
    },
    "configurations": {
      // ...
    }
  }
}
// ...
Run cypress tests using Currents dashboard service
nx run project:currents --record --key <key> --ci-build-id hello-currents-nx -- --parallel
Please note the use of -- --parallel flag due to conflicts with existing NX flags. See #8014, #1604​
The plugin requires an already installed @nrwl/cypress and a configured target that's running @nrwl/cypress:cypress
@currents/nx:currents will run @nrwl/cypress:cypress behind the scenes
You can set predefined options in target definition
Update your cypress.json file with projectId obtained from https://app.currents.dev​
Use the record key obtained from https://app.currents.dev​
You can also omit CLI flags and instead provide cypress options within @nrwl/cypress:cypress executor's options, for example:
// ...
"currents": {
  "executor": "@currents/nx:currents",
  "options": {
    "cypressExecutor": "e2e"
  }
},
"e2e": {
  "executor": "@nrwl/cypress:cypress",
  "options": {
    "cypressConfig": "apps/frontend-e2e/cypress.json",
    "devServerTarget": "frontend:serve",
    "record": true,
    "parallel": true,
    "key": "currents key"
  },
  "configurations": {
    "production": {
      "devServerTarget": "frontend:serve:production"
    }
  }
}
// ...
See our example repo at https://github.com/currents-dev/currents-nx-example for integration details.

CI Setup - Previous

Jenkins

Next - Runs

Run Status

Last modified 5mo ago

Copy link

On this page

Running cypress tests in NX project with Currents

How to setup cypress tests in NX project