@nrwl/cypress
Advanced tools
@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.
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-appRun 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:e2eConfigure 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' } };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 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 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.
🔎 Nx is a set of Angular CLI power-ups for modern development.
Using Nx, you can add Cypress, Jest, Prettier, and Nest into your dev workflow. Nx sets up these tools and allows you to use them seamlessly. Nx fully integrates with the other modern tools you already use and love.
With Nx, you can build full-stack applications using Angular and Node.js frameworks such as Nest and Express. You can share code between the frontend and the backend. And you can use the familiar ng build/test/serve commands to power whole dev experience.
With Nx, you can develop multiple full-stack applications holistically and share code between them all in the same workspace. Nx provides advanced tools which help you scale your enterprise development. Nx helps enforce your organization’s standards and community best practices.
Most importantly, you can use these power-ups a la carte. Just want to build a single Angular application using Cypress? Nx is still an excellent choice for that.
Nx is not a replacement for Angular CLI. An Nx workspace is an Angular CLI workspace.
ng build, ng serve commands.angular.json.Using npx
npx create-nx-workspace myworkspace
Using npm init
npm init nx-workspace myworkspace
Using yarn create
yarn create nx-workspace myworkspace
If you already have a regular Angular CLI project, you can add Nx power-ups by running:
ng add @nrwl/schematics
Unlike the CLI, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one run:
ng g application myapp
The result will look like this:
<workspace name>/
├── README.md
├── angular.json
├── apps/
│ ├── myapp/
│ │ ├── browserslist
│ │ ├── jest.conf.js
│ │ ├── src/
│ │ │ ├── app/
│ │ │ ├── assets/
│ │ │ ├── environments/
│ │ │ ├── favicon.ico
│ │ │ ├── index.html
│ │ │ ├── main.ts
│ │ │ ├── polyfills.ts
│ │ │ ├── styles.scss
│ │ │ └── test.ts
│ │ ├── tsconfig.app.json
│ │ ├── tsconfig.json
│ │ ├── tsconfig.spec.json
│ │ └── tslint.json
│ └── myapp-e2e/
│ ├── cypress.json
│ ├── src/
│ │ ├── fixtures/
│ │ │ └── example.json
│ │ ├── integration/
│ │ │ └── app.spec.ts
│ │ ├── plugins/
│ │ │ └── index.ts
│ │ └── support/
│ │ ├── app.po.ts
│ │ ├── commands.ts
│ │ └── index.ts
│ ├── tsconfig.e2e.json
│ ├── tsconfig.json
│ └── tslint.json
├── libs/
├── nx.json
├── package.json
├── tools/
├── tsconfig.json
└── tslint.json
All the files that the CLI would have in a new project are still here, just in a different folder structure which makes it easier to create more applications and libraries in the future.
Run ng serve myapp to serve the newly generated application!
You are good to go!
If you want to file a bug or submit a PR, read up on our guidelines for contributing.
| Victor Savkin | Jason Jean | Benjamin Cabanes |
|---|---|---|
 |  |  |
| vsavkin | FrozenPandaz | bcabanes |
FAQs
The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.
The npm package @nrwl/cypress receives a total of 666,392 weekly downloads. As such, @nrwl/cypress popularity was classified as popular.
We found that @nrwl/cypress demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.