Plugin overview (#2742)

* docs(docs): remove migration articles from menu

* docs(docs): plugins-overview

* docs(docs): link to nx plugins overview

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
This commit is contained in:
Isaac Mann 2020-03-27 15:20:53 -04:00 committed by GitHub
parent 7dd63866ae
commit be326609cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 65 additions and 13 deletions

View File

@ -237,7 +237,8 @@
"itemList": [
{
"id": "nrwl-workspace-overview",
"name": "Overview"
"name": "Overview",
"file": "shared/workspace-plugin"
},
{
"id": "schematics",
@ -831,17 +832,6 @@
}
]
},
{
"name": "Migration",
"id": "migration",
"itemList": [
{
"name": "Overview",
"id": "migration-overview",
"file": "shared/migration-overview"
}
]
},
{
"name": "CLI",
"id": "cli",
@ -993,7 +983,8 @@
"itemList": [
{
"id": "nrwl-workspace-overview",
"name": "Overview"
"name": "Overview",
"file": "shared/workspace-plugin"
},
{
"id": "schematics",

View File

@ -0,0 +1,47 @@
# Plugins
Nx plugins are npm packages that contain schematics and builders to extend a Nx workspace. Schematics are blueprints to create or modify code, and builders perform actions on the code.
> A list of plugins maintained by Nrwl is found in the [Nrwl/nx repo](https://github.com/nrwl/nx/tree/master/packages). \
> A list of custom plugins created by the community is found in the [Plugins](/nx-plugins) section.
## nx list
Use the `nx list` command to see installed and available plugins. Both Nrwl maintained (`@nrwl/something`) and community plugins are listed.
```bash
nx list
> NX Installed plugins:
@nrwl/angular (builders,schematics)
@nrwl/cypress (builders,schematics)
@nrwl/jest (builders,schematics)
@nrwl/linter (builders)
@nrwl/nest (schematics)
@nrwl/node (builders,schematics)
@nrwl/nx-cloud (schematics)
@nrwl/workspace (builders,schematics)
> NX Also available:
@nrwl/express (builders,schematics)
@nrwl/next (builders,schematics)
@nrwl/react (builders,schematics)
@nrwl/storybook (builders,schematics)
@nrwl/web (builders,schematics)
> NX Community plugins:
@nxtend/ionic-react - An Nx plugin for developing Ionic React applications and libraries.
@angular-architects/ddd - Nx plugin for structuring a monorepo with domains and layers
@offeringsolutions/nx-karma-to-jest - Nx plugin for replacing karma with jest in an Nx workspace
@flowaccount/nx-serverless - Nx plugin for node/angular-universal schematics and deployment builders in an Nx workspace
@dev-thought/nx-deploy-it - Nx plugin to deploy applications on your favorite cloud provider
```
## See Also
[Nx Plugins](/angular/plugins/community-plugins)

View File

@ -0,0 +1,14 @@
# Workspace Plugin
The workspace plugin contains builders and schematics that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.
## Schematics
- [library](/angular/plugins_workspace_schematics/library) - Create a plain typescript library
- [move](/angular/plugins_workspace_schematics/move) - Move a project to another directory and update all references
- [remove](/angular/plugins_workspace_schematics/remove) - Remove a project from the workspace
- [workspace-schematic](/angular/plugins_workspace_schematics/workspace-schematic) - Scaffold a custom schematic for use within your workspace
## Builders
- [run-commands](/angular/plugins_workspace_builders/run-commands) - Execute an arbitrary command line script