fix(nx-dev): options of the affected are messed up (#28112)
Closes #27893 ## Current Behavior see #27893 ## Expected Behavior see #27893 ## Related Issue(s) see #27893 Fixes # - docs for affected --------- Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
This commit is contained in:
pawel-twardziak
GitHub
parent
621ac786a9
commit
4ed8e1ea36
@ -85,29 +85,26 @@ Print the task graph to the console:
|
|||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
| Option | Type | Description |
|
| Option | Type | Description |
|
||||||
| ----------- | ------- | ----------------------------------------- |
|
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead |
|
| ~~`--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. |
|
||||||
| `--base` | string | Base of the current branch (usually main). |
|
| `--exclude` | string | Exclude certain projects from being processed. |
|
||||||
| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) |
|
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) |
|
||||||
| `--configuration` | string | This is the configuration to use when performing tasks on projects. |
|
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
|
||||||
| `--exclude` | string | Exclude certain projects from being processed. |
|
| `--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. |
|
||||||
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) |
|
| `--head` | string | Latest commit of the current branch (usually HEAD). |
|
||||||
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
|
| `--help` | boolean | Show help. |
|
||||||
| `--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. |
|
| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) |
|
||||||
| `--head` | string | Latest commit of the current branch (usually HEAD). |
|
| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) |
|
||||||
| `--help` | boolean | Show help. |
|
| `--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. |
|
||||||
| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) |
|
| `--parallel` | string | Max number of parallel processes [default is 3]. |
|
||||||
| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) |
|
| `--runner` | string | This is the name of the tasks runner configured in nx.json. |
|
||||||
| `--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. |
|
| `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
||||||
| `--parallel` | string | Max number of parallel processes [default is 3]. |
|
| `--targets` | string | Tasks to run for affected projects. |
|
||||||
| `--runner` | string | This is the name of the tasks runner configured in nx.json. |
|
| `--uncommitted` | boolean | Uncommitted changes. |
|
||||||
| `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
| `--untracked` | boolean | Untracked changes. |
|
||||||
| `--targets` | string | Tasks to run for affected projects. |
|
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
||||||
| `--uncommitted` | boolean | Uncommitted changes. |
|
| `--version` | boolean | Show version number. |
|
||||||
| `--untracked` | boolean | Untracked changes. |
|
|
||||||
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
|
||||||
| `--version` | boolean | Show version number. |
|
|
||||||
|
|||||||
@ -85,29 +85,26 @@ Print the task graph to the console:
|
|||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
| Option | Type | Description |
|
| Option | Type | Description |
|
||||||
| ----------- | ------- | ----------------------------------------- |
|
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| ~~`--all`~~ | boolean | **Deprecated:** Use `nx run-many` instead |
|
| ~~`--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. |
|
||||||
| `--base` | string | Base of the current branch (usually main). |
|
| `--exclude` | string | Exclude certain projects from being processed. |
|
||||||
| `--batch` | boolean | Run task(s) in batches for executors which support batches. (Default: `false`) |
|
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) |
|
||||||
| `--configuration` | string | This is the configuration to use when performing tasks on projects. |
|
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
|
||||||
| `--exclude` | string | Exclude certain projects from being processed. |
|
| `--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. |
|
||||||
| `--excludeTaskDependencies` | boolean | Skips running dependent tasks first. (Default: `false`) |
|
| `--head` | string | Latest commit of the current branch (usually HEAD). |
|
||||||
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
|
| `--help` | boolean | Show help. |
|
||||||
| `--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. |
|
| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) |
|
||||||
| `--head` | string | Latest commit of the current branch (usually HEAD). |
|
| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) |
|
||||||
| `--help` | boolean | Show help. |
|
| `--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. |
|
||||||
| `--nxBail` | boolean | Stop command execution after the first failed task. (Default: `false`) |
|
| `--parallel` | string | Max number of parallel processes [default is 3]. |
|
||||||
| `--nxIgnoreCycles` | boolean | Ignore cycles in the task graph. (Default: `false`) |
|
| `--runner` | string | This is the name of the tasks runner configured in nx.json. |
|
||||||
| `--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. |
|
| `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
||||||
| `--parallel` | string | Max number of parallel processes [default is 3]. |
|
| `--targets` | string | Tasks to run for affected projects. |
|
||||||
| `--runner` | string | This is the name of the tasks runner configured in nx.json. |
|
| `--uncommitted` | boolean | Uncommitted changes. |
|
||||||
| `--skipNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
|
| `--untracked` | boolean | Untracked changes. |
|
||||||
| `--targets` | string | Tasks to run for affected projects. |
|
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
||||||
| `--uncommitted` | boolean | Uncommitted changes. |
|
| `--version` | boolean | Show version number. |
|
||||||
| `--untracked` | boolean | Untracked changes. |
|
|
||||||
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
|
|
||||||
| `--version` | boolean | Show version number. |
|
|
||||||
|
|||||||
@ -135,6 +135,9 @@ export function formatDescription(
|
|||||||
if (!deprecated) {
|
if (!deprecated) {
|
||||||
return description;
|
return description;
|
||||||
}
|
}
|
||||||
|
if (!description) {
|
||||||
|
return `${bold('Deprecated:')} ${deprecated}`;
|
||||||
|
}
|
||||||
return deprecated === true
|
return deprecated === true
|
||||||
? `${bold('Deprecated:')} ${description}`
|
? `${bold('Deprecated:')} ${description}`
|
||||||
: mdLines(`${bold('Deprecated:')} ${deprecated}`, description);
|
: mdLines(`${bold('Deprecated:')} ${deprecated}`, description);
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user