-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(scripts): documentation upgrade
Follow the new package architecture. The generation of the documentation has been improved, new helper functions have been added to handle the new architecture.
- Loading branch information
Showing
64 changed files
with
1,397 additions
and
667 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/api-schematics/downgrade-module.md → ...pi-angular/schematics/downgrade-module.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# downgrade-module | ||
|
||
Generates downgradeModule setup | ||
Setup Downgrade Module | ||
|
||
## Usage | ||
|
||
|
4 changes: 2 additions & 2 deletions
4
docs/api-schematics/karma-project.md → docs/api-angular/schematics/karma-project.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# karma | ||
|
||
Add karma configuration to a workspace | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate karma ... | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# ng-add [hidden] | ||
|
||
Add @nrwl/react to a project | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate ng-add ... | ||
|
||
``` | ||
|
||
## Options | ||
|
||
### e2eTestRunner | ||
|
||
Default: `cypress` | ||
|
||
Type: `string` | ||
|
||
Test runner to use for end to end (e2e) tests | ||
|
||
### skipInstall | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Skip installing after adding @nrwl/workspace | ||
|
||
### unitTestRunner | ||
|
||
Default: `jest` | ||
|
||
Type: `string` | ||
|
||
Test runner to use for unit tests |
2 changes: 1 addition & 1 deletion
2
docs/api-schematics/ngrx.md → docs/api-angular/schematics/ngrx.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# ngrx | ||
|
||
Add NgRx support to a module | ||
Add an ngrx config to a project | ||
|
||
## Usage | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
docs/api-schematics/upgrade-module.md → .../api-angular/schematics/upgrade-module.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# upgrade-module | ||
|
||
Generates UpgradeModule setup | ||
Add an upgrade module | ||
|
||
## Usage | ||
|
||
|
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# cypress-project | ||
|
||
Add a Cypress E2E Project | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate cypress-project ... | ||
|
||
``` | ||
|
||
## Options | ||
|
||
### directory | ||
|
||
Type: `string` | ||
|
||
A directory where the app is placed | ||
|
||
### name | ||
|
||
Type: `string` | ||
|
||
Name of the E2E Project | ||
|
||
### project | ||
|
||
Type: `string` | ||
|
||
The name of the frontend project to test. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# ng-add [hidden] | ||
|
||
Add Cypress configuration to the workspace | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate ng-add ... | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# ng-add [hidden] | ||
|
||
Add @nrwl/express to a project | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate ng-add ... | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# application | ||
|
||
Create a nest application | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate application ... | ||
|
||
``` | ||
|
||
## Options | ||
|
||
### directory | ||
|
||
Type: `string` | ||
|
||
The directory of the new application. | ||
|
||
### frontendProject | ||
|
||
Type: `string` | ||
|
||
Frontend project that needs to access this application. This sets up proxy configuration. | ||
|
||
### name | ||
|
||
Type: `string` | ||
|
||
The name of the application. | ||
|
||
### skipFormat | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Skip formatting files | ||
|
||
### skipPackageJson | ||
|
||
Default: `false` | ||
|
||
Type: `boolean` | ||
|
||
Do not add dependencies to package.json. | ||
|
||
### tags | ||
|
||
Type: `string` | ||
|
||
Add tags to the application (used for linting) | ||
|
||
### unitTestRunner | ||
|
||
Default: `jest` | ||
|
||
Type: `string` | ||
|
||
Test runner to use for unit tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# ng-add [hidden] | ||
|
||
Add @nrwl/nest to a project | ||
|
||
## Usage | ||
|
||
```bash | ||
ng generate ng-add ... | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/api-builders/node-execute.md → docs/api-node/builders/execute.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# node-execute | ||
# execute | ||
|
||
Execute a Node application | ||
|
||
|
Oops, something went wrong.