From eebe9fae388e5b5661fc7a1e46ece1d823651cb7 Mon Sep 17 00:00:00 2001 From: Brandon Roberts Date: Mon, 7 Oct 2019 14:41:37 -0500 Subject: [PATCH] docs(nx): fix affected help comand --- docs/react/guides/cli.md | 38 +++++++++++++++++++++----------- docs/web/guides/cli.md | 47 ++++++++++++++++++++++------------------ 2 files changed, 51 insertions(+), 34 deletions(-) diff --git a/docs/react/guides/cli.md b/docs/react/guides/cli.md index f75f70a1e1..c6c50087d2 100644 --- a/docs/react/guides/cli.md +++ b/docs/react/guides/cli.md @@ -175,7 +175,7 @@ For the workspace, unless overridden, each component will be generated using CSS ### 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 { @@ -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. -| Command | Description | -| --------- | --------------------------------------------------------------------------------------- | -| serve | Build the application, start up a development web server, and rebuild/reload on changes | -| build | Build and bundle the application for distribution | -| dep-graph | Generate a dependency graph for the project | -| lint | Run the lint checker for the workspace | -| e2e | Run all the E2E tests for the workspace | -| format:write | Run the code formatter across all the projects | -| format:check | Check the formatted code across all the projects | -| workspace-schematic | Run a workspace schematic | -| test | Run the unit tests for all projects | -| help | Display usage help for the Nx CLI | +| Command | Description | +| ------------------- | --------------------------------------------------------------------------------------- | +| serve | Build the application, start up a development web server, and rebuild/reload on changes | +| build | Build and bundle the application for distribution | +| dep-graph | Generate a dependency graph for the project | +| lint | Run the lint checker for the workspace | +| e2e | Run all the E2E tests for the workspace | +| format:write | Run the code formatter across all the projects | +| format:check | Check the formatted code across all the projects | +| workspace-schematic | Run a workspace schematic | +| test | Run the unit tests for all projects | +| help | Display usage help for the Nx CLI | ## Determining Affected Projects @@ -261,6 +261,12 @@ Display the list of apps affected by the current changes nx affected:apps ``` +Display the help usage for available options to determine the affected apps. + +```sh +nx affected:apps --help +``` + --- ### affected:libs @@ -271,6 +277,12 @@ Display the list of libs affected by the current changes nx affected:libs ``` +Display the help usage for available options to determine the affected libs. + +```sh +nx affected:libs --help +``` + --- ### affected:build diff --git a/docs/web/guides/cli.md b/docs/web/guides/cli.md index 410717f7c6..aeede343ed 100644 --- a/docs/web/guides/cli.md +++ b/docs/web/guides/cli.md @@ -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. - - ```sh 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. -| Command | Description | -| --------- | --------------------------------------------------------------------------------------- | -| serve | Build the application, start up a development web server, and rebuild/reload on changes | -| build | Build and bundle the application for distribution | -| dep-graph | Generate a dependency graph for the project | -| lint | Run the lint checker for the workspace | -| e2e | Run all the E2E tests for the workspace | -| format:write | Run the code formatter across all the projects | -| format:check | Check the formatted code across all the projects | -| workspace-schematic | Run a workspace schematic | -| test | Run the unit tests for all projects | -| help | Display usage help for the Nx CLI | +| Command | Description | +| ------------------- | --------------------------------------------------------------------------------------- | +| serve | Build the application, start up a development web server, and rebuild/reload on changes | +| build | Build and bundle the application for distribution | +| dep-graph | Generate a dependency graph for the project | +| lint | Run the lint checker for the workspace | +| e2e | Run all the E2E tests for the workspace | +| format:write | Run the code formatter across all the projects | +| format:check | Check the formatted code across all the projects | +| workspace-schematic | Run a workspace schematic | +| test | Run the unit tests for all projects | +| help | Display usage help for the Nx CLI | ## Determining Affected Projects @@ -265,6 +264,12 @@ Display the list of apps affected by the current changes nx affected:apps ``` +Display the help usage for available options to determine the affected apps. + +```sh +nx affected:apps --help +``` + --- ### affected:libs @@ -275,6 +280,12 @@ Display the list of libs affected by the current changes nx affected:libs ``` +Display the help usage for available options to determine the affected libs. + +```sh +nx affected:libs --help +``` + --- ### affected:build @@ -407,10 +418,4 @@ nx affected:dep-graph ### 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).