The nx npm package is a suite of powerful, extensible dev tools to help you architect, test, build, and develop your software projects. It is particularly well-suited for monorepo development, where multiple projects coexist in a single repository. Nx provides tools for project scaffolding, dependency graph analysis, affected change analysis, and more.
Project Scaffolding
This command sets up a new workspace. Nx supports many presets to scaffold applications using various frameworks like Angular, React, or Node.js.
npx create-nx-workspace@latest myworkspaceGenerating Components
Generates a new component within a specified project in the workspace. This helps maintain consistency and follows best practices.
nx generate component my-component --project=my-appRunning Tasks
Executes a specific task, such as building a project. Nx uses an executor to run tasks which can be configured for different environments.
nx run my-app:buildAffected Change Analysis
Determines which apps and libs are affected by changes to the current git branch, and performs the build task only for those.
nx affected:buildDependency Graph
Visualizes the dependency graph of the workspace, showing how projects depend on one another. This is useful for understanding the structure and ensuring that changes do not have unintended consequences.
nx dep-graphLerna is a tool for managing JavaScript projects with multiple packages, optimizing the workflow around managing multi-package repositories with git and npm. Compared to Nx, Lerna focuses more on the versioning and publishing of multi-package repositories, whereas Nx provides a broader range of tools for development and build optimization.
This is an alias of the @nrwl/cli package. Please see @nrwl/cli for more information.
š Smart, Extensible Build Framework
Nx is a smart and extensible build framework to help you architect, test, and build at any scale ā integrating seamlessly with modern technologies and frameworks while providing a distributed graph-based task execution, computation caching, smart rebuilds of affected projects, powerful code generators, editor support, GitHub apps, and more.
Nx provides distributed graph-based task execution and computation caching.
Nx is smart. It analyzes your workspace and figures out what can be affected by every code change. That's why Nx doesn't rebuild and retest everything on every commit--it only rebuilds what is necessary .
Nx partitions commands into a graph of smaller tasks. Nx then runs those tasks in parallel, and it can even distribute them across multiple machines without any configuration.
Nx also uses a distributed computation cache. If someone has already built or tested similar code, Nx will use their results to speed up the command for everyone else.
Nx helps scale your development from one team building one application to many teams building multiple frontend and backend applications all in the same workspace. When using Nx, developers have a holistic dev experience powered by an advanced CLI (with editor plugins), capabilities for controlled code sharing and consistent code generation.
Nx is an open platform with plugins for many modern tools and frameworks. It has support for TypeScript, React, Angular, Cypress, Jest, Prettier, Nest.js, Next.js, Storybook, Ionic among others. With Nx, you get a consistent dev experience regardless of the tools used.
Using npx
npx create-nx-workspace
Using npm init
npm init nx-workspace
Using yarn create
yarn create nx-workspace
The create-nx-workspace command will ask you to select a preset, which will configure some plugins and create your applications to help you get started.
? What to create in the new workspace (Use arrow keys)
āÆ empty [an empty workspace with a layout that works best for building apps]
npm [an empty workspace set up to publish npm packages (similar to and compatible with yarn workspaces)]
react [a workspace with a single React application]
angular [a workspace with a single Angular application]
next.js [a workspace with a single Next.js application]
gatsby [a workspace with a single Gatsby application]
nest [a workspace with a single Nest application]
express [a workspace with a single Express application]
web components [a workspace with a single app built using web components]
react-express [a workspace with a full stack application (React + Express)]
angular-nest [a workspace with a full stack application (Angular + Nest)]
Select the preset that works best for you.
nx serve myapp to serve the newly generated application!nx test myapp to test it.nx e2e myapp-e2e to run e2e tests for it.Even though Nx isn't technology specific, we provide 3 separate flavours of the documentation site to it make it easier for you to get up and running. For every link below, you will be able to select whether you want your examples to be written in React, Node or Angular.
| Scale React Development with Nx | Nx Workspaces | Advanced Nx Workspaces |
|
|
|
|
FAQs
The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.
The npm package nx receives a total of 2,929,658 weekly downloads. As such, nx popularity was classified as popular.
We found that nx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 8 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
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
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.
