What is @nrwl/jest?
The @nrwl/jest package is part of the Nx suite of tools, designed to enhance the development experience with Jest in a monorepo setup. It provides seamless integration of Jest into Nx workspaces, enabling efficient unit testing configurations, execution, and optimizations tailored for projects managed within an Nx workspace.
What are @nrwl/jest's main functionalities?
Simplified Jest Configuration
Allows for simplified and centralized Jest configuration within an Nx workspace, making it easier to manage and share configurations across multiple library and application projects.
{
"jestConfig": "./jest.config.js",
"tsConfig": "./tsconfig.spec.json",
"setupFile": "./src/test-setup.ts"
}
Parallel Test Execution
Enables parallel execution of tests across multiple projects within the workspace, significantly reducing the total time required for running tests in large projects.
nx run-many --target=test --all --parallel
Test Affected Projects
Identifies and runs tests only for the projects affected by recent changes, improving efficiency in continuous integration pipelines by skipping tests for unchanged projects.
nx affected:test
Other packages similar to @nrwl/jest
jest
Jest is the underlying testing framework that @nrwl/jest configures and enhances for use within Nx workspaces. While Jest can be used independently for testing JavaScript and TypeScript projects, @nrwl/jest provides additional integrations and optimizations for monorepo setups.
mocha
Mocha is another popular JavaScript test framework that can be used for unit and integration testing. Unlike @nrwl/jest, which is tailored for Jest and Nx workspaces, Mocha offers a more general-purpose testing solution without specific optimizations for monorepos or Nx.
karma
Karma is a test runner developed by the AngularJS team, designed to work with any framework. It differs from @nrwl/jest by focusing on executing tests in real browsers, providing a more integrated environment for testing browser-specific features. However, it lacks the monorepo-specific enhancements provided by @nrwl/jest.
What is Nx?
🔎 Nx is a set of Angular CLI power-ups for modern development.
Nx Helps You
Use Modern Tools
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.
Build Full-Stack Applications
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.
Develop Like Google
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.
A la carte
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.
Does it replace Angular CLI?
Nx is not a replacement for Angular CLI. An Nx workspace is an Angular CLI workspace.
- You run same
ng build
, ng serve
commands. - You configure your projects in
angular.json
. - Anything you can do in a standard Angular CLI project, you can also do in an Nx workspace.
Getting Started
Creating an Nx Workspace
Using npx
npx create-nx-workspace myworkspace
Using npm init
npm init nx-workspace myworkspace
Using yarn create
yarn create nx-workspace myworkspace
Adding Nx to an Existing Angular CLI workspace
If you already have a regular Angular CLI project, you can add Nx power-ups by running:
ng add @nrwl/schematics
Creating First Application
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.
Serving Application
Run ng serve myapp
to serve the newly generated application!
You are good to go!
Quick Start & Documentation
Documentation
Books
Videos
Talks
Podcasts and Shows
Misc
Want to help?
If you want to file a bug or submit a PR, read up on our guidelines for contributing.
Core Team