@nrwl/workspace
Advanced tools
The @nrwl/workspace npm package is part of Nx, which is a set of extensible dev tools for monorepos. It provides a consistent dev experience for different tools and frameworks, and it helps with tasks like running tasks, generating components, and managing dependencies within a monorepo.
Creating a new workspace
This command sets up a new workspace. It's the first step when starting a project with Nx.
npx create-nx-workspace@latest myworkspaceGenerating code
This command generates a new React component within a specified project in the workspace.
nx generate @nrwl/react:component my-component --project=myappRunning tasks
This command builds a specific application within the workspace.
nx run myapp:buildDependency Graph
This command visualizes the dependency graph of projects in the workspace, helping to understand the structure and dependencies of the monorepo.
nx dep-graphRunning affected commands
This command runs tests only for the projects affected by the latest changes, optimizing the CI process.
nx affected:testLerna is a tool for managing JavaScript projects with multiple packages. It optimizes the workflow around managing multi-package repositories with git and npm. Lerna is similar to @nrwl/workspace in that it helps manage monorepos but does not provide the same level of integration with various frameworks or the same CLI experience for code generation and task execution.
🔎 Extensible Dev Tools for Monorepos.
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 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 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 instead of rebuilding or retesting the code from scratch. This, in combination with Nx’s support for distributed and incremental builds, can help teams see up to 10x reduction in build and test times.
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]
web components [a workspace with a single app built using web components]
angular [a workspace with a single Angular application]
angular-nest [a workspace with a full stack application (Angular + Nest)]
react [a workspace with a single React application]
react-express [a workspace with a full stack application (React + Express)]
next.js [a workspace with a single Next.js application]
Select the preset that works best for you. You can always add plugins later.
? Workspace name (e.g., org name) happyorg
? What to create in the new workspace web components [a workspace with a single app built using web components]
? Application name myapp
? Default stylesheet format CSS
If it's your first Nx project, the command will recommend you to install @nrwl/cli globally, so you can invoke nx directly without going through yarn or npm.
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.Angular users can also run ng g/serve/test/e2e.
You are good to go!
|
Angular |
React |
|
|
|
If you want to file a bug or submit a PR, read up on our guidelines for contributing and watch this video that will help you get started.
| Victor Savkin | Jason Jean | Benjamin Cabanes | Brandon Roberts |
|---|---|---|---|
 |  |  |  |
| vsavkin | FrozenPandaz | bcabanes | brandonroberts |
| Jack Hsu | Jo Hanna Pearce | Matt Briggs |
|---|---|---|
 |  |  |
| jaysoo | jdpearce | mbriggs |
FAQs
The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.
The npm package @nrwl/workspace receives a total of 1,151,644 weekly downloads. As such, @nrwl/workspace popularity was classified as popular.
We found that @nrwl/workspace 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.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
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.
