@nrwl/cypress

What is @nrwl/cypress?

@nrwl/cypress is a package that provides Cypress integration for Nx workspaces. It allows you to run end-to-end tests using Cypress, a popular testing framework for web applications. This package helps in setting up Cypress within an Nx workspace, generating Cypress projects, and running tests efficiently.

What are @nrwl/cypress's main functionalities?

Generate Cypress Project

This command generates a new Cypress end-to-end (E2E) testing project for an existing application within an Nx workspace. The generated project will be configured to run Cypress tests for the specified application.

nx generate @nrwl/cypress:project my-app-e2e --project=my-app

Run Cypress Tests

This command runs the Cypress E2E tests for the specified project. It will open the Cypress test runner and execute the tests defined in the project.

nx run my-app-e2e:e2e

Configure Cypress

This is an example of a Cypress configuration file. It sets up node event listeners and specifies the base URL for the application being tested. This configuration is essential for customizing the behavior of Cypress tests.

module.exports = { e2e: { setupNodeEvents(on, config) { // implement node event listeners here }, baseUrl: 'http://localhost:4200' } };

Other packages similar to @nrwl/cypress

cypress

Cypress is a JavaScript end-to-end testing framework that is widely used for testing web applications. It provides a rich set of features for writing and running tests, including time travel, real-time reloads, and automatic waiting. Unlike @nrwl/cypress, which is tailored for Nx workspaces, Cypress can be used in any JavaScript project.

jest

Jest is a JavaScript testing framework developed by Facebook, primarily used for unit testing. While it is not specifically designed for end-to-end testing like Cypress, it can be extended with additional libraries to perform integration and E2E tests. Jest is known for its simplicity and ease of use, making it a popular choice for testing JavaScript applications.

testcafe

TestCafe is an end-to-end testing framework for web applications. It allows you to write tests in JavaScript or TypeScript and run them across different browsers. TestCafe is similar to Cypress in terms of functionality but does not require browser plugins or WebDriver, making it easier to set up and use.

README

---

Nx: Smart, Fast and Extensible Build System

Nx is a next generation build system with first class monorepo support and powerful integrations.

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