From c4eba565fde25beaa9e4637806ce26b3f4da1141 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Twardziak?= Date: Wed, 25 Sep 2024 20:48:55 +0200 Subject: [PATCH 1/2] fix(nx-dev): options of the affected are messed up Closes #27893 --- docs/generated/cli/affected.md | 49 +++++++++---------- .../packages/nx/documents/affected.md | 49 +++++++++---------- 2 files changed, 46 insertions(+), 52 deletions(-) diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md index 681c1510b36b5..3be4ed2e1554c 100644 --- a/docs/generated/cli/affected.md +++ b/docs/generated/cli/affected.md @@ -85,29 +85,26 @@ Print the task graph to the console: ## Options -| Option | Type | Description | -| ----------- | ------- | ----------------------------------------- | -| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead | - - | - -| `--base` | string | Base of the current branch (usually main). | -| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) | -| `--configuration` | string | This is the configuration to use when performing tasks on projects. | -| `--exclude` | string | Exclude certain projects from being processed. | -| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) | -| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. | -| `--graph` | string | Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. | -| `--head` | string | Latest commit of the current branch (usually HEAD). | -| `--help` | boolean | Show help. | -| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) | -| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) | -| `--output-style` | `dynamic`, `static`, `stream`, `stream-without-prefixes` | Defines how Nx emits outputs tasks logs. **dynamic**: use dynamic output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended on your local development environments. **static**: uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. **stream**: nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr. **stream-without-prefixes**: nx prefixes the project name the target is running on, use this option remove the project name prefix from output. | -| `--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`) | -| `--targets` | string | Tasks to run for affected projects. | -| `--uncommitted` | boolean | Uncommitted changes. | -| `--untracked` | boolean | Untracked changes. | -| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | -| `--version` | boolean | Show version number. | +| Option | Type | Description | +| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead | +| `--base` | string | Base of the current branch (usually main). | +| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) | +| `--configuration` | string | This is the configuration to use when performing tasks on projects. | +| `--exclude` | string | Exclude certain projects from being processed. | +| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) | +| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. | +| `--graph` | string | Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. | +| `--head` | string | Latest commit of the current branch (usually HEAD). | +| `--help` | boolean | Show help. | +| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) | +| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) | +| `--output-style` | `dynamic`, `static`, `stream`, `stream-without-prefixes` | Defines how Nx emits outputs tasks logs. **dynamic**: use dynamic output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended on your local development environments. **static**: uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. **stream**: nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr. **stream-without-prefixes**: nx prefixes the project name the target is running on, use this option remove the project name prefix from output. | +| `--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`) | +| `--targets` | string | Tasks to run for affected projects. | +| `--uncommitted` | boolean | Uncommitted changes. | +| `--untracked` | boolean | Untracked changes. | +| `--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 681c1510b36b5..3be4ed2e1554c 100644 --- a/docs/generated/packages/nx/documents/affected.md +++ b/docs/generated/packages/nx/documents/affected.md @@ -85,29 +85,26 @@ Print the task graph to the console: ## Options -| Option | Type | Description | -| ----------- | ------- | ----------------------------------------- | -| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead | - - | - -| `--base` | string | Base of the current branch (usually main). | -| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) | -| `--configuration` | string | This is the configuration to use when performing tasks on projects. | -| `--exclude` | string | Exclude certain projects from being processed. | -| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) | -| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. | -| `--graph` | string | Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. | -| `--head` | string | Latest commit of the current branch (usually HEAD). | -| `--help` | boolean | Show help. | -| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) | -| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) | -| `--output-style` | `dynamic`, `static`, `stream`, `stream-without-prefixes` | Defines how Nx emits outputs tasks logs. **dynamic**: use dynamic output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended on your local development environments. **static**: uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. **stream**: nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr. **stream-without-prefixes**: nx prefixes the project name the target is running on, use this option remove the project name prefix from output. | -| `--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`) | -| `--targets` | string | Tasks to run for affected projects. | -| `--uncommitted` | boolean | Uncommitted changes. | -| `--untracked` | boolean | Untracked changes. | -| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | -| `--version` | boolean | Show version number. | +| Option | Type | Description | +| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead | +| `--base` | string | Base of the current branch (usually main). | +| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) | +| `--configuration` | string | This is the configuration to use when performing tasks on projects. | +| `--exclude` | string | Exclude certain projects from being processed. | +| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) | +| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. | +| `--graph` | string | Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. | +| `--head` | string | Latest commit of the current branch (usually HEAD). | +| `--help` | boolean | Show help. | +| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) | +| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) | +| `--output-style` | `dynamic`, `static`, `stream`, `stream-without-prefixes` | Defines how Nx emits outputs tasks logs. **dynamic**: use dynamic output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended on your local development environments. **static**: uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. **stream**: nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr. **stream-without-prefixes**: nx prefixes the project name the target is running on, use this option remove the project name prefix from output. | +| `--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`) | +| `--targets` | string | Tasks to run for affected projects. | +| `--uncommitted` | boolean | Uncommitted changes. | +| `--untracked` | boolean | Untracked changes. | +| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). | +| `--version` | boolean | Show version number. | From 2506d41c47ecb2ca3eed6afc91d7351ec18576d0 Mon Sep 17 00:00:00 2001 From: Isaac Mann Date: Thu, 26 Sep 2024 07:24:04 -0400 Subject: [PATCH 2/2] fix(nx-dev): dont break option tables --- scripts/documentation/utils.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/documentation/utils.ts b/scripts/documentation/utils.ts index 7a9337ccbfafe..08277633b4ed3 100644 --- a/scripts/documentation/utils.ts +++ b/scripts/documentation/utils.ts @@ -135,6 +135,9 @@ export function formatDescription( if (!deprecated) { return description; } + if (!description) { + return `${bold('Deprecated:')} ${deprecated}`; + } return deprecated === true ? `${bold('Deprecated:')} ${description}` : mdLines(`${bold('Deprecated:')} ${deprecated}`, description);