@nrwl/workspace

What is @nrwl/workspace?

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.

What are @nrwl/workspace's main functionalities?

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 myworkspace

Generating code

This command generates a new React component within a specified project in the workspace.

nx generate @nrwl/react:component my-component --project=myapp

Running tasks

This command builds a specific application within the workspace.

nx run myapp:build

Dependency Graph

This command visualizes the dependency graph of projects in the workspace, helping to understand the structure and dependencies of the monorepo.

nx dep-graph

Running affected commands

This command runs tests only for the projects affected by the latest changes, optimizing the CI process.

nx affected:test

Other packages similar to @nrwl/workspace

lerna

Lerna 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.

README

---

---

What is Nx?

🔎 Extensible Dev Tools for Monorepos.

Nx Helps You

Use Modern Tools

Using Nx, you can add TypeScript, 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 modern frameworks. You can share code between the frontend and the backend. And you can use the same build/test/serve commands throughout the whole dev experience.

Develop like Google, Facebook, and Microsoft

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 also helps enforce your organization’s standards and community best practices.

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

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.

Creating First Application

By default, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one, you need to add capabilities to the workspace.

To add a web components app, run:

yarn add @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

To add an Angular app, run:

yarn add @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

To add a React app, run:

yarn add @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

If nx g fails, use: yarn nx g @nrwl/web:app myapp or npm run nx -- g @nrwl/web:app myapp.

Regardless of what framework you chose, the resulting file tree will look like this:

<workspace name>/
├── apps/
│   ├── myapp/
│   └── myapp-e2e/
├── libs/
├── tools/
├── nx.json
├── package.json
├── tsconfig.json
└── tslint.json

Serving Application

• Run nx serve myapp to serve the newly generated application!
• Run nx test myapp to test it.
• Run 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!

Documentation

• Nx Documentation and Guides
• Nx blog posts

Books

• Enterprise Monorepo Patterns

Videos

• Nx Quickstart - How to Scale a JavaScript Project
• Video course on using Nx Workspaces

Talks

• Angular at Large Organizations
• Nx: The New Way to Build Enterprise Angular Apps
• Supercharging the Angular CLI
• Hands on Full Stack development with Nx and Bazel

Misc

• nx-examples repo has branches for different nx comments to display expected behavior and example app and libraries. Check out the branch (workspace, ngrx...) to see what gets created for you. More info on readme.
• xplat - Cross-platform tools for Nx workspaces

Want to help?

If you want to file a bug or submit a PR, read up on our guidelines for contributing.

Core Team

Victor Savkin	Jason Jean	Benjamin Cabanes	Brandon Roberts	Wes Grimes
vsavkin	FrozenPandaz	bcabanes	brandonroberts	wesleygrimes