Skip to content

Commit

Permalink
docs(core): removes extra nx from example
Browse files Browse the repository at this point in the history
removes the `nx` keyword from example because the keyword
gets added on running `yarn
documentation`
duplicating the keyword
  • Loading branch information
javebratt authored and juristr committed Nov 29, 2022
1 parent 78758a1 commit 5999dee
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/generated/cli/run-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Test proj1 and proj2 in parallel:
Test all projects ending with `*-app` except `excluded-app`:

```terminal
nx nx run-many --target=test --projects=*-app --exclude excluded-app
nx run-many --target=test --projects=*-app --exclude excluded-app
```

## Options
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"tags": ["run-tasks", "use-task-executors"],
"id": "run-many",
"file": "generated/cli/run-many",
"content": "---\ntitle: 'run-many - CLI command'\ndescription: 'Run target for multiple listed projects'\n---\n\n# run-many\n\nRun target for multiple listed projects\n\n## Usage\n\n```terminal\nnx run-many\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nTest all projects:\n\n```terminal\n nx run-many --target=test\n```\n\nTest proj1 and proj2:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2\n```\n\nTest proj1 and proj2 in parallel:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2 --parallel=2\n```\n\nTest all projects ending with `*-app` except `excluded-app`:\n\n```terminal\n nx nx run-many --target=test --projects=*-app --exclude excluded-app\n```\n\n## Options\n\n### all\n\nType: `boolean`\n\nDefault: `true`\n\n[deprecated] Run the target on all projects in the workspace\n\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n\n### help\n\nType: `boolean`\n\nShow help\n\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n\n### output-style\n\nType: `string`\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n\n### parallel\n\nType: `string`\n\nMax number of parallel processes [default is 3]\n\n### projects\n\nType: `string`\n\nProjects to run. (comma delimited project names and/or patterns)\n\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n\n### target\n\nType: `string`\n\nTask to run for affected projects\n\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: `boolean`\n\nShow version number\n"
"content": "---\ntitle: 'run-many - CLI command'\ndescription: 'Run target for multiple listed projects'\n---\n\n# run-many\n\nRun target for multiple listed projects\n\n## Usage\n\n```terminal\nnx run-many\n```\n\nInstall `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.\n\n### Examples\n\nTest all projects:\n\n```terminal\n nx run-many --target=test\n```\n\nTest proj1 and proj2:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2\n```\n\nTest proj1 and proj2 in parallel:\n\n```terminal\n nx run-many --target=test --projects=proj1,proj2 --parallel=2\n```\n\nTest all projects ending with `*-app` except `excluded-app`:\n\n```terminal\n nx run-many --target=test --projects=*-app --exclude excluded-app\n```\n\n## Options\n\n### all\n\nType: `boolean`\n\nDefault: `true`\n\n[deprecated] Run the target on all projects in the workspace\n\n### configuration\n\nType: `string`\n\nThis is the configuration to use when performing tasks on projects\n\n### exclude\n\nType: `array`\n\nDefault: `[]`\n\nExclude certain projects from being processed\n\n### help\n\nType: `boolean`\n\nShow help\n\n### nx-bail\n\nType: `boolean`\n\nDefault: `false`\n\nStop command execution after the first failed task\n\n### nx-ignore-cycles\n\nType: `boolean`\n\nDefault: `false`\n\nIgnore cycles in the task graph\n\n### output-style\n\nType: `string`\n\nChoices: [dynamic, static, stream, stream-without-prefixes]\n\nDefines how Nx emits outputs tasks logs\n\n### parallel\n\nType: `string`\n\nMax number of parallel processes [default is 3]\n\n### projects\n\nType: `string`\n\nProjects to run. (comma delimited project names and/or patterns)\n\n### runner\n\nType: `string`\n\nThis is the name of the tasks runner configured in nx.json\n\n### skip-nx-cache\n\nType: `boolean`\n\nDefault: `false`\n\nRerun the tasks even when the results are available in the cache\n\n### target\n\nType: `string`\n\nTask to run for affected projects\n\n### verbose\n\nType: `boolean`\n\nDefault: `false`\n\nPrints additional information about the commands (e.g., stack traces)\n\n### version\n\nType: `boolean`\n\nShow version number\n"
},
{
"name": "affected",
Expand Down
3 changes: 1 addition & 2 deletions packages/nx/src/command-line/examples.ts
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,7 @@ export const examples: Record<string, Example[]> = {
description: 'Test proj1 and proj2 in parallel',
},
{
command:
'nx run-many --target=test --projects=*-app --exclude excluded-app',
command: 'run-many --target=test --projects=*-app --exclude excluded-app',
description:
'Test all projects ending with `*-app` except `excluded-app`',
},
Expand Down

0 comments on commit 5999dee

Please sign in to comment.