Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert "docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular" #9400

Merged
merged 1 commit into from Mar 18, 2022
Merged

Revert "docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular" #9400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 8 additions & 21 deletions docs/shared/migration/migration-angular.md
View file
Open in desktop
Expand Up @@ -6,27 +6,21 @@ using a monorepo approach. If you are currently using an Angular CLI workspace,
## Prerequisites

- The major version of your `Angular CLI` must align with the version of `Nx` you are upgrading to. For example, if you're using Angular CLI version 7, you must transition using the latest version 7 release of Nx.
- Currently, transforming an Angular CLI workspace to an Nx workspace automatically only supports a single project. If you have more than one project in your Angular CLI workspace, you can still [migrate manually](#transitioning-manually).
- Currently, transforming an Angular CLI workspace to an Nx workspace automatically only supports a single project. If you have more than one project in your Angular CLI workspace, you can still migrate manually.

## Using the Nx CLI while preserving the existing structure

To use the Nx CLI in an existing Angular CLI workspace while keeping your existing file structure in place, use the `ng add` command with the `--preserve-angular-cli-layout` option:

```bash
ng add @nrwl/angular --preserve-angular-cli-layout
ng add @nrwl/workspace --preserve-angular-cli-layout
```

**Note**: If you specify a version of Nx (e.g. `ng add @nrwl/angular@13.9.0`), please make sure to use the appropriate command as shown in the compatibility table below:
> **Note**: If you are migrating to an Nx versions previous to `v13.8.4` (e.g. `ng add @nrwl/workspace@12`) use the `--preserveAngularCLILayout` option instead.

| Nx version | Collection to use | Flag to use | Example |
| ------------------ | ----------------- | ------------------------------- | ------------------------------------------------------------- |
| >= 13.9.0 | `@nrwl/angular` | `--preserve-angular-cli-layout` | `ng add @nrwl/angular@13.9.0 --preserve-angular-cli-layout` |
| >= 13.8.4 < 13.9.0 | `@nrwl/workspace` | `--preserve-angular-cli-layout` | `ng add @nrwl/workspace@13.8.4 --preserve-angular-cli-layout` |
| < 13.8.4 | `@nrwl/workspace` | `--preserveAngularCLILayout` | `ng add @nrwl/workspace@13.5.0 --preserveAngularCLILayout` |
This installs the `@nrwl/workspace` package into your workspace and applies the following changes to your workspace:

This installs the `@nrwl/angular` (or `@nrwl/workspace`) package into your workspace and runs a generator (or schematic) to make following changes:

- Installs the `nx` and `@nrwl/workspace` packages.
- Adds and installs the `@nrwl/workspace` package in your development dependencies.
- Creates an `nx.json` file in the root of your workspace.
- Adds a `decorate-angular-cli.js` to the root of your workspace, and a `postinstall` script in your `package.json` to run the script when your dependencies are updated. The script forwards the `ng` commands to the Nx CLI (`nx`) to enable features such as [Computation Caching](/using-nx/caching).

Expand All @@ -37,19 +31,12 @@ After the process completes, you can continue using the same `serve/build/lint/t
To transform an Angular CLI workspace to an Nx workspace, run the following command:

```bash
ng add @nrwl/angular
ng add @nrwl/workspace
```

**Note**: If you specify a version of Nx (e.g. `ng add @nrwl/angular@13.9.0`), please make sure to use the appropriate command as shown in the compatibility table below:

| Nx version | Command to run |
| ---------- | ------------------------ |
| >= 13.9.0 | `ng add @nrwl/angular` |
| < 13.9.0 | `ng add @nrwl/workspace` |

This installs the `@nrwl/angular` (or `nrwl/workspace`) package into your workspace and runs a generator (or schematic) to transform your workspace. The generator applies the following changes to your workspace:
This installs the `@nrwl/workspace` package into your workspace and runs a generator (or schematic) to transform your workspace. The generator applies the following changes to your workspace:

- Installs the `nx` and `@nrwl/workspace` packages.
- Installs the packages for the `Nx` plugin `@nrwl/angular` in your `package.json`.
- Creates an `nx.json` file in the root of your workspace.
- Creates configuration files for Prettier.
- Creates an `apps` folder for generating applications.
Expand Down