Skip to content

Commit

Permalink
fix(core): don't have .: inside docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AgentEnder committed May 24, 2024
1 parent 7c360fd commit 03685f9
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 63 deletions.
8 changes: 4 additions & 4 deletions docs/generated/cli/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions docs/generated/cli/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
6 changes: 3 additions & 3 deletions docs/generated/cli/run-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/generated/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 4 additions & 4 deletions docs/generated/cli/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-*
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/generated/packages/nx/documents/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions docs/generated/packages/nx/documents/dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
6 changes: 3 additions & 3 deletions docs/generated/packages/nx/documents/run-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/generated/packages/nx/documents/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 4 additions & 4 deletions docs/generated/packages/nx/documents/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-*
Expand Down Expand Up @@ -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
Expand Down
36 changes: 15 additions & 21 deletions packages/nx/src/command-line/examples.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ export const examples: Record<string, Example[]> = {
},
{
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': [
Expand Down Expand Up @@ -158,11 +158,6 @@ export const examples: Record<string, Example[]> = {
'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',
Expand Down Expand Up @@ -246,17 +241,17 @@ export const examples: Record<string, Example[]> = {

{
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: [
Expand All @@ -273,23 +268,23 @@ export const examples: Record<string, Example[]> = {

{
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: [
Expand Down Expand Up @@ -350,7 +345,7 @@ export const examples: Record<string, Example[]> = {
{
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',
},

{
Expand All @@ -377,18 +372,17 @@ export const examples: Record<string, Example[]> = {
{
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',
},

{
Expand Down

0 comments on commit 03685f9

Please sign in to comment.