From 5999deedaa917aef09b5150c5f498bc377c6f02a Mon Sep 17 00:00:00 2001 From: Jorge Vergara Date: Mon, 28 Nov 2022 11:18:50 -0500 Subject: [PATCH] docs(core): removes extra `nx` from example removes the `nx` keyword from example because the keyword gets added on running `yarn documentation` duplicating the keyword --- docs/generated/cli/run-many.md | 2 +- docs/generated/packages/nx.json | 2 +- packages/nx/src/command-line/examples.ts | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md index e4bf226a16a1f..50ff156d3f2b8 100644 --- a/docs/generated/cli/run-many.md +++ b/docs/generated/cli/run-many.md @@ -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 diff --git a/docs/generated/packages/nx.json b/docs/generated/packages/nx.json index ded5b8e4cfc19..34ce655718b6b 100644 --- a/docs/generated/packages/nx.json +++ b/docs/generated/packages/nx.json @@ -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", diff --git a/packages/nx/src/command-line/examples.ts b/packages/nx/src/command-line/examples.ts index 395cd955059d9..0429fca877ec4 100644 --- a/packages/nx/src/command-line/examples.ts +++ b/packages/nx/src/command-line/examples.ts @@ -296,8 +296,7 @@ export const examples: Record = { 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`', },