828 lines
30 KiB
Markdown
828 lines
30 KiB
Markdown
---
|
|
title: 'React Monorepo Tutorial'
|
|
description: In this tutorial you'll create a frontend-focused workspace with Nx.
|
|
---
|
|
|
|
# Building React Apps in an Nx Monorepo
|
|
|
|
In this tutorial you'll learn how to use React with Nx in a [monorepo (integrated) setup](/concepts/integrated-vs-package-based#integrated-repos).
|
|
|
|
What are you going to learn?
|
|
|
|
- how to create a new React application
|
|
- how to run a single task (i.e. serve your app) or run multiple tasks in parallel
|
|
- how to leverage code generators to scaffold components
|
|
- how to modularize your codebase and impose architectural constraints for better maintainability
|
|
|
|
{% callout type="info" title="Looking for a React standalone app?" %}
|
|
Note, this tutorial sets up a repo with applications and libraries in their own subfolders. If you are looking for a React standalone app setup then check out our [React standalone app tutorial](/getting-started/tutorials/react-standalone-tutorial).
|
|
{% /callout %}
|
|
|
|
Note, while you could easily use Nx together with your manually set up React application, we're going to use the `@nx/react` plugin for this tutorial which provides some nice enhancements when working with React. Visit our ["Why Nx" page](/getting-started/why-nx) to learn more about plugins and what role they play in the Nx architecture.
|
|
|
|
## Warm Up
|
|
|
|
Here's the source code of the final result for this tutorial.
|
|
|
|
{% github-repository url="https://github.com/nrwl/nx-recipes/tree/main/react-standalone" /%}
|
|
|
|
<!-- {% stackblitz-button url="github.com/nrwl/nx-recipes/tree/main/react-standalone?file=README.md" /%} -->
|
|
|
|
<!-- {% youtube
|
|
src="https://www.youtube.com/embed/OQ-Zc5tcxJE"
|
|
title="Tutorial: Standalone React Application"
|
|
/%} -->
|
|
|
|
## Creating a new React Monorepo
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=64" /%} -->
|
|
|
|
Create a new React monorepo with the following command:
|
|
|
|
```{% command="npx create-nx-workspace@latest react-monorepo --preset=react-monorepo" path="~" %}
|
|
> NX Let's create a new workspace [https://nx.dev/getting-started/intro]
|
|
|
|
✔ Application name · myreactapp
|
|
✔ Which bundler would you like to use? · vite
|
|
✔ Test runner to use for end to end (E2E) tests · cypress
|
|
✔ Default stylesheet format · css
|
|
✔ Enable distributed caching to make your CI faster · Yes
|
|
```
|
|
|
|
Let's name the initial application `myreactapp`. In this tutorial we're going to use `vite` as a bundler, `cypress` for e2e tests and `css` for styling. The above command generates the following structure:
|
|
|
|
```
|
|
└─ react-monorepo
|
|
├─ ...
|
|
├─ apps
|
|
│ ├─ myreactapp
|
|
│ │ ├─ public
|
|
│ │ │ └─ ...
|
|
│ │ ├─ src
|
|
│ │ │ ├─ app
|
|
│ │ │ │ ├─ app.module.css
|
|
│ │ │ │ ├─ app.spec.tsx
|
|
│ │ │ │ ├─ app.tsx
|
|
│ │ │ │ └─ nx-welcome.tsx
|
|
│ │ │ ├─ assets
|
|
│ │ │ ├─ main.tsx
|
|
│ │ │ └─ styles.css
|
|
│ │ ├─ index.html
|
|
│ │ ├─ project.json
|
|
│ │ ├─ tsconfig.app.json
|
|
│ │ ├─ tsconfig.json
|
|
│ │ ├─ tsconfig.spec.json
|
|
│ │ └─ vite.config.ts
|
|
│ └─ myreactapp-e2e
|
|
│ └─ ...
|
|
├─ nx.json
|
|
├─ tsconfig.base.json
|
|
└─ package.json
|
|
```
|
|
|
|
The setup includes..
|
|
|
|
- a new React application (`apps/myreactapp/`)
|
|
- a Cypress based set of e2e tests (`apps/myreactapp-e2e/`)
|
|
- Prettier preconfigured
|
|
- ESLint preconfigured
|
|
- Jest preconfigured
|
|
|
|
## Why Use an Integrated Monorepo?
|
|
|
|
An integrated monorepo is a repository configured with a set of features that work together toward the goal of allowing developers to focus on building features rather than the configuration, coordination and maintenance of the tooling in the repo.
|
|
|
|
You'll notice that instead of use npm/yarn/pnpm workspaces, projects within the repository are linked using typescript path aliases that are defined in the `tsconfig.base.json` file. Also, since we're creating projects using Nx plugin generators, all new projects come preconfigured with useful tools like Prettier, ESLint and Jest.
|
|
|
|
Nx Plugins are optional packages that extend the capabilities of Nx, catering to various specific technologies. For instance, we have plugins tailored to React (e.g., `@nx/react`), Vite (`@nx/vite`), Cypress (`@nx/cypress`), and more. These plugins offer additional features, making your development experience more efficient and enjoyable when working with specific tech stacks.
|
|
|
|
Features of an integrated monorepo:
|
|
|
|
- [Install dependencies at the root by default](/concepts/more-concepts/dependency-management#single-version-policy)
|
|
- [Scaffold new code with generators](/core-features/plugin-features/use-code-generators)
|
|
- [Run tasks with executors](/core-features/plugin-features/use-task-executors)
|
|
- [Updates dependencies with automated migrations](/core-features/automate-updating-dependencies)
|
|
|
|
Visit our ["Why Nx" page](/getting-started/why-nx) for more details.
|
|
|
|
## Serving the App
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=207" /%} -->
|
|
|
|
To serve your new React application, just run:
|
|
|
|
```shell
|
|
nx serve myreactapp
|
|
```
|
|
|
|
Your application should be served at [http://localhost:4200](http://localhost:4200).
|
|
|
|
Nx uses the following syntax to run tasks:
|
|
|
|
|
|
|
|
All targets, such as `serve`, `build`, `test` or your custom ones, are defined in the `project.json` file.
|
|
|
|
```json {% fileName="apps/myreactapp/project.json"}
|
|
{
|
|
"name": "myreactapp",
|
|
...
|
|
"targets": {
|
|
"serve": { ... },
|
|
"build": { ... },
|
|
"preview": { ... },
|
|
"test": { ... },
|
|
"lint": { ... },
|
|
"serve-static": { ... },
|
|
},
|
|
}
|
|
```
|
|
|
|
Each target contains a configuration object that tells Nx how to run that target.
|
|
|
|
```json {% fileName="project.json"}
|
|
{
|
|
"name": "myreactapp",
|
|
...
|
|
"targets": {
|
|
"serve": {
|
|
"executor": "@nx/vite:dev-server",
|
|
"defaultConfiguration": "development",
|
|
"options": {
|
|
"buildTarget": "myreactapp:build"
|
|
},
|
|
"configurations": {
|
|
"development": {
|
|
"buildTarget": "myreactapp:build:development",
|
|
"hmr": true
|
|
},
|
|
"production": {
|
|
"buildTarget": "myreactapp:build:production",
|
|
"hmr": false
|
|
}
|
|
}
|
|
},
|
|
...
|
|
},
|
|
}
|
|
```
|
|
|
|
The most critical parts are:
|
|
|
|
- `executor` - this is of the syntax `<plugin>:<executor-name>`, where the `plugin` is an NPM package containing an [Nx Plugin](/extending-nx/intro/getting-started) and `<executor-name>` points to a function that runs the task. In this case, the `@nx/vite` plugin contains the `dev-server` executor which serves the React app using Vite.
|
|
- `options` - these are additional properties and flags passed to the executor function to customize it
|
|
|
|
Learn more about how to [run tasks with Nx](/core-features/run-tasks).
|
|
|
|
## Testing and Linting - Running Multiple Tasks
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=410" /%} -->
|
|
|
|
Our current setup doesn't just come with targets for serving and building the React application, but also has targets for unit testing, e2e testing and linting. Again, these are defined in the `project.json` file. We can use the same syntax as before to run these tasks:
|
|
|
|
```bash
|
|
nx test # runs tests using Vitest (or you can configure it to use Jest)
|
|
nx lint # runs linting with ESLint
|
|
nx e2e e2e # runs e2e tests with Cypress
|
|
```
|
|
|
|
More conveniently, we can also run them in parallel using the following syntax:
|
|
|
|
```{% command="nx run-many -t test lint e2e" path="myreactapp" %}
|
|
|
|
✔ nx run e2e:lint (2s)
|
|
✔ nx run myreactapp:lint (2s)
|
|
✔ nx run myreactapp:test (2s)
|
|
✔ nx run e2e:e2e (6s)
|
|
|
|
——————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran targets test, lint, e2e for 2 projects (7s)
|
|
```
|
|
|
|
### Caching
|
|
|
|
One thing to highlight is that Nx is able to [cache the tasks you run](/core-features/cache-task-results).
|
|
|
|
Note that all of these targets are automatically cached by Nx. If you re-run a single one or all of them again, you'll see that the task completes immediately. In addition, (as can be seen in the output example below) there will be a note that a matching cache result was found and therefore the task was not run again.
|
|
|
|
```{% command="nx run-many -t test lint e2e" path="myreactapp" %}
|
|
|
|
✔ nx run e2e:lint [existing outputs match the cache, left as is]
|
|
✔ nx run myreactapp:lint [existing outputs match the cache, left as is]
|
|
✔ nx run myreactapp:test [existing outputs match the cache, left as is]
|
|
✔ nx run e2e:e2e [existing outputs match the cache, left as is]
|
|
|
|
——————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran targets test, lint, e2e for 5 projects (54ms)
|
|
|
|
Nx read the output from the cache instead of running the command for 10 out of 10 tasks.
|
|
```
|
|
|
|
Not all tasks might be cacheable though. You can configure `cacheableOperations` in the `nx.json` file. You can also [learn more about how caching works](/core-features/cache-task-results).
|
|
|
|
## Adding Another Application
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=706" /%} -->
|
|
|
|
Nx plugins usually provide [generators](/core-features/plugin-features/use-code-generators) that allow you to easily scaffold code, configuration or entire projects. To see what capabilities the `@nx/react` plugin provides, run the following command and inspect the output:
|
|
|
|
```{% command="npx nx list @nx/react" path="myreactapp" %}
|
|
|
|
> NX Capabilities in @nx/react:
|
|
|
|
GENERATORS
|
|
|
|
init : Initialize the `@nrwl/react` plugin.
|
|
application : Create a React application.
|
|
library : Create a React library.
|
|
component : Create a React component.
|
|
redux : Create a Redux slice for a project.
|
|
storybook-configuration : Set up storybook for a React app or library.
|
|
component-story : Generate storybook story for a React component
|
|
stories : Create stories/specs for all components declared in an app or library.
|
|
component-cypress-spec : Create a Cypress spec for a UI component that has a story.
|
|
hook : Create a hook.
|
|
host : Generate a host react application
|
|
remote : Generate a remote react application
|
|
cypress-component-configuration : Setup Cypress component testing for a React project
|
|
component-test : Generate a Cypress component test for a React component
|
|
setup-tailwind : Set up Tailwind configuration for a project.
|
|
setup-ssr : Set up SSR configuration for a project.
|
|
|
|
EXECUTORS/BUILDERS
|
|
|
|
module-federation-dev-server : Serve a host or remote application.
|
|
module-federation-ssr-dev-server : Serve a host application along with it's known remotes.
|
|
```
|
|
|
|
{% callout type="info" title="Prefer a more visual UI?" %}
|
|
|
|
If you prefer a more integrated experience, you can install the "Nx Console" extension for your code editor. It has support for VSCode, IntelliJ and ships a LSP for Vim. Nx Console provides autocompletion support in Nx configuration files and has UIs for browsing and running generators.
|
|
|
|
More info can be found in [the integrate with editors article](/core-features/integrate-with-editors).
|
|
|
|
{% /callout %}
|
|
|
|
Run the following command to generate a new `second-app` application. Note how we append `--dry-run` to first check the output.
|
|
|
|
```{% command="npx nx g @nx/react:app second-app --dry-run" path="react-monorepo" %}
|
|
> NX Generating @nx/react:application
|
|
|
|
✔ Would you like to add React Router to this application? (y/N) · false
|
|
✔ Which E2E test runner would you like to use? · cypress
|
|
A custom environment was provided: undefined. You need to install it manually.
|
|
CREATE apps/second-app/index.html
|
|
CREATE apps/second-app/public/favicon.ico
|
|
CREATE apps/second-app/src/app/app.spec.tsx
|
|
CREATE apps/second-app/src/assets/.gitkeep
|
|
CREATE apps/second-app/src/main.tsx
|
|
CREATE apps/second-app/tsconfig.app.json
|
|
CREATE apps/second-app/src/app/nx-welcome.tsx
|
|
CREATE apps/second-app/src/app/app.module.css
|
|
CREATE apps/second-app/src/app/app.tsx
|
|
CREATE apps/second-app/src/styles.css
|
|
CREATE apps/second-app/tsconfig.json
|
|
CREATE apps/second-app/project.json
|
|
CREATE apps/second-app/vite.config.ts
|
|
CREATE apps/second-app/tsconfig.spec.json
|
|
CREATE apps/second-app/.eslintrc.json
|
|
CREATE apps/second-app-e2e/cypress.config.ts
|
|
CREATE apps/second-app-e2e/src/e2e/app.cy.ts
|
|
CREATE apps/second-app-e2e/src/fixtures/example.json
|
|
CREATE apps/second-app-e2e/src/support/app.po.ts
|
|
CREATE apps/second-app-e2e/src/support/commands.ts
|
|
CREATE apps/second-app-e2e/src/support/e2e.ts
|
|
CREATE apps/second-app-e2e/tsconfig.json
|
|
CREATE apps/second-app-e2e/project.json
|
|
CREATE apps/second-app-e2e/.eslintrc.json
|
|
|
|
NOTE: The "dryRun" flag means no changes were made.
|
|
```
|
|
|
|
As you can see, it generates a new application in the `apps/second-app/` folder. If you want to actually run the generator, remove the `--dry-run` flag.
|
|
|
|
## You're ready to go!
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=906" /%} -->
|
|
|
|
In the previous sections you learned about the basics of using Nx, running tasks and navigating an Nx workspace. You're ready to ship features now!
|
|
|
|
But there's more to learn. You have two possibilities here:
|
|
|
|
- [Jump to the next steps section](#next-steps) to find where to go from here or
|
|
- keep reading and learn some more about what makes Nx unique when working with React.
|
|
|
|
## Sharing Code with Local Libraries
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=986" /%} -->
|
|
|
|
When you develop your React application, usually all your logic sits in the `app` folder. Ideally separated by various folder names which represent your "domains". As your app grows, however, the app becomes more and more monolithic and the code is unable to be shared with other applications.
|
|
|
|
```
|
|
└─ react-monorepo
|
|
├─ ...
|
|
├─ apps
|
|
│ └─ myreactapp
|
|
│ ├─ ...
|
|
│ ├─ src
|
|
│ │ ├─ app
|
|
│ │ │ ├─ products
|
|
│ │ │ ├─ cart
|
|
│ │ │ ├─ ui
|
|
│ │ │ ├─ ...
|
|
│ │ │ └─ app.tsx
|
|
│ │ ├─ ...
|
|
│ │ └─ main.tsx
|
|
│ ├─ ...
|
|
│ └─ project.json
|
|
├─ nx.json
|
|
├─ ...
|
|
```
|
|
|
|
Nx allows you to separate this logic into "local libraries". The main benefits include
|
|
|
|
- better separation of concerns
|
|
- better reusability
|
|
- more explicit "APIs" between your "domain areas"
|
|
- better scalability in CI by enabling independent test/lint/build commands for each library
|
|
- better scalability in your teams by allowing different teams to work on separate libraries
|
|
|
|
### Creating Local Libraries
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=1041" /%} -->
|
|
|
|
Let's assume our domain areas include `products`, `orders` and some more generic design system components, called `ui`. We can generate a new library for each of these areas using the React library generator:
|
|
|
|
```
|
|
nx g @nx/react:library products --unitTestRunner=vitest --bundler=none
|
|
nx g @nx/react:library orders --unitTestRunner=vitest --bundler=none
|
|
nx g @nx/react:library shared/ui --unitTestRunner=vitest --bundler=none
|
|
```
|
|
|
|
Note how we type out the path relative to the `libs` folder to place the libraries into a subfolder. You can choose whatever folder structure you like to organize your projects. If you change your mind later, you can run the [move generator](/packages/workspace/generators/move) to move a project to a different folder.
|
|
|
|
Running the above commands should lead to the following directory structure:
|
|
|
|
```
|
|
└─ react-monorepo
|
|
├─ ...
|
|
├─ apps
|
|
├─ libs
|
|
│ ├─ products
|
|
│ │ ├─ ...
|
|
│ │ ├─ project.json
|
|
│ │ ├─ src
|
|
│ │ │ ├─ index.ts
|
|
│ │ │ └─ lib
|
|
│ │ │ ├─ products.spec.ts
|
|
│ │ │ └─ products.ts
|
|
│ │ ├─ tsconfig.json
|
|
│ │ ├─ tsconfig.lib.json
|
|
│ │ ├─ tsconfig.spec.json
|
|
│ │ └─ vite.config.ts
|
|
│ ├─ orders
|
|
│ │ ├─ ...
|
|
│ │ ├─ project.json
|
|
│ │ ├─ src
|
|
│ │ │ ├─ index.ts
|
|
│ │ │ └─ ...
|
|
│ │ └─ ...
|
|
│ └─ shared
|
|
│ └─ ui
|
|
│ ├─ ...
|
|
│ ├─ project.json
|
|
│ ├─ src
|
|
│ │ ├─ index.ts
|
|
│ │ └─ ...
|
|
│ └─ ...
|
|
├─ ...
|
|
```
|
|
|
|
Each of these libraries
|
|
|
|
- has its own `project.json` file with corresponding targets you can run (e.g. running tests for just orders: `nx test orders`)
|
|
- has a name based on the path to the library, e.g. `shared-ui`; you can find the name in the corresponding `project.json` file
|
|
- has a dedicated `index.ts` file which is the "public API" of the library
|
|
- is mapped in the `tsconfig.base.json` at the root of the workspace
|
|
|
|
### Importing Libraries into the React Application
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=1245" /%} -->
|
|
|
|
All libraries that we generate automatically have aliases created in the root-level `tsconfig.base.json`.
|
|
|
|
```json {% fileName="tsconfig.base.json" %}
|
|
{
|
|
"compilerOptions": {
|
|
...
|
|
"paths": {
|
|
"@react-monorepo/products": ["libs/products/src/index.ts"],
|
|
"@react-monorepo/orders": ["libs/orders/src/index.ts"],
|
|
"@react-monorepo/shared/ui": ["libs/shared/ui/src/index.ts"]
|
|
},
|
|
...
|
|
},
|
|
}
|
|
```
|
|
|
|
Hence we can easily import them into other libraries and our React application. As an example, let's create and expose a `ProductList` component from our `libs/products` library. Either create it by hand or run
|
|
|
|
```shell
|
|
nx g @nx/react:component product-list --project=products
|
|
```
|
|
|
|
We don't need to implement anything fancy as we just want to learn how to import it into our main React application.
|
|
|
|
```tsx {% fileName="libs/products/src/lib/product-list/product-list.tsx" %}
|
|
import styles from './product-list.module.css';
|
|
|
|
/* eslint-disable-next-line */
|
|
export interface ProductListProps {}
|
|
|
|
export function ProductList(props: ProductListProps) {
|
|
return (
|
|
<div className={styles['container']}>
|
|
<h1>Welcome to ProductList!</h1>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default ProductList;
|
|
```
|
|
|
|
Make sure the `ProductList` is exported via the `index.ts` file of our `products` library. This is our public API with the rest of the workspace. Only export what's really necessary to be usable outside the library itself.
|
|
|
|
```ts {% fileName="libs/products/src/index.ts" %}
|
|
export * from './lib/product-list/product-list';
|
|
```
|
|
|
|
We're ready to import it into our main application now. First (if you haven't already), let's set up React Router.
|
|
|
|
```shell
|
|
npm install react-router-dom
|
|
```
|
|
|
|
Configure it in the `main.tsx`.
|
|
|
|
```tsx {% fileName="src/main.tsx" %}
|
|
import { StrictMode } from 'react';
|
|
import { BrowserRouter } from 'react-router-dom';
|
|
import ReactDOM from 'react-dom/client';
|
|
|
|
import App from './app/app';
|
|
|
|
const root = ReactDOM.createRoot(
|
|
document.getElementById('root') as HTMLElement
|
|
);
|
|
|
|
root.render(
|
|
<StrictMode>
|
|
<BrowserRouter>
|
|
<App />
|
|
</BrowserRouter>
|
|
</StrictMode>
|
|
);
|
|
```
|
|
|
|
Then we can import the `ProductList` component into our `app.tsx` and render it via the routing mechanism whenever a user hits the `/products` route.
|
|
|
|
```tsx {% fileName="src/app/app.tsx" %}
|
|
import { Route, Routes } from 'react-router-dom';
|
|
|
|
// importing the component from the library
|
|
import { ProductList } from '@react-monorepo/products';
|
|
|
|
function Home() {
|
|
return <h1>Home</h1>;
|
|
}
|
|
|
|
export function App() {
|
|
return (
|
|
<Routes>
|
|
<Route path="/" element={<Home />}></Route>
|
|
<Route path="/products" element={<ProductList />}></Route>
|
|
</Routes>
|
|
);
|
|
}
|
|
|
|
export default App;
|
|
```
|
|
|
|
Serving your app (`nx serve myreactapp`) and then navigating to `/products` should give you the following result:
|
|
|
|
|
|
|
|
Let's apply the same for our `orders` library.
|
|
|
|
- generate a new component `OrderList` in `libs/orders` and export it in the corresponding `index.ts` file
|
|
- import it into the `app.tsx` and render it via the routing mechanism whenever a user hits the `/orders` route
|
|
|
|
In the end, your `app.tsx` should look similar to this:
|
|
|
|
```tsx {% fileName="src/app/app.tsx" %}
|
|
import { Route, Routes } from 'react-router-dom';
|
|
import { ProductList } from '@react-monorepo/products';
|
|
import { OrderList } from '@react-monorepo/orders';
|
|
|
|
function Home() {
|
|
return <h1>Home</h1>;
|
|
}
|
|
|
|
export function App() {
|
|
return (
|
|
<Routes>
|
|
<Route path="/" element={<Home />}></Route>
|
|
<Route path="/products" element={<ProductList />}></Route>
|
|
<Route path="/orders" element={<OrderList />}></Route>
|
|
</Routes>
|
|
);
|
|
}
|
|
|
|
export default App;
|
|
```
|
|
|
|
## Building the App for Deployment
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=856" /%} -->
|
|
|
|
If you're ready and want to ship your application, you can build it using
|
|
|
|
```{% command="npx nx build myreactapp" path="react-monorepo" %}
|
|
vite v4.3.5 building for production...
|
|
✓ 33 libs transformed.
|
|
dist/myreactapp/index.html 0.48 kB │ gzip: 0.30 kB
|
|
dist/myreactapp/assets/index-e3b0c442.css 0.00 kB │ gzip: 0.02 kB
|
|
dist/myreactapp/assets/index-378e8124.js 165.64 kB │ gzip: 51.63 kB
|
|
✓ built in 496ms
|
|
|
|
——————————————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran target build for project reactutorial (1s)
|
|
```
|
|
|
|
All the required files will be placed in the `dist/myreactapp` folder and can be deployed to your favorite hosting provider.
|
|
|
|
## Visualizing your Project Structure
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=1416" /%} -->
|
|
|
|
Nx automatically detects the dependencies between the various parts of your workspace and builds a [project graph](/core-features/explore-graph). This graph is used by Nx to perform various optimizations such as determining the correct order of execution when running tasks like `nx build`, identifying [affected projects](/core-features/run-tasks#run-tasks-affected-by-a-pr) and more. Interestingly you can also visualize it.
|
|
|
|
Just run:
|
|
|
|
```shell
|
|
nx graph
|
|
```
|
|
|
|
You should be able to see something similar to the following in your browser.
|
|
|
|
{% graph height="450px" %}
|
|
|
|
```json
|
|
{
|
|
"projects": [
|
|
{
|
|
"name": "myreactapp",
|
|
"type": "app",
|
|
"data": {
|
|
"tags": []
|
|
}
|
|
},
|
|
{
|
|
"name": "myreactapp-e2e",
|
|
"type": "e2e",
|
|
"data": {
|
|
"tags": []
|
|
}
|
|
},
|
|
{
|
|
"name": "shared-ui",
|
|
"type": "lib",
|
|
"data": {
|
|
"tags": []
|
|
}
|
|
},
|
|
{
|
|
"name": "orders",
|
|
"type": "lib",
|
|
"data": {
|
|
"tags": []
|
|
}
|
|
},
|
|
|
|
{
|
|
"name": "products",
|
|
"type": "lib",
|
|
"data": {
|
|
"tags": []
|
|
}
|
|
}
|
|
],
|
|
"dependencies": {
|
|
"myreactapp": [
|
|
{ "source": "myreactapp", "target": "orders", "type": "static" },
|
|
{ "source": "myreactapp", "target": "products", "type": "static" }
|
|
],
|
|
"myreactapp-e2e": [
|
|
{ "source": "myreactapp-e2e", "target": "myreactapp", "type": "implicit" }
|
|
],
|
|
"shared-ui": [],
|
|
"orders": [],
|
|
"products": []
|
|
},
|
|
"workspaceLayout": { "appsDir": "", "libsDir": "" },
|
|
"affectedProjectIds": [],
|
|
"focus": null,
|
|
"groupByFolder": false
|
|
}
|
|
```
|
|
|
|
{% /graph %}
|
|
|
|
Notice how `shared-ui` is not yet connected to anything because we didn't import it in any of our projects.
|
|
|
|
Exercise for you: change the codebase such that `shared-ui` is used by `orders` and `products`. Note: you need to restart the `nx graph` command to update the graph visualization or run the CLI command with the `--watch` flag.
|
|
|
|
## Imposing Constraints with Module Boundary Rules
|
|
|
|
<!-- {% video-link link="https://youtu.be/OQ-Zc5tcxJE?t=1456" /%} -->
|
|
|
|
Once you modularize your codebase you want to make sure that the libs are not coupled to each other in an uncontrolled way. Here are some examples of how we might want to guard our small demo workspace:
|
|
|
|
- we might want to allow `orders` to import from `shared-ui` but not the other way around
|
|
- we might want to allow `orders` to import from `products` but not the other way around
|
|
- we might want to allow all libraries to import the `shared-ui` components, but not the other way around
|
|
|
|
When building these kinds of constraints you usually have two dimensions:
|
|
|
|
- **type of project:** what is the type of your library. Example: "feature" library, "utility" library, "data-access" library, "ui" library
|
|
- **scope (domain) of the project:** what domain area is covered by the project. Example: "orders", "products", "shared" ... this really depends on the type of product you're developing
|
|
|
|
Nx comes with a generic mechanism that allows you to assign "tags" to projects. "tags" are arbitrary strings you can assign to a project that can be used later when defining boundaries between projects. For example, go to the `project.json` of your `orders` library and assign the tags `type:feature` and `scope:orders` to it.
|
|
|
|
```json {% fileName="libs/orders/project.json" %}
|
|
{
|
|
...
|
|
"tags": ["type:feature", "scope:orders"]
|
|
}
|
|
```
|
|
|
|
Then go to the `project.json` of your `products` library and assign the tags `type:feature` and `scope:products` to it.
|
|
|
|
```json {% fileName="libs/products/project.json" %}
|
|
{
|
|
...
|
|
"tags": ["type:feature", "scope:products"]
|
|
}
|
|
```
|
|
|
|
Finally, go to the `project.json` of the `shared-ui` library and assign the tags `type:ui` and `scope:shared` to it.
|
|
|
|
```json {% fileName="libs/shared/ui/project.json" %}
|
|
{
|
|
...
|
|
"tags": ["type:ui", "scope:shared"]
|
|
}
|
|
```
|
|
|
|
Notice how we assign `scope:shared` to our UI library because it is intended to be used throughout the workspace.
|
|
|
|
Next, let's come up with a set of rules based on these tags:
|
|
|
|
- `type:feature` should be able to import from `type:feature` and `type:ui`
|
|
- `type:ui` should only be able to import from `type:ui`
|
|
- `scope:orders` should be able to import from `scope:orders`, `scope:shared` and `scope:products`
|
|
- `scope:products` should be able to import from `scope:products` and `scope:shared`
|
|
|
|
To enforce the rules, Nx ships with a custom ESLint rule. Open the `.eslintrc.base.json` at the root of the workspace and add the following `depConstraints` in the `@nx/enforce-module-boundaries` rule configuration:
|
|
|
|
```json {% fileName=".eslintrc.base.json" %}
|
|
{
|
|
...
|
|
"overrides": [
|
|
{
|
|
...
|
|
"rules": {
|
|
"@nx/enforce-module-boundaries": [
|
|
"error",
|
|
{
|
|
"enforceBuildableLibDependency": true,
|
|
"allow": [],
|
|
"depConstraints": [
|
|
{
|
|
"sourceTag": "*",
|
|
"onlyDependOnLibsWithTags": ["*"]
|
|
},
|
|
{
|
|
"sourceTag": "type:feature",
|
|
"onlyDependOnLibsWithTags": ["type:feature", "type:ui"]
|
|
},
|
|
{
|
|
"sourceTag": "type:ui",
|
|
"onlyDependOnLibsWithTags": ["type:ui"]
|
|
},
|
|
{
|
|
"sourceTag": "scope:orders",
|
|
"onlyDependOnLibsWithTags": [
|
|
"scope:orders",
|
|
"scope:products",
|
|
"scope:shared"
|
|
]
|
|
},
|
|
{
|
|
"sourceTag": "scope:products",
|
|
"onlyDependOnLibsWithTags": ["scope:products", "scope:shared"]
|
|
},
|
|
{
|
|
"sourceTag": "scope:shared",
|
|
"onlyDependOnLibsWithTags": ["scope:shared"]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
...
|
|
]
|
|
}
|
|
```
|
|
|
|
To test it, go to your `libs/products/src/lib/product-list/product-list.tsx` file and import the `OrderList` from the `orders` project:
|
|
|
|
```tsx {% fileName="libs/products/src/lib/product-list/product-list.tsx" %}
|
|
import styles from './product-list.module.css';
|
|
|
|
// This import is not allowed 👇
|
|
import { OrderList } from '@react-monorepo/orders';
|
|
|
|
/* eslint-disable-next-line */
|
|
export interface ProductListProps {}
|
|
|
|
export function ProductList(props: ProductListProps) {
|
|
return (
|
|
<div className={styles['container']}>
|
|
<h1>Welcome to ProductList!</h1>
|
|
<OrderList />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default ProductList;
|
|
```
|
|
|
|
If you lint your workspace you'll get an error now:
|
|
|
|
```{% command="nx run-many -t lint" %}
|
|
✔ nx run myreactapp:lint [existing outputs match the cache, left as is]
|
|
✔ nx run e2e:lint [existing outputs match the cache, left as is]
|
|
✔ nx run shared-ui:lint (1s)
|
|
|
|
✖ nx run products:lint
|
|
Linting "products"...
|
|
|
|
/Users/.../react-monorepo/libs/products/src/lib/product-list/product-list.tsx
|
|
3:1 error A project tagged with "scope:products" can only depend on libs tagged with "scope:products", "scope:shared" @nx/enforce-module-boundaries
|
|
|
|
✖ 1 problem (1 error, 0 warnings)
|
|
|
|
Lint errors found in the listed files.
|
|
|
|
✔ nx run orders:lint (1s)
|
|
|
|
————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
> NX Ran target lint for 5 projects (1s)
|
|
|
|
✔ 4/5 succeeded [2 read from cache]
|
|
|
|
✖ 1/5 targets failed, including the following:
|
|
- nx run products:lint
|
|
```
|
|
|
|
If you have the ESLint plugin installed in your IDE you should immediately see an error:
|
|
|
|
|
|
|
|
Learn more about how to [enforce module boundaries](/core-features/enforce-module-boundaries).
|
|
|
|
## Next Steps
|
|
|
|
Here's some more things you can dive into next:
|
|
|
|
- Learn more about the [underlying mental model of Nx](/concepts/mental-model)
|
|
- Learn how to [migrate your CRA app to Nx](/recipes/react/migration-cra)
|
|
- [Learn how to setup Tailwind](/recipes/react/using-tailwind-css-in-react)
|
|
- [Setup Storybook for our shared UI library](/recipes/storybook/overview-react)
|
|
- [Speed up CI: Run only tasks for project that got changed](/core-features/run-tasks#run-tasks-affected-by-a-pr)]
|
|
- [Speed up CI: Share your cache](/core-features/remote-cache)]
|
|
- [Speed up CI: Distribute your tasks across machines](/core-features/distribute-task-execution)
|
|
|
|
Also, make sure you
|
|
|
|
- [Join the Nx community Slack](https://go.nrwl.io/join-slack) to ask questions and find out the latest news about Nx.
|
|
- [Follow Nx on Twitter](https://twitter.com/nxdevtools) to stay up to date with Nx news
|
|
- [Read our Nx blog](https://blog.nrwl.io/)
|
|
- [Subscribe to our Youtube channel](https://www.youtube.com/@nxdevtools) for demos and Nx insights
|