miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(nx-dev): show arg aliases (#29653)

Browse Source 
List aliases of command arguments
This commit is contained in:
Isaac Mann 2025-01-16 17:13:02 -05:00 committed by GitHub
parent 6d8fe5c5fe
commit 520706b10b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
19 changed files with 382 additions and 379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/generated/cli/affected.md
View File

@ -86,11 +86,11 @@ 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. |
| `--configuration`, `--c` | 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. |
@ -102,10 +102,10 @@ Print the task graph to the console:
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
| `--targets` | string | Tasks to run for affected projects. |
| `--targets`, `--target`, `--t` | 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). |

10
docs/generated/cli/create-nx-workspace.md
View File

@ -18,8 +18,8 @@ Install `create-nx-workspace` globally to invoke the command directly, or use `n
## Options
| Option | Type | Description |
| ------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--allPrompts` | boolean | Show all prompts. (Default: `false`) |
| -------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--allPrompts`, `--a` | boolean | Show all prompts. (Default: `false`) |
| `--appName` | string | The name of the app when using a monorepo with certain stacks. |
| `--bundler` | string | Bundler to be used to build the app. |
| `--commit.email` | string | E-mail of the committer. |
@ -35,12 +35,12 @@ Install `create-nx-workspace` globally to invoke the command directly, or use `n
| `--name` | string | Workspace name (e.g. org name). |
| `--nextAppDir` | boolean | Enable the App Router for Next.js. |
| `--nextSrcDir` | boolean | Generate a 'src/' directory for Next.js. |
| `--nxCloud` | `github`, `gitlab`, `azure`, `bitbucket-pipelines`, `circleci`, `skip`, `yes` | Which CI provider would you like to use? |
| `--packageManager` | `bun`, `npm`, `pnpm`, `yarn` | Package manager to use. (Default: `npm`) |
| `--nxCloud`, `--ci` | `github`, `gitlab`, `azure`, `bitbucket-pipelines`, `circleci`, `skip`, `yes` | Which CI provider would you like to use? |
| `--packageManager`, `--pm` | `bun`, `npm`, `pnpm`, `yarn` | Package manager to use. (Default: `npm`) |
| `--prefix` | string | Prefix to use for Angular component and directive selectors. |
| `--preset` | string | Customizes the initial content of your workspace. Default presets include: ["apps", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "vue-monorepo", "vue-standalone", "nuxt", "nuxt-standalone", "next", "nextjs-standalone", "remix-monorepo", "remix-standalone", "react-native", "expo", "nest", "express", "react", "vue", "angular", "node-standalone", "node-monorepo", "ts-standalone"]. To build your own see https://nx.dev/extending-nx/recipes/create-preset. |
| `--routing` | boolean | Add a routing setup for an Angular app. (Default: `true`) |
| `--skipGit` | boolean | Skip initializing a git repository. (Default: `false`) |
| `--skipGit`, `--g` | boolean | Skip initializing a git repository. (Default: `false`) |
| `--ssr` | boolean | Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application. |
| `--standaloneApi` | boolean | Use Standalone Components if generating an Angular app. (Default: `true`) |
| `--style` | string | Stylesheet type to be used with certain stacks. |

6
docs/generated/cli/import.md
View File

@ -18,13 +18,13 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
## Options
| Option | Type | Description |
| ------------------------ | ------- | --------------------------------------------------------------------------- |
| ----------------------------------------- | ------- | --------------------------------------------------------------------------- |
| `--depth` | number | The depth to clone the source repository (limit this for faster git clone). |
| `--destinationDirectory` | string | The directory in the current workspace to import into. |
| `--destinationDirectory`, `--destination` | string | The directory in the current workspace to import into. |
| `--help` | boolean | Show help. |
| `--interactive` | boolean | Interactive mode. (Default: `true`) |
| `--ref` | string | The branch from the source repository to import. |
| `--sourceDirectory` | string | The directory in the source repository to import from. |
| `--sourceDirectory`, `--source` | string | The directory in the source repository to import from. |
| `--sourceRepository` | string | The remote URL of the source to import. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |

