nx/docs/angular/api-angular/generators/upgrade-module.md
Craigory V Coppola a1ccc87a07
docs(misc): documentation headers should include collectionName for searchability (#6451)
Signed-off-by: AgentEnder <craigorycoppola@gmail.com>
2021-07-21 11:40:59 -04:00

74 lines
1.1 KiB
Markdown

# @nrwl/angular:upgrade-module
Sets up an Upgrade Module.
## Usage
```bash
nx generate upgrade-module ...
```
By default, Nx will search for `upgrade-module` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:upgrade-module ...
```
Show what will be generated without writing to disk:
```bash
nx g upgrade-module ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the main AngularJS module.
### project (_**required**_)
Type: `string`
The name of the project.
### angularJsCmpSelector
Type: `string`
The selector of an AngularJS component (e.g., `--angularJsCmpSelector=myComponent`).
### angularJsImport
Type: `string`
Import expression of the AngularJS application (e.g., `--angularJsImport=some_node_module/my_app`).
### router
Default: `false`
Type: `boolean`
Sets up router synchronization (e.g., `--router`).
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).