feat(tools): enable multiple package migration via --name option (mic…

…rosoft#20583) * feat(tools): enable multiple package migration via --name option * Update tools/generators/migrate-converged-pkg/index.ts Co-authored-by: Elizabeth Craig <[email protected]> * Update tools/generators/migrate-converged-pkg/schema.ts Co-authored-by: Peter Varholak <[email protected]> * feat(tools): create overriden getProjects function that enables filtering Co-authored-by: Elizabeth Craig <[email protected]> Co-authored-by: Peter Varholak <[email protected]>
mlp73 · Jan 17, 2022 · 1558bf5 · 1558bf5
1 parent 1ec635c
commit 1558bf5
Show file tree

Hide file tree

Showing 7 changed files with 103 additions and 20 deletions.
diff --git a/tools/generators/migrate-converged-pkg/README.md b/tools/generators/migrate-converged-pkg/README.md
@@ -14,8 +14,6 @@ Workspace Generator for migrating converged packages to new DX (stage 1)[https:/
 
 <!-- tocstop -->
 
-## NOTES
-
 ## Usage
 
 ```sh
@@ -60,6 +58,18 @@ Package/library name (needs to be full name of the package, scope included - e.g
 
 > NOTE: will trigger CLI prompt if you didn't provide this option
 
+**Run migration on subset of packages:**
+
+To run migration on multiple packages you can specify a comma separated list of project names.
+
+```sh
+# run migration on:
+# - @fluentui/lib-zero
+# - @fluentui/lib-one
+# - @fluentui/lib-two
+yarn nx workspace-generator migrate-converged-pkg --name='@fluentui/lib-zero,@fluentui/lib-one,@fluentui/lib-two'
+```
+
 #### `all`
 
 Type: `boolean`

diff --git a/tools/generators/migrate-converged-pkg/index.spec.ts b/tools/generators/migrate-converged-pkg/index.spec.ts
@@ -1138,6 +1138,29 @@ describe('migrate-converged-pkg generator', () => {
       expect(configs['@proj/react-old'].sourceRoot).not.toBeDefined();
     });
   });
+
+  describe(`--name`, () => {
+    it(`should accept comma separated string to exec on multiple projects`, async () => {
+      const projects = [options.name, '@proj/react-one', '@proj/react-two', '@proj/react-old'] as const;
+
+      setupDummyPackage(tree, { name: projects[1], version: '9.0.22' });
+      setupDummyPackage(tree, { name: projects[2], version: '9.0.31' });
+      setupDummyPackage(tree, { name: projects[3], version: '8.0.1' });
+
+      await generator(tree, { name: `${projects[0]},${projects[1]}` });
+
+      const configs = projects.reduce((acc, projectName) => {
+        acc[projectName] = readProjectConfiguration(tree, projectName);
+
+        return acc;
+      }, {} as Record<typeof projects[number], ReadProjectConfiguration>);
+
+      expect(configs[projects[0]].sourceRoot).toBeDefined();
+      expect(configs[projects[1]].sourceRoot).toBeDefined();
+      expect(configs[projects[2]].sourceRoot).not.toBeDefined();
+      expect(configs[projects[3]].sourceRoot).not.toBeDefined();
+    });
+  });
 });
 
 // ==== helpers ====

diff --git a/tools/generators/migrate-converged-pkg/index.ts b/tools/generators/migrate-converged-pkg/index.ts
@@ -6,7 +6,6 @@ import {
   readWorkspaceConfiguration,
   joinPathFragments,
   readJson,
-  getProjects,
   stripIndents,
   visitNotIgnoredFiles,
   logger,
@@ -18,7 +17,15 @@ import * as path from 'path';
 import * as os from 'os';
 
 import { PackageJson, TsConfig } from '../../types';
-import { arePromptsEnabled, getProjectConfig, printUserLogs, prompt, updateJestConfig, UserLog } from '../../utils';
+import {
+  arePromptsEnabled,
+  getProjectConfig,
+  getProjects,
+  printUserLogs,
+  prompt,
+  updateJestConfig,
+  UserLog,
+} from '../../utils';
 
 import { MigrateConvergedPkgGeneratorSchema } from './schema';
 
@@ -46,7 +53,13 @@ export default async function (tree: Tree, schema: MigrateConvergedPkgGeneratorS
   }
 
   if (hasSchemaFlag(validatedSchema, 'name')) {
-    runMigrationOnProject(tree, validatedSchema, userLog);
+    const projectNames = validatedSchema.name.split(',').filter(Boolean);
+
+    if (projectNames.length > 1) {
+      runBatchMigration(tree, userLog, projectNames);
+    } else {
+      runMigrationOnProject(tree, validatedSchema, userLog);
+    }
   }
 
   await formatFiles(tree);
@@ -56,11 +69,11 @@ export default async function (tree: Tree, schema: MigrateConvergedPkgGeneratorS
   };
 }
 
-function runBatchMigration(tree: Tree, userLog: UserLog) {
-  const projects = getProjects(tree);
+function runBatchMigration(tree: Tree, userLog: UserLog, projectNames?: string[]) {
+  const projects = getProjects(tree, projectNames);
 
-  projects.forEach((project, projectName) => {
-    if (!isPackageConverged(tree, project)) {
+  projects.forEach((projectConfig, projectName) => {
+    if (!isPackageConverged(tree, projectConfig)) {
       userLog.push({ type: 'error', message: `${projectName} is not converged package. Skipping migration...` });
       return;
     }
@@ -365,13 +378,17 @@ async function validateSchema(tree: Tree, schema: MigrateConvergedPkgGeneratorSc
   }
 
   if (newSchema.name) {
-    const projectConfig = readProjectConfiguration(tree, newSchema.name);
+    const projectNames = newSchema.name.split(',').filter(Boolean);
 
-    if (!isPackageConverged(tree, projectConfig)) {
-      throw new Error(
-        `${newSchema.name} is not converged package. Make sure to run the migration on packages with version 9.x.x`,
-      );
-    }
+    projectNames.forEach(projectName => {
+      const projectConfig = readProjectConfiguration(tree, projectName);
+
+      if (!isPackageConverged(tree, projectConfig)) {
+        throw new Error(
+          `${newSchema.name} is not converged package. Make sure to run the migration on packages with version 9.x.x`,
+        );
+      }
+    });
   }
 
   return newSchema;
@@ -382,7 +399,7 @@ async function triggerDynamicPrompts() {
 
   return prompt<PromptResponse>([
     {
-      message: 'Which converged package would you like migrate to new DX? (ex: @fluentui/react-menu)',
+      message: 'Which converged package(s) would you like migrate to new DX? (ex: @fluentui/react-menu)',
       type: 'input',
       name: 'name',
     },

diff --git a/tools/generators/migrate-converged-pkg/schema.json b/tools/generators/migrate-converged-pkg/schema.json
@@ -6,7 +6,7 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "Package name",
+      "description": "Library name or comma delimited library names to execute migration on multiple libraries.",
       "$default": {
         "$source": "argv",
         "index": 0

diff --git a/tools/generators/migrate-converged-pkg/schema.ts b/tools/generators/migrate-converged-pkg/schema.ts
@@ -1,6 +1,6 @@
 export interface MigrateConvergedPkgGeneratorSchema {
   /**
-   * Library name
+   * Library name or comma delimited library names to execute migration on multiple libraries.
    */
   name?: string;
   /**

diff --git a/tools/tsconfig.tools.json b/tools/tsconfig.tools.json
@@ -6,7 +6,8 @@
     "module": "commonjs",
     "target": "es5",
     "types": ["node"],
-    "importHelpers": false
+    "importHelpers": false,
+    "downlevelIteration": true
   },
   "exclude": ["**/*.spec.ts"],
   "include": ["**/*.ts"]

diff --git a/tools/utils.ts b/tools/utils.ts
@@ -1,6 +1,13 @@
 import * as yargsParser from 'yargs-parser';
 import type * as Enquirer from 'enquirer';
-import { joinPathFragments, logger, readProjectConfiguration, readWorkspaceConfiguration, Tree } from '@nrwl/devkit';
+import {
+  joinPathFragments,
+  logger,
+  readProjectConfiguration,
+  readWorkspaceConfiguration,
+  Tree,
+  getProjects as getAllProjects,
+} from '@nrwl/devkit';
 
 /**
  * CLI prompts abstraction to trigger dynamic prompts within a generator
@@ -119,3 +126,28 @@ export function printUserLogs(logs: UserLog) {
 
   logger.log(`${'='.repeat(80)}\n`);
 }
+
+/**
+ * Overridden `@nrwl/devkit#getProjects` function
+ * Get all workspace projects or only subset, if projectNames array is specified
+ *
+ * @param tree
+ * @param projectNames - array of project names. Use this to return only subset of projects
+ */
+export function getProjects(tree: Tree, projectNames?: string[]) {
+  const allProjects = getAllProjects(tree);
+
+  if (Array.isArray(projectNames) && projectNames.length > 0) {
+    const pickedProjects: ReturnType<typeof getAllProjects> = new Map();
+
+    for (const [projectName, projectConfig] of allProjects.entries()) {
+      if (projectNames.includes(projectName)) {
+        pickedProjects.set(projectName, projectConfig);
+      }
+    }
+
+    return pickedProjects;
+  }
+
+  return allProjects;
+}