2
docs/generated/cli/migrate.md
View File

@ -82,7 +82,7 @@ Create a dedicated commit for each successfully completed migration. You can cus
| Option | Type | Description |
| ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `--commitPrefix` | string | Commit prefix to apply to the commit for each migration, when --create-commits is enabled. (Default: `chore: [nx migration] `) |
| `--createCommits` | boolean | Automatically create a git commit after each migration runs. (Default: `false`) |
| `--createCommits`, `--C` | boolean | Automatically create a git commit after each migration runs. (Default: `false`) |
| `--excludeAppliedMigrations` | boolean | Exclude migrations that should have been applied on previous updates. To be used with --from. (Default: `false`) |
| `--from` | string | Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nx/react@16.0.0,@nx/js@16.0.0"). |
| `--help` | boolean | Show help. |

24
docs/generated/cli/release.md
View File

@ -18,12 +18,12 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
## Options
| Shared Option | Type | Description |
| --------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `--dry-run` | boolean | Preview the changes without updating files/creating releases. (Default: `false`) |
| `--groups` | string | One or more release groups to target with the current command. |
| ---------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `--dry-run`, `--d` | boolean | Preview the changes without updating files/creating releases. (Default: `false`) |
| `--groups`, `--group`, `--g` | string | One or more release groups to target with the current command. |
| `--help` | boolean | Show help. |
| `--printConfig` | string | Print the resolved nx release configuration that would be used for the current command and then exit. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
@ -46,7 +46,7 @@ nx release [specifier]
| `--skip-publish` | boolean | Skip publishing by automatically answering no to the confirmation prompt for publishing. |
| `--specifier` | string | Exact version or semver keyword to apply to the selected release group. |
| `--version` | boolean | Show version number. |
| `--yes` | boolean | Automatically answer yes to the confirmation prompt for publishing. |
| `--yes`, `--y` | boolean | Automatically answer yes to the confirmation prompt for publishing. |
### version
@ -98,7 +98,7 @@ nx release changelog [version]
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
| `--git-tag-message` | string | Custom git tag message to use when tagging the changes made by this command. This defaults to be the same value as the tag itself. |
| `--help` | boolean | Show help. |
| `--interactive` | `all`, `workspace`, `projects` | Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level. |
| `--interactive`, `--i` | `all`, `workspace`, `projects` | Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level. |
| `--stage-changes` | boolean | Whether or not to stage the changes made by this command. Always treated as true if git-commit is true. |
| `--to` | string | The git reference to use as the end of the changelog. (Default: `HEAD`) |
| `--version` | string | The version to create a Github release and changelog for. |
@ -114,7 +114,7 @@ nx release publish
## Options
| Option | Type | Description |
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--access` | `public`, `restricted` | Overrides the access level of the published package. Unscoped packages cannot be set to restricted. See the npm publish documentation for more information. |
| `--all` | boolean | [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required. (Default: `true`) |
| `--exclude` | string | Exclude certain projects from being processed. |
@ -127,11 +127,11 @@ nx release publish
| `--otp` | number | A one-time password for publishing to a registry that requires 2FA. |
| `--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]. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote 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). |
@ -148,14 +148,14 @@ nx release plan [bump]
## Options
| Option | Type | Description |
| --------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `--base` | string | Base of the current branch (usually main). |
| `--bump` | `major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, `prerelease` | Semver keyword to use for the selected release group. |
| `--exclude` | string | Exclude certain projects from being processed. |
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
| `--head` | string | Latest commit of the current branch (usually HEAD). |
| `--help` | boolean | Show help. |
| `--message` | string | Custom message to use for the changelog entry. |
| `--message`, `--m` | string | Custom message to use for the changelog entry. |
| `--onlyTouched` | boolean | Only include projects that have been affected by the current changes. (Default: `true`) |
| `--uncommitted` | boolean | Uncommitted changes. |
| `--untracked` | boolean | Untracked changes. |

12
docs/generated/cli/run-many.md
View File

@ -92,10 +92,10 @@ Print the task graph to the console:
## Options
| Option | Type | Description |
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--all` | boolean | [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required. (Default: `true`) |
| `--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. |
| `--configuration`, `--c` | 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`) |
| `--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. |
@ -104,11 +104,11 @@ Print the task graph to the console:
| `--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]. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | 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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
| `--targets` | string | Tasks to run for affected projects. |
| `--targets`, `--target`, `--t` | string | Tasks to run for affected projects. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |

