@currents/nx

@currents/nx

NX plugin for running cypress tests using Currents or Sorry Cypress as an orchestration service.

The plugin is intended for usage in CI environments and runs Cypress in headless mode. Please use @nrwl/cypress for running cypress in interactive mode.

Setup

Install @currents/nx

npm i --save-dev @currents/nx

Add target currents to your project configuration:

{
  // ...
  "targets": {
    "currents": {
      "executor": "@currents/nx:currents",
      "options": {
        "record": true,
        "parallel": true,
        "cypressConfig": "apps/app-e2e/cypres.config.ts",
        "devServerTarget": "my-react-app:serve",
        "testingType": "e2e"
      }
    }
  }
  // ...

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

nx run project:currents --group nx --record --key <key> --ci-build-id hello-currents-nx

• Update your cypress.json file with projectId obtained at https://app.currents.dev
• Use the record key obtained at https://app.currents.dev

Configuration

See the schema.json for the list of available options

Example

See https://github.com/currents-dev/currents-nx-example for example integration.

Migration

Version 1.0.0

• @nrwl/cypress no longer required - the plugin is a standalone implementation that is not dependent on @nrwl/cypress. Use the available configuration options to configure the execution of cypress runs.

Changelog

1.0.0-beta.1 (2023-01-10)

Features

• standalone implementation (06d1ff1)

BREAKING CHANGES

• @nrwl/cypress no longer required, versions - the plugin is a standalone implementation that is not dependent on @nrwl/cypress

• use the available options to configure the execution of your cypress runs

• use cy2 3.4.1 for cypress 12 (a46f56f)

• feat: cypress 12+ (1a9ca2b)

• fix cy2 version (925f490)
• Merge pull request #8 from currents-dev/next (0ccb1da)

• feat: use cy2@3.2.0, support cypress 11 (f1950ab)

• Merge pull request #5 from codelab-app:main (bd4af5e)
• fix: forward configuration context to executor (b6b5e42)

• Merge pull request #2 from currents-dev/dependabot/npm_and_yarn/node-fetch-2.6.7 (88dda59)
• chore(deps): bump node-fetch from 2.6.6 to 2.6.7 (1c0a59c)
• Merge pull request #1 from currents-dev/dependabot/npm_and_yarn/minimist-1.2.6 (6aeb342)
• fix: remove conflicting options to avoid overrides (aa6ad79)
• chore(deps): bump minimist from 1.2.5 to 1.2.6 (726f96d)

• chore: update README (1d07be2)

• fix: set correct executors path (e6a706d)
• fix: remove cy2 from dependencies (a6eade1)