From 03685f9fce210d8bc1fb2691832a7b6ab659ef97 Mon Sep 17 00:00:00 2001 From: Craigory Coppola Date: Thu, 16 May 2024 16:51:50 -0400 Subject: [PATCH] fix(core): don't have .: inside docs --- docs/generated/cli/affected.md | 8 ++--- docs/generated/cli/graph.md | 6 ---- docs/generated/cli/run-many.md | 6 ++-- docs/generated/cli/run.md | 8 ++--- docs/generated/cli/show.md | 8 ++--- .../packages/nx/documents/affected.md | 8 ++--- .../packages/nx/documents/dep-graph.md | 6 ---- .../packages/nx/documents/run-many.md | 6 ++-- docs/generated/packages/nx/documents/run.md | 8 ++--- docs/generated/packages/nx/documents/show.md | 8 ++--- packages/nx/src/command-line/examples.ts | 36 ++++++++----------- 11 files changed, 45 insertions(+), 63 deletions(-) diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index 852ce52612973..07ba30b77bc90 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -59,25 +59,25 @@ Run build for only projects with the tag `dotnet`: nx affected -t=build --exclude='*,!tag:dotnet' ``` -Use the currently executing project name in your command.: +Use the currently executing project name in your command: ```shell nx affected -t build --tag=$NX_TASK_TARGET_PROJECT:latest ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx affected -t=build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx affected -t=build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx affected -t=build --graph=stdout diff --git a/docs/generated/cli/graph.md b/docs/generated/cli/graph.md index 650bd21e1953c..a621f7eb8a30c 100644 --- a/docs/generated/cli/graph.md +++ b/docs/generated/cli/graph.md @@ -37,12 +37,6 @@ Generate a static website with project graph into an html file, accompanied by a Print the project graph as JSON to the console: -```shell - nx graph --file=stdout -``` - -Print the project graph as JSON to the console: - ```shell nx graph --print ``` diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md index 0860b75a59149..262a84e05396b 100644 --- a/docs/generated/cli/run-many.md +++ b/docs/generated/cli/run-many.md @@ -71,19 +71,19 @@ Run lint, test, and build targets for all projects. Requires Nx v15.4+: nx run-many --targets=lint,test,build ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx run-many -t=build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx run-many -t=build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx run-many -t=build --graph=stdout diff --git a/docs/generated/cli/run.md b/docs/generated/cli/run.md index 97664de5d611e..1a8e3fade882b 100644 --- a/docs/generated/cli/run.md +++ b/docs/generated/cli/run.md @@ -41,25 +41,25 @@ Run the target build for the myapp project, with production configuration: nx run myapp:build:production ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx run myapp:build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx run myapp:build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx run myapp:build --graph=stdout ``` -Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration.: +Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration: ```shell nx run myapp:"build:test" diff --git a/docs/generated/cli/show.md b/docs/generated/cli/show.md index 63571e855373d..a959973d33067 100644 --- a/docs/generated/cli/show.md +++ b/docs/generated/cli/show.md @@ -23,7 +23,7 @@ Show all projects in the workspace: nx show projects ``` -Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many.: +Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many: ```shell nx show projects --projects api-* @@ -53,19 +53,19 @@ Show affected projects in the workspace, excluding end-to-end projects: nx show projects --affected --exclude=*-e2e ``` -If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON.: +If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON: ```shell nx show project my-app ``` -Show detailed information about "my-app" in a json format.: +Show detailed information about "my-app" in a json format: ```shell nx show project my-app --json ``` -Show information about "my-app" in a human readable format.: +Show information about "my-app" in a human readable format: ```shell nx show project my-app --json false diff --git a/docs/generated/packages/nx/documents/affected.md b/docs/generated/packages/nx/documents/affected.md index 852ce52612973..07ba30b77bc90 100644 --- a/docs/generated/packages/nx/documents/affected.md +++ b/docs/generated/packages/nx/documents/affected.md @@ -59,25 +59,25 @@ Run build for only projects with the tag `dotnet`: nx affected -t=build --exclude='*,!tag:dotnet' ``` -Use the currently executing project name in your command.: +Use the currently executing project name in your command: ```shell nx affected -t build --tag=$NX_TASK_TARGET_PROJECT:latest ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx affected -t=build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx affected -t=build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx affected -t=build --graph=stdout diff --git a/docs/generated/packages/nx/documents/dep-graph.md b/docs/generated/packages/nx/documents/dep-graph.md index 650bd21e1953c..a621f7eb8a30c 100644 --- a/docs/generated/packages/nx/documents/dep-graph.md +++ b/docs/generated/packages/nx/documents/dep-graph.md @@ -37,12 +37,6 @@ Generate a static website with project graph into an html file, accompanied by a Print the project graph as JSON to the console: -```shell - nx graph --file=stdout -``` - -Print the project graph as JSON to the console: - ```shell nx graph --print ``` diff --git a/docs/generated/packages/nx/documents/run-many.md b/docs/generated/packages/nx/documents/run-many.md index 0860b75a59149..262a84e05396b 100644 --- a/docs/generated/packages/nx/documents/run-many.md +++ b/docs/generated/packages/nx/documents/run-many.md @@ -71,19 +71,19 @@ Run lint, test, and build targets for all projects. Requires Nx v15.4+: nx run-many --targets=lint,test,build ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx run-many -t=build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx run-many -t=build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx run-many -t=build --graph=stdout diff --git a/docs/generated/packages/nx/documents/run.md b/docs/generated/packages/nx/documents/run.md index 97664de5d611e..1a8e3fade882b 100644 --- a/docs/generated/packages/nx/documents/run.md +++ b/docs/generated/packages/nx/documents/run.md @@ -41,25 +41,25 @@ Run the target build for the myapp project, with production configuration: nx run myapp:build:production ``` -Preview the task graph that Nx would run inside a webview.: +Preview the task graph that Nx would run inside a webview: ```shell nx run myapp:build --graph ``` -Save the task graph to a file.: +Save the task graph to a file: ```shell nx run myapp:build --graph=output.json ``` -Print the task graph to the console.: +Print the task graph to the console: ```shell nx run myapp:build --graph=stdout ``` -Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration.: +Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration: ```shell nx run myapp:"build:test" diff --git a/docs/generated/packages/nx/documents/show.md b/docs/generated/packages/nx/documents/show.md index 63571e855373d..a959973d33067 100644 --- a/docs/generated/packages/nx/documents/show.md +++ b/docs/generated/packages/nx/documents/show.md @@ -23,7 +23,7 @@ Show all projects in the workspace: nx show projects ``` -Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many.: +Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many: ```shell nx show projects --projects api-* @@ -53,19 +53,19 @@ Show affected projects in the workspace, excluding end-to-end projects: nx show projects --affected --exclude=*-e2e ``` -If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON.: +If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON: ```shell nx show project my-app ``` -Show detailed information about "my-app" in a json format.: +Show detailed information about "my-app" in a json format: ```shell nx show project my-app --json ``` -Show information about "my-app" in a human readable format.: +Show information about "my-app" in a human readable format: ```shell nx show project my-app --json false diff --git a/packages/nx/src/command-line/examples.ts b/packages/nx/src/command-line/examples.ts index 1bf9648369530..1d6cdeee0e5b4 100644 --- a/packages/nx/src/command-line/examples.ts +++ b/packages/nx/src/command-line/examples.ts @@ -39,22 +39,22 @@ export const examples: Record = { }, { command: 'affected -t build --tag=$NX_TASK_TARGET_PROJECT:latest', - description: 'Use the currently executing project name in your command.', + description: 'Use the currently executing project name in your command', }, { command: 'affected -t=build --graph', - description: 'Preview the task graph that Nx would run inside a webview.', + description: 'Preview the task graph that Nx would run inside a webview', }, { command: 'affected -t=build --graph=output.json', - description: 'Save the task graph to a file.', + description: 'Save the task graph to a file', }, { command: 'affected -t=build --graph=stdout', - description: 'Print the task graph to the console.', + description: 'Print the task graph to the console', }, ], 'affected:test': [ @@ -158,11 +158,6 @@ export const examples: Record = { 'Generate a static website with project graph into an html file, accompanied by an asset folder called static', }, - { - command: 'graph --file=stdout', - description: 'Print the project graph as JSON to the console', - }, - { command: 'graph --print', description: 'Print the project graph as JSON to the console', @@ -246,17 +241,17 @@ export const examples: Record = { { command: 'run-many -t=build --graph', - description: 'Preview the task graph that Nx would run inside a webview.', + description: 'Preview the task graph that Nx would run inside a webview', }, { command: 'run-many -t=build --graph=output.json', - description: 'Save the task graph to a file.', + description: 'Save the task graph to a file', }, { command: 'run-many -t=build --graph=stdout', - description: 'Print the task graph to the console.', + description: 'Print the task graph to the console', }, ], run: [ @@ -273,23 +268,23 @@ export const examples: Record = { { command: 'run myapp:build --graph', - description: 'Preview the task graph that Nx would run inside a webview.', + description: 'Preview the task graph that Nx would run inside a webview', }, { command: 'run myapp:build --graph=output.json', - description: 'Save the task graph to a file.', + description: 'Save the task graph to a file', }, { command: 'run myapp:build --graph=stdout', - description: 'Print the task graph to the console.', + description: 'Print the task graph to the console', }, { command: 'run myapp:"build:test"', description: - 'Run\'s a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration.', + 'Run\'s a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration', }, ], migrate: [ @@ -350,7 +345,7 @@ export const examples: Record = { { command: 'show projects --projects api-*', description: - 'Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many.', + 'Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many', }, { @@ -377,18 +372,17 @@ export const examples: Record = { { command: 'show project my-app', description: - 'If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON.', + 'If in an interactive terminal, opens the project detail view. If not in an interactive terminal, defaults to JSON', }, { command: 'show project my-app --json', - description: 'Show detailed information about "my-app" in a json format.', + description: 'Show detailed information about "my-app" in a json format', }, { command: 'show project my-app --json false', - description: - 'Show information about "my-app" in a human readable format.', + description: 'Show information about "my-app" in a human readable format', }, {