docs(nx): fix affected help comand

This commit is contained in:
Brandon Roberts 2019-10-07 14:41:37 -05:00 committed by Victor Savkin
parent 885dfd755f
commit eebe9fae38
2 changed files with 51 additions and 34 deletions

View File

@ -175,7 +175,7 @@ For the workspace, unless overridden, each component will be generated using CSS
### Default Collection ### Default Collection
You can also set default schematics for your workspace by configuring the `defaultCollection` property in your `workspace.json` file. You can also set default schematics for your workspace by configuring the `defaultCollection` property in your `workspace.json` file.
```json ```json
{ {
@ -234,18 +234,18 @@ The above command will run the `build` configuration against the `myapp` project
The following commands are general commands to peform specific tasks against projects in your workspace, or against your workspace as a whole. The following commands are general commands to peform specific tasks against projects in your workspace, or against your workspace as a whole.
| Command | Description | | Command | Description |
| --------- | --------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------- |
| serve | Build the application, start up a development web server, and rebuild/reload on changes | | serve | Build the application, start up a development web server, and rebuild/reload on changes |
| build | Build and bundle the application for distribution | | build | Build and bundle the application for distribution |
| dep-graph | Generate a dependency graph for the project | | dep-graph | Generate a dependency graph for the project |
| lint | Run the lint checker for the workspace | | lint | Run the lint checker for the workspace |
| e2e | Run all the E2E tests for the workspace | | e2e | Run all the E2E tests for the workspace |
| format:write | Run the code formatter across all the projects | | format:write | Run the code formatter across all the projects |
| format:check | Check the formatted code across all the projects | | format:check | Check the formatted code across all the projects |
| workspace-schematic | Run a workspace schematic | | workspace-schematic | Run a workspace schematic |
| test | Run the unit tests for all projects | | test | Run the unit tests for all projects |
| help | Display usage help for the Nx CLI | | help | Display usage help for the Nx CLI |
## Determining Affected Projects ## Determining Affected Projects
@ -261,6 +261,12 @@ Display the list of apps affected by the current changes
nx affected:apps nx affected:apps
``` ```
Display the help usage for available options to determine the affected apps.
```sh
nx affected:apps --help
```
--- ---
### affected:libs ### affected:libs
@ -271,6 +277,12 @@ Display the list of libs affected by the current changes
nx affected:libs nx affected:libs
``` ```
Display the help usage for available options to determine the affected libs.
```sh
nx affected:libs --help
```
--- ---
### affected:build ### affected:build

View File

@ -110,7 +110,7 @@ The command above generates a new application using SASS for styles instead of C
You can preview the changes a schematic makes by using the `--dry-run` option. It will output the potential files created, and/or updated during the execution of the schematic. You can preview the changes a schematic makes by using the `--dry-run` option. It will output the potential files created, and/or updated during the execution of the schematic.
<!-- <!--
TODO: Add component schematic to @nrwl/web TODO: Add component schematic to @nrwl/web
@ -178,7 +178,7 @@ For the workspace, unless overridden, each component will be generated using CSS
### Default Collection ### Default Collection
You can also set default schematics for your workspace by configuring the `defaultCollection` property in your `workspace.json` file. You can also set default schematics for your workspace by configuring the `defaultCollection` property in your `workspace.json` file.
```json ```json
{ {
@ -203,7 +203,6 @@ You can also set default schematics for your workspace by configuring the `defau
Setting `@nrwl/web` as the default collection allows you to use shorthand syntax to run the schematics command. Without a default, you have to specify the collection for the schematics. --> Setting `@nrwl/web` as the default collection allows you to use shorthand syntax to run the schematics command. Without a default, you have to specify the collection for the schematics. -->
```sh ```sh
nx g @nrwl/web:app mysecondapp nx g @nrwl/web:app mysecondapp
``` ```
@ -238,18 +237,18 @@ The above command will run the `build` configuration against the `myapp` project
The following commands are general commands to peform specific tasks against projects in your workspace, or against your workspace as a whole. The following commands are general commands to peform specific tasks against projects in your workspace, or against your workspace as a whole.
| Command | Description | | Command | Description |
| --------- | --------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------- |
| serve | Build the application, start up a development web server, and rebuild/reload on changes | | serve | Build the application, start up a development web server, and rebuild/reload on changes |
| build | Build and bundle the application for distribution | | build | Build and bundle the application for distribution |
| dep-graph | Generate a dependency graph for the project | | dep-graph | Generate a dependency graph for the project |
| lint | Run the lint checker for the workspace | | lint | Run the lint checker for the workspace |
| e2e | Run all the E2E tests for the workspace | | e2e | Run all the E2E tests for the workspace |
| format:write | Run the code formatter across all the projects | | format:write | Run the code formatter across all the projects |
| format:check | Check the formatted code across all the projects | | format:check | Check the formatted code across all the projects |
| workspace-schematic | Run a workspace schematic | | workspace-schematic | Run a workspace schematic |
| test | Run the unit tests for all projects | | test | Run the unit tests for all projects |
| help | Display usage help for the Nx CLI | | help | Display usage help for the Nx CLI |
## Determining Affected Projects ## Determining Affected Projects
@ -265,6 +264,12 @@ Display the list of apps affected by the current changes
nx affected:apps nx affected:apps
``` ```
Display the help usage for available options to determine the affected apps.
```sh
nx affected:apps --help
```
--- ---
### affected:libs ### affected:libs
@ -275,6 +280,12 @@ Display the list of libs affected by the current changes
nx affected:libs nx affected:libs
``` ```
Display the help usage for available options to determine the affected libs.
```sh
nx affected:libs --help
```
--- ---
### affected:build ### affected:build
@ -407,10 +418,4 @@ nx affected:dep-graph
### affected ### affected
Display the help usage for available options to determine the affected projects.
```sh
nx affected
```
You can read more about these commands in the guide about [only rebuilding and retesting what is affected](/web/guides/monorepo-affected). You can read more about these commands in the guide about [only rebuilding and retesting what is affected](/web/guides/monorepo-affected).