8
docs/generated/cli/run.md
View File

@ -68,9 +68,9 @@ Run's a target named build:test for the myapp project. Note the quotes around th
## Options
| Option | Type | Description |
| --------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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. |
| `--configuration`, `--c` | 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`) |
| `--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. |
@ -80,8 +80,8 @@ Run's a target named build:test for the myapp project. Note the quotes around th
| `--parallel` | string | Max number of parallel processes [default is 3]. |
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote 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. |

10
docs/generated/cli/show.md
View File

@ -104,21 +104,21 @@ nx show projects
## Options
| Option | Type | Description |
| --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| --------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `--affected` | boolean | Show only affected projects. |
| `--base` | string | Base of the current branch (usually main). |
| `--exclude` | string | Exclude certain projects from being processed. |
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
| `--head` | string | Latest commit of the current branch (usually HEAD). |
| `--help` | boolean | Show help. |
| `--projects` | string | Show only projects that match a given pattern. |
| `--projects`, `--p` | string | Show only projects that match a given pattern. |
| `--sep` | string | Outputs projects with the specified seperator. |
| `--type` | `app`, `lib`, `e2e` | Select only projects of the given type. |
| `--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. |
| `--withTarget` | string | Show only projects that have a specific target. |
| `--withTarget`, `--t` | string | Show only projects that have a specific target. |
### project
@ -131,10 +131,10 @@ nx show project <projectName>
## Options
| Option | Type | Description |
| --------------- | ------- | ---------------------------------------------------------------------- |
| ---------------------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--open` | boolean | Set to false to prevent the browser from opening when using --web. |
| `--projectName` | string | Which project should be viewed?. |
| `--projectName`, `--p` | string | Which project should be viewed?. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
| `--web` | boolean | Show project details in the browser. (default when interactive). |

6
docs/generated/cli/watch.md
View File

@ -38,10 +38,10 @@ Watch all projects (including newly created projects) in the workspace:
## Options
| Option | Type | Description |
| ---------------------------- | ------- | --------------------------------------------------------------------------- |
| ----------------------------------- | ------- | --------------------------------------------------------------------------- |
| `--all` | boolean | Watch all projects. |
| `--help` | boolean | Show help. |
| `--includeDependentProjects` | boolean | When watching selected projects, include dependent projects as well. |
| `--projects` | string | Projects to watch (comma/space delimited). |
| `--includeDependentProjects`, `--d` | boolean | When watching selected projects, include dependent projects as well. |
| `--projects`, `--p` | string | Projects to watch (comma/space delimited). |
| `--verbose` | boolean | Run watch mode in verbose mode, where commands are logged before execution. |
| `--version` | boolean | Show version number. |

10
docs/generated/packages/nx/documents/affected.md
View File

@ -86,11 +86,11 @@ 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. |
| `--configuration`, `--c` | 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. |
@ -102,10 +102,10 @@ Print the task graph to the console:
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
| `--targets` | string | Tasks to run for affected projects. |
| `--targets`, `--target`, `--t` | 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). |

10
docs/generated/packages/nx/documents/create-nx-workspace.md
View File

