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:

  • The nx, @nx/workspace and prettier packages will be installed.
  • An nx.json file will be created in the root of your workspace.
  • For an Angular 14+ repo, the angular.json file is split into separate project.json files for each project.

Note: The changes will be slightly different for Angular 13 and lower.

Migrating to an Nx Monorepo

If you want to migrate your Angular CLI project to an Nx Monorepo, run the following command:

❯

npx nx@latest init --integrated

The command applies the following changes to your workspace:

  • Installs the nx, @nx/angular and @nx/workspace packages.
  • Moves your applications into the apps folder, and updates the relevant file paths in your configuration files.
  • Moves your e2e suites into the apps/<app name>-e2e folder, and updates the relevant file paths in your configuration files.
  • Moves your libraries into the libs folder, and updates the relevant file paths in your configuration files.
  • Updates your package.json scripts to use nx instead of ng.
  • Splits your angular.json into project.json files 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

Modified Folder Structure

The automated migration supports Angular CLI workspaces with a standard structure, configurations and features. It supports workspaces using the following executors (builders):

  • @angular-devkit/build-angular:application
  • @angular-devkit/build-angular:browser
  • @angular-devkit/build-angular:browser-esbuild
  • @angular-devkit/build-angular:dev-server
  • @angular-devkit/build-angular:extract-i18n
  • @angular-devkit/build-angular:karma
  • @angular-devkit/build-angular:ng-packagr
  • @angular-devkit/build-angular:prerender
  • @angular-devkit/build-angular:protractor
  • @angular-devkit/build-angular:server
  • @angular-devkit/build-angular:ssr-dev-server
  • @angular-eslint/builder:lint
  • @cypress/schematic:cypress
  • @nguniversal/builders:prerender
  • @nguniversal/builders:ssr-dev-server

Support for other executors may be added in the future.

After migration

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 nx graph.

Your project graph will grow as you add and use more applications and libraries. You can add the --watch flag to nx graph to see the changes in-browser as you add them.

Set Up CI for Your Angular Workspace

This tutorial walked you through how Nx can improve the local development experience, but the biggest difference Nx makes is in CI. As repositories get bigger, making sure that the CI is fast, reliable and maintainable can get very challenging. Nx provides a solution.

Connect to Nx Cloud

Nx Cloud is a companion app for your CI system that provides remote caching, task distribution, e2e tests deflaking, better DX and more.

Now that we're working on the CI pipeline, it is important for your changes to be pushed to a GitHub repository.

  1. Commit your existing changes with git add . && git commit -am "updates"
  2. Create a new GitHub repository
  3. Follow GitHub's instructions to push your existing code to the repository

Now connect your repository to Nx Cloud with the following command:

❯

npx nx connect

A browser window will open to register your repository in your Nx Cloud account. The link is also printed to the terminal if the windows does not open, or you closed it before finishing the steps. The app will guide you to create a PR to enable Nx Cloud on your repository.

Once the PR is created, merge it into your main branch.

And make sure you pull the latest changes locally:

❯

git pull

You should now have an nxCloudId property specified in the nx.json file.

Create a CI Workflow

Use the following command to generate a CI workflow file.

❯

npx nx generate ci-workflow --ci=github

This generator creates a .github/workflows/ci.yml file that contains a CI pipeline that will run the lint, test, build and e2e tasks for projects that are affected by any given PR. Since we are using Nx Cloud, the pipeline will also distribute tasks across multiple machines to ensure fast and reliable CI runs.

The key lines in the CI pipeline are:

.github/workflows/ci.yml
1name: CI 2# ... 3jobs: 4 main: 5 runs-on: ubuntu-latest 6 steps: 7 - uses: actions/checkout@v4 8 with: 9 fetch-depth: 0 10 filter: tree:0 11 12 # This enables task distribution via Nx Cloud 13 # Run this command as early as possible, before dependencies are installed 14 # Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun 15 # Connect your workspace by running "nx connect" and uncomment this 16 - run: npx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build" 17 - uses: actions/setup-node@v3 18 with: 19 node-version: 20 20 cache: 'npm' 21 - run: npm ci --legacy-peer-deps 22 - uses: nrwl/nx-set-shas@v4 23 # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected 24 - run: npx nx affected -t lint test build 25

Open a Pull Request

Commit the changes and open a new PR on GitHub.

❯

git add .

❯

git commit -m 'add CI workflow file'

❯

git push origin add-workflow

When you view the PR on GitHub, you will see a comment from Nx Cloud that reports on the status of the CI run.

Nx Cloud report

The See all runs link goes to a page with the progress and results of tasks that were run in the CI pipeline.

Run details

For more information about how Nx can improve your CI pipeline, check out one of these detailed tutorials:

Learn More

Learn more about the advantages of Nx in the following guides:

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 init from the root of your project.

Once the script has run, commit the changes. Reverting this commit will effectively undo the changes made.

Nx and the Angular CLI

Differences between Nx and the Angular CLI

Multiple Angular Repositories to one Nx Workspace

Combine multiple Angular CLI workspaces into one Nx workspace

Recipes

Reference