From b8bc4609e1311e5c1c9e10277c67cfe0994e1fba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josh=20Goldberg=20=E2=9C=A8?= Date: Thu, 7 Sep 2023 10:04:40 -0400 Subject: [PATCH] docs(core): add more to repair's command-object describe (#18602) Co-authored-by: Isaac Mann Co-authored-by: Isaac Mann --- docs/generated/cli/repair.md | 19 ++++++++++++++++++- .../generated/packages/nx/documents/repair.md | 19 ++++++++++++++++++- .../src/command-line/repair/command-object.ts | 11 ++++++++++- 3 files changed, 46 insertions(+), 3 deletions(-) diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md index ec8253216a..e022cc9a76 100644 --- a/docs/generated/cli/repair.md +++ b/docs/generated/cli/repair.md @@ -1,12 +1,29 @@ --- 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 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 ```shell diff --git a/docs/generated/packages/nx/documents/repair.md b/docs/generated/packages/nx/documents/repair.md index ec8253216a..e022cc9a76 100644 --- a/docs/generated/packages/nx/documents/repair.md +++ b/docs/generated/packages/nx/documents/repair.md @@ -1,12 +1,29 @@ --- 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 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 ```shell diff --git a/packages/nx/src/command-line/repair/command-object.ts b/packages/nx/src/command-line/repair/command-object.ts index 68531c6652..1fec2ead98 100644 --- a/packages/nx/src/command-line/repair/command-object.ts +++ b/packages/nx/src/command-line/repair/command-object.ts @@ -3,7 +3,16 @@ import { linkToNxDevAndExamples } from '../yargs-utils/documentation'; export const yargsRepairCommand: CommandModule = { 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) => linkToNxDevAndExamples(yargs, 'repair').option('verbose', { type: 'boolean',