miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

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

Browse Source 
* docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular

* chore: add @

* chore: add @

Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
This commit is contained in:
Leosvel Pérez Espinosa 2022-03-18 21:23:07 +00:00 committed by GitHub
parent 88a7ad7654
commit 0a88ba473f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/shared/migration/migration-angular.md
View File

@ -6,21 +6,27 @@ 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.
- 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).
## 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/workspace --preserve-angular-cli-layout
ng add @nrwl/angular --preserve-angular-cli-layout
```
> **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.
**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:
This installs the `@nrwl/workspace` package into your workspace and applies the following changes to your workspace:
| 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` |
- Adds and installs the `@nrwl/workspace` package in your development dependencies.
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.
- 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).
@ -31,12 +37,19 @@ 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/workspace
ng add @nrwl/angular
```
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:
**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:
- Installs the packages for the `Nx` plugin `@nrwl/angular` in your `package.json`.
| 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:
- Installs the `nx` and `@nrwl/workspace` packages.
- Creates an `nx.json` file in the root of your workspace.
- Creates configuration files for Prettier.
- Creates an `apps` folder for generating applications.