What is @nrwl/tao?
The @nrwl/tao package is part of the Nx monorepo toolset provided by Nrwl. It provides a set of utilities for workspace management, task orchestration, and abstracts away the configuration for building and testing applications. It is designed to help developers create and maintain monorepo setups more efficiently.
What are @nrwl/tao's main functionalities?
Workspace Management
This feature allows you to read the workspace configuration file, which is useful for understanding the structure and configuration of projects within the workspace.
const { readWorkspaceJson } = require('@nrwl/tao/src/core/file-utils');
const workspaceJson = readWorkspaceJson();
Task Orchestration
This feature enables you to programmatically execute tasks such as building or testing a project within the workspace. It is useful for automating workflows and integrating with other tools.
const { runCommand } = require('@nrwl/tao/src/commands/run-command');
runCommand('build', { project: 'my-app' }, { interactive: false });
Configuration Abstraction
This feature provides utility functions to work with the workspace's root path and other configuration details, simplifying the process of setting up and maintaining a monorepo.
const { getWorkspacePath } = require('@nrwl/tao/src/utils/app-root');
const workspacePath = getWorkspacePath();
Other packages similar to @nrwl/tao
lerna
Lerna is a tool for managing JavaScript projects with multiple packages, similar to @nrwl/tao. It optimizes the workflow around managing multi-package repositories with git and npm. Lerna can also automate the versioning and publishing of packages.
yarn-workspaces
Yarn Workspaces is a feature of Yarn that allows users to set up multiple package directories within a single repository. It is similar to @nrwl/tao in that it helps manage dependencies and linking between packages in a monorepo.
![](https://raw.githubusercontent.com/nrwl/nx/master/nx-logo.png)
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 --dev @nrwl/web
nx g @nrwl/web:app myapp
npm install --save-dev @nrwl/web
nx g @nrwl/web:app myapp
To add an Angular app, run:
yarn add --dev @nrwl/angular
nx g @nrwl/angular:app myapp
npm install --save-dev @nrwl/angular
nx g @nrwl/angular:app myapp
To add a React app, run:
yarn add --dev @nrwl/react
nx g @nrwl/react:app myapp
npm install --save-dev @nrwl/react
nx g @nrwl/react:app 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
Books
Videos
Talks
Misc
Want to help?
If you want to file a bug or submit a PR, read up on our guidelines for contributing.
Core Team