@nx/cypress

What is @nx/cypress?

@nx/cypress is an npm package that integrates Cypress, a popular end-to-end testing framework, with the Nx build system. This package allows you to efficiently manage and run Cypress tests within an Nx workspace, providing tools and utilities to streamline the testing process.

What are @nx/cypress's main functionalities?

Generating Cypress Projects

This feature allows you to quickly scaffold a Cypress project within your Nx workspace, making it easy to start writing end-to-end tests for your applications.

json
{
  "command": "nx generate @nx/cypress:cypress-project my-app-e2e --project=my-app",
  "description": "This command generates a new Cypress project for an existing Nx application. The generated project will include all necessary configurations and setup to start writing and running Cypress tests."
}

Running Cypress Tests

This feature enables you to run your Cypress tests using Nx commands, integrating the testing process into your existing Nx workflow.

json
{
  "command": "nx run my-app-e2e:e2e",
  "description": "This command runs the Cypress end-to-end tests for the specified project. It uses the configurations set up during the project generation to execute the tests."
}

Customizing Cypress Configuration

This feature allows you to customize the Cypress configuration for your Nx projects. You can set various options such as the base URL, video recording preferences, and the location for screenshots.

json
{
  "cypressConfig": {
    "baseUrl": "http://localhost:4200",
    "video": false,
    "screenshotsFolder": "./cypress/screenshots"
  }
}

Other packages similar to @nx/cypress

cypress

Cypress is a standalone end-to-end testing framework that provides a rich set of features for writing and running tests. Unlike @nx/cypress, it does not integrate with the Nx build system but can be used independently or with other build tools.

jest

Jest is a JavaScript testing framework primarily used for unit and integration testing. While it does not provide end-to-end testing capabilities like Cypress, it is often used alongside Cypress for a comprehensive testing strategy.

testcafe

TestCafe is another end-to-end testing framework that allows you to write tests in JavaScript or TypeScript. It offers similar functionalities to Cypress but has a different approach to test execution and browser automation.

README

Nx: Smart Monorepos · Fast CI

Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.

This package is a Cypress plugin for Nx.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace

Using npm init

npm init nx-workspace

Using yarn create

yarn create nx-workspace

Adding Nx to an Existing Repository

Run:

npx nx@latest init

Documentation & Resources

• Nx.Dev: Documentation, Guides, Tutorials
• Intro to Nx
• Official Nx YouTube Channel
• Blog Posts About Nx