@ -18,8 +18,8 @@ Install `create-nx-workspace` globally to invoke the command directly, or use `n
## Options
| Option | Type | Description |
| ------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--allPrompts` | boolean | Show all prompts. (Default: `false`) |
| -------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--allPrompts`, `--a` | boolean | Show all prompts. (Default: `false`) |
| `--appName` | string | The name of the app when using a monorepo with certain stacks. |
| `--bundler` | string | Bundler to be used to build the app. |
| `--commit.email` | string | E-mail of the committer. |
@ -35,12 +35,12 @@ Install `create-nx-workspace` globally to invoke the command directly, or use `n
| `--name` | string | Workspace name (e.g. org name). |
| `--nextAppDir` | boolean | Enable the App Router for Next.js. |
| `--nextSrcDir` | boolean | Generate a 'src/' directory for Next.js. |
| `--nxCloud` | `github`, `gitlab`, `azure`, `bitbucket-pipelines`, `circleci`, `skip`, `yes` | Which CI provider would you like to use? |
| `--packageManager` | `bun`, `npm`, `pnpm`, `yarn` | Package manager to use. (Default: `npm`) |
| `--nxCloud`, `--ci` | `github`, `gitlab`, `azure`, `bitbucket-pipelines`, `circleci`, `skip`, `yes` | Which CI provider would you like to use? |
| `--packageManager`, `--pm` | `bun`, `npm`, `pnpm`, `yarn` | Package manager to use. (Default: `npm`) |
| `--prefix` | string | Prefix to use for Angular component and directive selectors. |
| `--preset` | string | Customizes the initial content of your workspace. Default presets include: ["apps", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "vue-monorepo", "vue-standalone", "nuxt", "nuxt-standalone", "next", "nextjs-standalone", "remix-monorepo", "remix-standalone", "react-native", "expo", "nest", "express", "react", "vue", "angular", "node-standalone", "node-monorepo", "ts-standalone"]. To build your own see https://nx.dev/extending-nx/recipes/create-preset. |
| `--routing` | boolean | Add a routing setup for an Angular app. (Default: `true`) |
| `--skipGit` | boolean | Skip initializing a git repository. (Default: `false`) |
| `--skipGit`, `--g` | boolean | Skip initializing a git repository. (Default: `false`) |
| `--ssr` | boolean | Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application. |
| `--standaloneApi` | boolean | Use Standalone Components if generating an Angular app. (Default: `true`) |
| `--style` | string | Stylesheet type to be used with certain stacks. |

6
docs/generated/packages/nx/documents/import.md
View File

@ -18,13 +18,13 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
## Options
| Option | Type | Description |
| ------------------------ | ------- | --------------------------------------------------------------------------- |
| ----------------------------------------- | ------- | --------------------------------------------------------------------------- |
| `--depth` | number | The depth to clone the source repository (limit this for faster git clone). |
| `--destinationDirectory` | string | The directory in the current workspace to import into. |
| `--destinationDirectory`, `--destination` | string | The directory in the current workspace to import into. |
| `--help` | boolean | Show help. |
| `--interactive` | boolean | Interactive mode. (Default: `true`) |
| `--ref` | string | The branch from the source repository to import. |
| `--sourceDirectory` | string | The directory in the source repository to import from. |
| `--sourceDirectory`, `--source` | string | The directory in the source repository to import from. |
| `--sourceRepository` | string | The remote URL of the source to import. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |

2
docs/generated/packages/nx/documents/migrate.md
View File

@ -82,7 +82,7 @@ Create a dedicated commit for each successfully completed migration. You can cus
| Option | Type | Description |
| ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `--commitPrefix` | string | Commit prefix to apply to the commit for each migration, when --create-commits is enabled. (Default: `chore: [nx migration] `) |
| `--createCommits` | boolean | Automatically create a git commit after each migration runs. (Default: `false`) |
| `--createCommits`, `--C` | boolean | Automatically create a git commit after each migration runs. (Default: `false`) |
| `--excludeAppliedMigrations` | boolean | Exclude migrations that should have been applied on previous updates. To be used with --from. (Default: `false`) |
| `--from` | string | Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nx/react@16.0.0,@nx/js@16.0.0"). |
| `--help` | boolean | Show help. |

24
docs/generated/packages/nx/documents/release.md
View File

