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

docs(core): add more to repair's command-object describe (#18602)

Browse Source 
Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
This commit is contained in:
Josh Goldberg ✨ 2023-09-07 10:04:40 -04:00 committed by GitHub
parent 2cc40a1f32
commit b8bc4609e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/generated/cli/repair.md
View File

@ -1,12 +1,29 @@
--- ---
title: 'repair - CLI command' title: 'repair - CLI command'
description: 'Repair any configuration that is no longer supported by Nx.' description: 'Repair any configuration that is no longer supported by Nx.
Specifically, this will run every migration within the `nx` package
against the current repository. Doing so should fix any configuration
details left behind if the repository was previously updated to a new
Nx version without using `nx migrate`.
If your repository has only ever updated to newer versions of Nx with
`nx migrate`, running `nx repair` should do nothing.
'
--- ---
# repair # repair
Repair any configuration that is no longer supported by Nx. Repair any configuration that is no longer supported by Nx.
Specifically, this will run every migration within the `nx` package
against the current repository. Doing so should fix any configuration
details left behind if the repository was previously updated to a new
Nx version without using `nx migrate`.
If your repository has only ever updated to newer versions of Nx with
`nx migrate`, running `nx repair` should do nothing.
## Usage ## Usage
```shell ```shell

19
docs/generated/packages/nx/documents/repair.md
View File

@ -1,12 +1,29 @@
--- ---
title: 'repair - CLI command' title: 'repair - CLI command'
description: 'Repair any configuration that is no longer supported by Nx.' description: 'Repair any configuration that is no longer supported by Nx.
Specifically, this will run every migration within the `nx` package
against the current repository. Doing so should fix any configuration
details left behind if the repository was previously updated to a new
Nx version without using `nx migrate`.
If your repository has only ever updated to newer versions of Nx with
`nx migrate`, running `nx repair` should do nothing.
'
--- ---
# repair # repair
Repair any configuration that is no longer supported by Nx. Repair any configuration that is no longer supported by Nx.
Specifically, this will run every migration within the `nx` package
against the current repository. Doing so should fix any configuration
details left behind if the repository was previously updated to a new
Nx version without using `nx migrate`.
If your repository has only ever updated to newer versions of Nx with
`nx migrate`, running `nx repair` should do nothing.
## Usage ## Usage
```shell ```shell

11
packages/nx/src/command-line/repair/command-object.ts
View File

@ -3,7 +3,16 @@ import { linkToNxDevAndExamples } from '../yargs-utils/documentation';
export const yargsRepairCommand: CommandModule = { export const yargsRepairCommand: CommandModule = {
command: 'repair', command: 'repair',
describe: 'Repair any configuration that is no longer supported by Nx.', describe: `Repair any configuration that is no longer supported by Nx.
Specifically, this will run every migration within the \`nx\` package
against the current repository. Doing so should fix any configuration
details left behind if the repository was previously updated to a new
Nx version without using \`nx migrate\`.
If your repository has only ever updated to newer versions of Nx with
\`nx migrate\`, running \`nx repair\` should do nothing.
`,
builder: (yargs) => builder: (yargs) =>
linkToNxDevAndExamples(yargs, 'repair').option('verbose', { linkToNxDevAndExamples(yargs, 'repair').option('verbose', {
type: 'boolean', type: 'boolean',