Migrating an Angular CLI project to Nx
Within an Nx workspace, you gain many capabilities that help you build applications and libraries. If you are currently using an Angular CLI workspace, you can transform it into an Nx workspace.
Migrating to a Standalone Angular App with Nx
You can migrate to a Standalone Angular App with the command:
npx nx@latest init
This command will install the correct version of Nx based on your Angular version.
This will enable you to use the Nx CLI in your existing Angular CLI workspace while keeping your existing file structure in place. The following changes will be made in your repo to enable Nx:
prettierpackages will be installed.
nx.jsonfile will be created in the root of your workspace.
- For an Angular 14+ repo, the
angular.jsonfile is split into separate
project.jsonfiles for each project.
Note: The changes will be slightly different for Angular 13 and lower.
Migrating to an Integrated Nx Monorepo
If you want to migrate your Angular CLI project to an Integrated Nx Monorepo, run the following command:
npx nx@latest init --integrated
The command applies the following changes to your workspace:
- Installs the
- Moves your applications into the
appsfolder, and updates the relevant file paths in your configuration files.
- Moves your e2e suites into the
apps/<app name>-e2efolder, and updates the relevant file paths in your configuration files.
- Moves your libraries into the
libsfolder, and updates the relevant file paths in your configuration files.
- Updates your
package.jsonscripts to use
- Splits your
project.jsonfiles for each project with updated paths.
After the changes are applied, your workspace file structure should look similar to the one below:
1<workspace name>/ 2├── apps/ 3│ └─ <app name>/ 4│ ├── src/ 5│ │ ├── app/ 6│ │ ├── assets/ 7│ │ ├── favicon.ico 8│ │ ├── index.html 9│ │ ├── main.ts 10│ │ └── styles.css 11│ ├── project.json 12│ ├── tsconfig.app.json 13│ └── tsconfig.spec.json 14├── libs/ 15│ └── <lib name>/ 16│ ├── src/ 17│ ├── ng-package.json 18│ ├── package.json 19│ ├── project.json 20│ ├── README.md 21│ ├── tsconfig.lib.json 22│ ├── tsconfig.lib.prod.json 23│ └── tsconfig.spec.json 24├── tools/ 25├── .editorconfig 26├── .gitignore 27├── .prettierignore 28├── .prettierrc 29├── karma.conf.js 30├── nx.json 31├── package.json 32├── README.md 33└── tsconfig.base.json 34
Older Versions of Angular
Support for workspaces with multiple applications and libraries was added in Nx v14.1.0. If you are migrating using an older version of Nx, your workspace can only contain one application and no libraries in order to use the automated migration, otherwise, you can still migrate manually.
Modified Folder Structure
The automated migration supports Angular CLI workspaces with a standard structure, configurations and features. If your workspace has deviated from what the Angular CLI generates, you might not be able to use the automated migration and you will need to manually migrate your workspace.
Currently, the automated migration supports workspaces using the following executors (builders):
Support for other executors may be added in the future.
Your workspace is now powered by Nx! You can verify that your application still runs as intended:
- To serve, run
nx serve <app name>.
- To build, run
nx build <app name>.
- To run unit tests, run
nx test <app name>.
- To see your project graph, run
Your project graph will grow as you add and use more applications and libraries. You can add the
nx graphto see the changes in-browser as you add them.
Learn more about the advantages of Nx in the following guides:
- Using Cypress for e2e tests
- Using Jest for unit tests
- Computation Caching
- Rebuilding and Retesting What is Affected
- Integrate with Editors
- Advanced Angular Micro Frontends with Dynamic Module Federation
From Nx Console
Nx Console no longer supports the Angular CLI. Angular CLI users will receive a notice, asking if they want to switch to Nx. When you click this button, we’ll run the
nx init command to set up the Nx CLI, allowing for cached builds, and for you to share this cache with your teammates via Nx Cloud.
If you're not ready to make the change yet, you can come back to this later:
- If you're using Nx Console: open the Vs Code command palette and start typing "Convert Angular CLI to Nx Workspace".
- Regardless of using Nx Console (or your IDE): run
npx nx initfrom the root of your project.
Once the script has run, commit the changes. Reverting this commit will effectively undo the changes made.