feat(misc): implement nx repair and prettify migrate output (nrwl#11288)

prawnsalad · Jul 26, 2022 · 3c2ad25 · 3c2ad25
1 parent f2222ff
commit 3c2ad25
Show file tree

Hide file tree

Showing 17 changed files with 242 additions and 95 deletions.
diff --git a/docs/generated/cli/affected-apps.md b/docs/generated/cli/affected-apps.md
@@ -141,6 +141,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/affected-graph.md b/docs/generated/cli/affected-graph.md
@@ -191,6 +191,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/affected-libs.md b/docs/generated/cli/affected-libs.md
@@ -141,6 +141,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md
@@ -173,6 +173,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/format-check.md b/docs/generated/cli/format-check.md
@@ -127,6 +127,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/format-write.md b/docs/generated/cli/format-write.md
@@ -127,6 +127,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/print-affected.md b/docs/generated/cli/print-affected.md
@@ -161,6 +161,8 @@ Untracked changes
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md
@@ -0,0 +1,36 @@
+---
+title: 'repair - CLI command'
+description: 'Repair any configuration that is no longer supported by Nx.'
+---
+
+# repair
+
+Repair any configuration that is no longer supported by Nx.
+
+## Usage
+
+```bash
+nx repair
+```
+
+[Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.
+
+## Options
+
+### help
+
+Type: boolean
+
+Show help
+
+### verbose
+
+Type: boolean
+
+Print additional error stack trace on failure
+
+### version
+
+Type: boolean
+
+Show version number
diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md
@@ -133,6 +133,8 @@ Task to run for affected projects
 
 ### verbose
 
+Type: boolean
+
 Print additional error stack trace on failure
 
 ### version

diff --git a/docs/generated/packages/nx.json b/docs/generated/packages/nx.json
diff --git a/docs/map.json b/docs/map.json
@@ -921,7 +921,12 @@
             "id": "connect-to-nx-cloud",
             "file": "generated/cli/connect-to-nx-cloud"
           },
-          { "name": "reset", "id": "reset", "file": "generated/cli/reset" }
+          { "name": "reset", "id": "reset", "file": "generated/cli/reset" },
+          {
+            "name": "repair",
+            "id": "repair",
+            "file": "generated/cli/repair"
+          }
         ]
       },
       {

diff --git a/packages/nx/src/adapter/ngcli-adapter.ts b/packages/nx/src/adapter/ngcli-adapter.ts
@@ -99,7 +99,7 @@ function createWorkflow(
   fsHost: virtualFs.Host<Stats>,
   root: string,
   opts: any
-) {
+): import('@angular-devkit/schematics/tools').NodeWorkflow {
   const NodeWorkflow = require('@angular-devkit/schematics/tools').NodeWorkflow;
   const workflow = new NodeWorkflow(fsHost, {
     force: false,
@@ -880,7 +880,11 @@ export async function runMigration(
   const fsHost = new NxScopedHost(root);
   const workflow = createWorkflow(fsHost, root, {});
   const collection = resolveMigrationsCollection(packageName);
-  return workflow
+
+  const record = { loggingQueue: [] as string[], error: false };
+  workflow.reporter.subscribe(await createRecorder(fsHost, record, logger));
+
+  await workflow
     .execute({
       collection,
       schematic: migrationName,
@@ -889,6 +893,11 @@ export async function runMigration(
       logger: logger as any,
     })
     .toPromise();
+
+  return {
+    loggingQueue: record.loggingQueue,
+    madeChanges: record.loggingQueue.length > 0,
+  };
 }
 
 function resolveMigrationsCollection(name: string): string {
@@ -1094,8 +1103,8 @@ export function wrapAngularDevkitSchematic(
 
     // used for testing
     if (collectionResolutionOverrides) {
-      const r = workflow.engineHost.resolve;
-      workflow.engineHost.resolve = (collection, b, c) => {
+      const r = (workflow.engineHost as any).resolve;
+      (workflow.engineHost as any).resolve = (collection, b, c) => {
         if (collectionResolutionOverrides[collection]) {
           return collectionResolutionOverrides[collection];
         } else {

diff --git a/packages/nx/src/command-line/generate.ts b/packages/nx/src/command-line/generate.ts
@@ -29,7 +29,7 @@ export interface GenerateOptions {
   defaults: boolean;
 }
 
-function printChanges(fileChanges: FileChange[]) {
+export function printChanges(fileChanges: FileChange[]) {
   fileChanges.forEach((f) => {
     if (f.type === 'CREATE') {
       console.log(`${chalk.green('CREATE')} ${f.path}`);