diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index 3be4ed2e1554c..3a3cd1087124a 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -103,6 +103,7 @@ Print the task graph to the console: | `--parallel` | string | Max number of parallel processes [default is 3]. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--targets` | string | Tasks to run for affected projects. | | `--uncommitted` | boolean | Uncommitted changes. | | `--untracked` | boolean | Untracked changes. | diff --git a/docs/generated/cli/release.md b/docs/generated/cli/release.md index d51c7ebd97da7..08343d1fb55fe 100644 --- a/docs/generated/cli/release.md +++ b/docs/generated/cli/release.md @@ -128,6 +128,7 @@ nx release publish | `--registry` | string | The registry to publish to. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--tag` | string | The distribution tag to apply to the published package. | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md index ea1499b3d3a96..fe120be4bb199 100644 --- a/docs/generated/cli/run-many.md +++ b/docs/generated/cli/run-many.md @@ -107,6 +107,7 @@ Print the task graph to the console: | `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--targets` | string | Tasks to run for affected projects. | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/docs/generated/cli/run.md b/docs/generated/cli/run.md index bec5c2b7498ad..f5dd9237e1fe2 100644 --- a/docs/generated/cli/run.md +++ b/docs/generated/cli/run.md @@ -81,5 +81,6 @@ Run's a target named build:test for the myapp project. Note the quotes around th | `--project` | string | Target project. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/docs/generated/packages/nx/documents/affected.md b/docs/generated/packages/nx/documents/affected.md index 3be4ed2e1554c..3a3cd1087124a 100644 --- a/docs/generated/packages/nx/documents/affected.md +++ b/docs/generated/packages/nx/documents/affected.md @@ -103,6 +103,7 @@ Print the task graph to the console: | `--parallel` | string | Max number of parallel processes [default is 3]. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--targets` | string | Tasks to run for affected projects. | | `--uncommitted` | boolean | Uncommitted changes. | | `--untracked` | boolean | Untracked changes. | diff --git a/docs/generated/packages/nx/documents/release.md b/docs/generated/packages/nx/documents/release.md index d51c7ebd97da7..08343d1fb55fe 100644 --- a/docs/generated/packages/nx/documents/release.md +++ b/docs/generated/packages/nx/documents/release.md @@ -128,6 +128,7 @@ nx release publish | `--registry` | string | The registry to publish to. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--tag` | string | The distribution tag to apply to the published package. | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/docs/generated/packages/nx/documents/run-many.md b/docs/generated/packages/nx/documents/run-many.md index ea1499b3d3a96..fe120be4bb199 100644 --- a/docs/generated/packages/nx/documents/run-many.md +++ b/docs/generated/packages/nx/documents/run-many.md @@ -107,6 +107,7 @@ Print the task graph to the console: | `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--targets` | string | Tasks to run for affected projects. | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/docs/generated/packages/nx/documents/run.md b/docs/generated/packages/nx/documents/run.md index bec5c2b7498ad..f5dd9237e1fe2 100644 --- a/docs/generated/packages/nx/documents/run.md +++ b/docs/generated/packages/nx/documents/run.md @@ -81,5 +81,6 @@ Run's a target named build:test for the myapp project. Note the quotes around th | `--project` | string | Target project. | | `--runner` | string | This is the name of the tasks runner configured in nx.json. | | `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) | +| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) | | `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | | `--version` | boolean | Show version number. | diff --git a/packages/nx/src/command-line/yargs-utils/shared-options.ts b/packages/nx/src/command-line/yargs-utils/shared-options.ts index 6d0247b60b126..0dcb210724298 100644 --- a/packages/nx/src/command-line/yargs-utils/shared-options.ts +++ b/packages/nx/src/command-line/yargs-utils/shared-options.ts @@ -96,9 +96,9 @@ export function withRunOptions(yargs: Argv): Argv { default: false, }) .option('skipSync', { + describe: 'Skips running the sync generators associated with the tasks.', type: 'boolean', - // TODO(leo): add description and make it visible once it is stable - hidden: true, + default: false, }) .options('cloud', { type: 'boolean',