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

docs(angular): call out @nx/angular plugin as required to run angular devkit schematics and builders (#22872)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2024-04-18 15:53:35 +02:00 committed by GitHub
parent 2d20ad819b
commit 7ebd27af02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 36 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/generated/packages/angular/documents/overview.md
View File

@ -4,15 +4,24 @@ description: The Nx Plugin for Angular contains executors, generators, and utili
---
The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries
within an Nx workspace. It provides:
within an Nx workspace. It also enables using Angular Devkit builders and schematics in Nx workspaces.
- Integration with libraries such as Storybook, Jest and Cypress.
Among other things, it provides:
- Integration with libraries such as:
- Cypress
- ESLint
- Jest
- Playwright
- Storybook
- Generators to help scaffold code quickly, including:
- Micro Frontends
- Libraries, both internal to your codebase and publishable to npm
- Single Component Application Modules (SCAMs)
- NgRx helpers.
- Utilities for automatic workspace refactoring.
- Projects with Tailwind CSS
- Executors providing extra capabilities on top of the Angular Devkit builders:
- Provide ESBuild plugins
- Provide custom webpack configurations
- Utilities for automatic workspace refactoring
{% callout type="note" title="Currently using the Angular CLI?" %}
You can easily and mostly **automatically migrate from an Angular CLI** project to Nx! Learn

4
docs/shared/guides/nx-and-angular-cli.md
View File

@ -146,6 +146,10 @@ You can also run Angular Schematics through the Nx CLI. So something like this w
npx nx g @schematics/angular:component my-component
```
{% callout type="check" title="Important" %}
Support to run Angular Devkit builders and schematics is enabled by installing the [`@nx/angular` plugin](/nx-api/angular/documents/overview). This plugin is installed by default when creating a new Angular workspace with Nx or [migrate an existing Angular CLI workspace to Nx](#migrate-from-the-angular-cli).
{% /callout %}
### Running Commands
Commands are run in the very same way as with the Angular CLI. You just switch `ng` with `nx`. For example:

4
docs/shared/guides/nx-devkit-angular-devkit.md
View File

@ -6,6 +6,10 @@ This document covers the difference between Nx Devkit and Angular Devkit. See th
Nx comes with a devkit to write generators and executors, but you can also use Angular devkit (schematics and builders). In other words, you can use an Angular schematic to implement a generator, and you can use an Angular builder to implement an executor.
{% callout type="check" title="Important" %}
Support to run Angular Devkit builders and schematics is enabled by installing the [`@nx/angular` plugin](/nx-api/angular/documents/overview). This plugin is installed by default when creating a new Angular workspace with Nx or [migrate an existing Angular CLI workspace to Nx](/recipes/angular/migration/angular).
{% /callout %}
**What are the differences between Nx Devkit and Angular Devkit?**
## Generators

19
docs/shared/packages/angular/angular-plugin.md
View File

@ -4,15 +4,24 @@ description: The Nx Plugin for Angular contains executors, generators, and utili
---
The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries
within an Nx workspace. It provides:
within an Nx workspace. It also enables using Angular Devkit builders and schematics in Nx workspaces.
- Integration with libraries such as Storybook, Jest and Cypress.
Among other things, it provides:
- Integration with libraries such as:
- Cypress
- ESLint
- Jest
- Playwright
- Storybook
- Generators to help scaffold code quickly, including:
- Micro Frontends
- Libraries, both internal to your codebase and publishable to npm
- Single Component Application Modules (SCAMs)
- NgRx helpers.
- Utilities for automatic workspace refactoring.
- Projects with Tailwind CSS
- Executors providing extra capabilities on top of the Angular Devkit builders:
- Provide ESBuild plugins
- Provide custom webpack configurations
- Utilities for automatic workspace refactoring
{% callout type="note" title="Currently using the Angular CLI?" %}
You can easily and mostly **automatically migrate from an Angular CLI** project to Nx! Learn