@ -18,12 +18,12 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
## Options
| Shared Option | Type | Description |
| --------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `--dry-run` | boolean | Preview the changes without updating files/creating releases. (Default: `false`) |
| `--groups` | string | One or more release groups to target with the current command. |
| ---------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `--dry-run`, `--d` | boolean | Preview the changes without updating files/creating releases. (Default: `false`) |
| `--groups`, `--group`, `--g` | string | One or more release groups to target with the current command. |
| `--help` | boolean | Show help. |
| `--printConfig` | string | Print the resolved nx release configuration that would be used for the current command and then exit. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
@ -46,7 +46,7 @@ nx release [specifier]
| `--skip-publish` | boolean | Skip publishing by automatically answering no to the confirmation prompt for publishing. |
| `--specifier` | string | Exact version or semver keyword to apply to the selected release group. |
| `--version` | boolean | Show version number. |
| `--yes` | boolean | Automatically answer yes to the confirmation prompt for publishing. |
| `--yes`, `--y` | boolean | Automatically answer yes to the confirmation prompt for publishing. |
### version
@ -98,7 +98,7 @@ nx release changelog [version]
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
| `--git-tag-message` | string | Custom git tag message to use when tagging the changes made by this command. This defaults to be the same value as the tag itself. |
| `--help` | boolean | Show help. |
| `--interactive` | `all`, `workspace`, `projects` | Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level. |
| `--interactive`, `--i` | `all`, `workspace`, `projects` | Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level. |
| `--stage-changes` | boolean | Whether or not to stage the changes made by this command. Always treated as true if git-commit is true. |
| `--to` | string | The git reference to use as the end of the changelog. (Default: `HEAD`) |
| `--version` | string | The version to create a Github release and changelog for. |
@ -114,7 +114,7 @@ nx release publish
## Options
| Option | Type | Description |
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--access` | `public`, `restricted` | Overrides the access level of the published package. Unscoped packages cannot be set to restricted. See the npm publish documentation for more information. |
| `--all` | boolean | [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required. (Default: `true`) |
| `--exclude` | string | Exclude certain projects from being processed. |
@ -127,11 +127,11 @@ nx release publish
| `--otp` | number | A one-time password for publishing to a registry that requires 2FA. |
| `--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]. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote 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). |
@ -148,14 +148,14 @@ nx release plan [bump]
## Options
| Option | Type | Description |
| --------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `--base` | string | Base of the current branch (usually main). |
| `--bump` | `major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, `prerelease` | Semver keyword to use for the selected release group. |
| `--exclude` | string | Exclude certain projects from being processed. |
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
| `--head` | string | Latest commit of the current branch (usually HEAD). |
| `--help` | boolean | Show help. |
| `--message` | string | Custom message to use for the changelog entry. |
| `--message`, `--m` | string | Custom message to use for the changelog entry. |
| `--onlyTouched` | boolean | Only include projects that have been affected by the current changes. (Default: `true`) |
| `--uncommitted` | boolean | Uncommitted changes. |
| `--untracked` | boolean | Untracked changes. |

12
docs/generated/packages/nx/documents/run-many.md
View File

@ -92,10 +92,10 @@ Print the task graph to the console:
## Options
| Option | Type | Description |
| --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--all` | boolean | [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required. (Default: `true`) |
| `--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. |
| `--configuration`, `--c` | 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`) |
| `--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. |
@ -104,11 +104,11 @@ Print the task graph to the console:
| `--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]. |
| `--projects` | string | Projects to run. (comma/space delimited project names and/or patterns). |
| `--projects`, `--p` | 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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipSync` | boolean | Skips running the sync generators associated with the tasks. (Default: `false`) |
| `--targets` | string | Tasks to run for affected projects. |
| `--targets`, `--target`, `--t` | string | Tasks to run for affected projects. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |

8
docs/generated/packages/nx/documents/run.md
View File

@ -68,9 +68,9 @@ Run's a target named build:test for the myapp project. Note the quotes around th
## Options
| Option | Type | Description |
| --------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--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. |
| `--configuration`, `--c` | 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`) |
| `--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. |
@ -80,8 +80,8 @@ Run's a target named build:test for the myapp project. Note the quotes around th
| `--parallel` | string | Max number of parallel processes [default is 3]. |
| `--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`) |
| `--skipRemoteCache` | boolean | Disables the remote cache. (Default: `false`) |
| `--skipNxCache`, `--disableNxCache` | boolean | Rerun the tasks even when the results are available in the cache. (Default: `false`) |
| `--skipRemoteCache`, `--disableRemoteCache` | boolean | Disables the remote 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. |

10
docs/generated/packages/nx/documents/show.md
View File

@ -104,21 +104,21 @@ nx show projects
## Options
| Option | Type | Description |
| --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| --------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `--affected` | boolean | Show only affected projects. |
| `--base` | string | Base of the current branch (usually main). |
| `--exclude` | string | Exclude certain projects from being processed. |
| `--files` | string | Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces. |
| `--head` | string | Latest commit of the current branch (usually HEAD). |
| `--help` | boolean | Show help. |
| `--projects` | string | Show only projects that match a given pattern. |
| `--projects`, `--p` | string | Show only projects that match a given pattern. |
| `--sep` | string | Outputs projects with the specified seperator. |
| `--type` | `app`, `lib`, `e2e` | Select only projects of the given type. |
| `--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. |
| `--withTarget` | string | Show only projects that have a specific target. |
| `--withTarget`, `--t` | string | Show only projects that have a specific target. |
### project
@ -131,10 +131,10 @@ nx show project <projectName>
## Options
| Option | Type | Description |
| --------------- | ------- | ---------------------------------------------------------------------- |
| ---------------------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--open` | boolean | Set to false to prevent the browser from opening when using --web. |
| `--projectName` | string | Which project should be viewed?. |
| `--projectName`, `--p` | string | Which project should be viewed?. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
| `--web` | boolean | Show project details in the browser. (default when interactive). |

6
docs/generated/packages/nx/documents/watch.md
View File

@ -38,10 +38,10 @@ Watch all projects (including newly created projects) in the workspace:
## Options
| Option | Type | Description |
| ---------------------------- | ------- | --------------------------------------------------------------------------- |
| ----------------------------------- | ------- | --------------------------------------------------------------------------- |
| `--all` | boolean | Watch all projects. |
| `--help` | boolean | Show help. |
| `--includeDependentProjects` | boolean | When watching selected projects, include dependent projects as well. |
| `--projects` | string | Projects to watch (comma/space delimited). |
| `--includeDependentProjects`, `--d` | boolean | When watching selected projects, include dependent projects as well. |
| `--projects`, `--p` | string | Projects to watch (comma/space delimited). |
| `--verbose` | boolean | Run watch mode in verbose mode, where commands are logged before execution. |
| `--version` | boolean | Show version number. |

17
scripts/documentation/utils.ts
View File

@ -151,7 +151,7 @@ export function getCommands(command: any) {
}
export interface ParsedCommandOption {
name: string;
name: string[];
type: string;
description: string;
default: string;
@ -231,7 +231,7 @@ export async function parseCommand(
deprecated: command.deprecated,
options:
Object.keys(builderDescriptions).map((key) => ({
name: key,
name: [key, ...(builderOptions.alias[key] || [])],
description: builderDescriptions[key]
? builderDescriptions[key].replace('__yargsString__:', '')
: '',
@ -259,12 +259,15 @@ export function generateOptionsMarkdown(
];
if (Array.isArray(command.options) && !!command.options.length) {
command.options
.sort((a, b) => sortAlphabeticallyFunction(a.name, b.name))
.sort((a, b) => sortAlphabeticallyFunction(a.name[0], b.name[0]))
.filter(({ hidden }) => !hidden)
.forEach((option) => {
function nameAliases(aliases) {
return aliases.map((alias) => code('--' + alias)).join(', ');
}
const name = option.deprecated
? strikethrough(code('--' + option.name))
: code('--' + option.name);
? strikethrough(nameAliases(option.name))
: nameAliases(option.name);
let description = formatDescription(
option.description,
option.deprecated
@ -282,9 +285,9 @@ export function generateOptionsMarkdown(
)}\`)`;
}
if (
(option.name === 'version' &&
(option.name[0] === 'version' &&
option.description === 'Show version number') ||
(option.name === 'help' && option.description === 'Show help')
(option.name[0] === 'help' && option.description === 'Show help')
) {
// Add . to the end of the built-in description for consistency with our other descriptions
description = `${description}.`;