feat(upgrade): run migrations from upgrade cli

lerna.json

@@ -6,7 +6,6 @@
   "useWorkspaces": true,
   "ignoreChanges": [
     "actions/**",
-    "codemods/**",
     "**/__fixtures__/**",
     "**/__tests__/**",
     "**/docs/**",

package.json

@@ -9,7 +9,6 @@
   },
   "workspaces": [
     "actions/*",
-    "codemods",
     "config/*",
     "packages/*",
     "www"
@@ -21,7 +20,7 @@
     "doctoc": "doctoc --title '## Table of Contents'",
     "format": "prettier --write '**/*.{js,md,scss,ts}' '!**/{build,es,lib,storybook,ts,umd}/**'",
     "format:diff": "prettier --list-different '**/*.{js,md,scss,ts}' '!**/{build,es,lib,storybook,ts,umd}/**' '!packages/components/**'",
-    "lint": "eslint actions config codemods packages www",
+    "lint": "eslint actions config packages www",
     "lint:styles": "stylelint '**/*.{css,scss}' --report-needless-disables --report-invalid-scope-disables",
     "sync": "carbon-cli sync",
     "test": "cross-env BABEL_ENV=test jest",

packages/upgrade/.gitignore

@@ -1,2 +1,2 @@
 # Generated by `esbuild` using `yarn build`
-/cli.js
+/cli.js

packages/upgrade/package.json

@@ -14,7 +14,8 @@
   "bugs": "https://github.com/carbon-design-system/carbon/issues",
   "files": [
     "bin",
-    "cli.js"
+    "cli.js",
+    "transforms"
   ],
   "keywords": [
     "carbon",
@@ -30,22 +31,20 @@
     "access": "public"
   },
   "scripts": {
-    "build": "esbuild src/cli.js --bundle --platform=node --outfile=cli.js --target=node14",
+    "build": "esbuild src/cli.js --bundle --platform=node --outfile=cli.js --target=node14 --external:jscodeshift",
     "clean": "rimraf cli.js",
     "watch": "yarn build --watch"
   },
   "devDependencies": {
     "chalk": "^4.1.1",
     "change-case": "^4.1.2",
-    "cross-spawn": "^7.0.3",
     "esbuild": "^0.14.10",
     "execa": "^5.1.1",
     "fast-glob": "^3.2.7",
     "fs-extra": "^10.0.0",
     "inquirer": "^8.1.0",
     "is-git-clean": "^1.1.0",
     "jest-diff": "^27.4.6",
-    "jscodeshift": "^0.13.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "memfs": "^3.4.0",
@@ -54,5 +53,8 @@
     "rimraf": "^3.0.2",
     "semver": "^7.3.5",
     "yargs": "^17.0.1"
+  },
+  "dependencies": {
+    "jscodeshift": "^0.13.1"
   }
 }

packages/upgrade/src/cli.js

@@ -8,6 +8,7 @@
 import chalk from 'chalk';
 import isGitClean from 'is-git-clean';
 import { upgrade } from './commands/upgrade';
+import { migrate } from './commands/migrate';
 import { UpgradeError } from './error';
 import { logger } from './logger';
 import { upgrades } from './upgrades';
@@ -42,8 +43,9 @@ export async function main({ argv, cwd }) {
       type: 'boolean',
     });
 
+  // $0: the default command
   cli.usage('Usage: $0 [options]').command(
-    '$0',
+    ['upgrade', '$0'],
     'upgrade your project',
     {},
     run(async (args) => {
@@ -57,14 +59,41 @@ export async function main({ argv, cwd }) {
     })
   );
 
+  cli.command(
+    'migrate <migration>',
+    'run a Carbon migration on your source files',
+    async (cli) => {
+      cli.command(
+        'list',
+        'list all migrations',
+        {},
+        run(async (args) => {
+          const { verbose } = args;
+          const options = { cwd: cwd(), verbose, list: true };
+          await migrate(options, upgrades);
+        }, true)
+      );
+    },
+    run(async (args) => {
+      const { verbose, migration, write } = args;
+      const options = {
+        cwd: cwd(),
+        verbose,
+        write,
+        migration,
+      };
+      await migrate(options, upgrades);
+    })
+  );
+
   cli.strict().parse(argv.slice(2));
 }
 
 /**
  * @param {Function} command
  * @returns {Function}
  */
-function run(command) {
+function run(command, ignoreSafetyChecks = false) {
   return async (args) => {
     if (args.verbose === true) {
       logger.setLevel('verbose');
@@ -88,7 +117,7 @@ function run(command) {
       }
     }
 
-    if (!clean && args.force !== true) {
+    if (!ignoreSafetyChecks && !clean && args.force !== true) {
       logger.log(
         chalk.yellow('[warning]'),
         'It appears that you have untracked changes in your project. Before we continue, please stash or commit your changes to git.'
@@ -101,7 +130,7 @@ function run(command) {
 
     try {
       await command(args);
-      logger.log('Done! ✨');
+      logger.verbose('Done! ✨');
     } catch (error) {
       if (error instanceof UpgradeError) {
         logger.error(error.message);

packages/upgrade/src/commands/migrate.js

@@ -0,0 +1,112 @@
+/**
+ * Copyright IBM Corp. 2019, 2019
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import inquirer from 'inquirer';
+import { UpgradeError } from '../error';
+import { logger } from '../logger';
+import { Workspace, getAvailableWorkspaces } from '../workspace';
+
+export async function migrate(options, upgrades = []) {
+  logger.verbose('running migrate command with options: %o', options);
+
+  const migrations = upgrades
+    .filter((upgrade) => {
+      return upgrade.migrations && upgrade.migrations.length > 0;
+    })
+    .flatMap((upgrade) => {
+      return upgrade.migrations;
+    });
+
+  if (!migrations || migrations.length === 0) {
+    logger.info('No migrations available');
+    return;
+  }
+
+  // List available migrations
+  if (options.list) {
+    listMigrations(migrations);
+    return;
+  }
+
+  const workspaces = getAvailableWorkspaces(options.cwd);
+  if (workspaces.length === 0) {
+    throw new UpgradeError('Unable to find a workspace to migrate');
+  }
+
+  // Only run the migration specified in the options
+  if (options.migration) {
+    const migration = migrations.find((migration) => {
+      return migration.name === options.migration;
+    });
+
+    if (!migration) {
+      logger.error(
+        'Sorry, there is no migration with the name "%s"',
+        options.migration
+      );
+      listMigrations(migrations);
+    } else {
+      await runMigration(migration, workspaces, options);
+    }
+
+    return;
+  } else {
+    logger.error('A migration must be specified');
+  }
+}
+
+/**
+ * @param {Array<Migrations>} migrations
+ * @returns {<void>}
+ */
+function listMigrations(migrations) {
+  logger.log('Available migrations:');
+  for (const migration of migrations) {
+    logger.log('  - %s (%s)', migration.name, migration.description);
+  }
+}
+
+/**
+ * @param {object<Migration>} migration
+ * @param {Array<string>} workspaces
+ * @returns {<void>}
+ */
+async function runMigration(migration, workspaces, options) {
+  const workspace = await getSelectedWorkspace(workspaces);
+
+  logger.verbose(
+    'running migration: %s for workspace: %s',
+    migration.name,
+    workspace.directory
+  );
+
+  await migration.migrate({ ...options, workspaceDir: workspace.directory });
+}
+
+/**
+ * @param {Array<string>} workspaces
+ * @returns {Promise<Workspace>}
+ */
+async function getSelectedWorkspace(workspaces) {
+  // If only one workspace is available, we'll load that one by default
+  if (workspaces.length === 1) {
+    return await Workspace.load(workspaces[0]);
+  }
+
+  // If multiple workspaces are found, we'll prompt to see which one the user
+  // would like us to operate off of.
+  const answers = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'workspace',
+      message: 'What workspace would you like to use?',
+      choices: workspaces,
+    },
+  ]);
+
+  return await Workspace.load(answers.workspace);
+}

packages/upgrade/src/commands/upgrade.js

@@ -90,6 +90,18 @@ export async function upgrade(options, availableUpgrades = []) {
       logger.log(packageJson.diff());
     }
   }
+
+  const migrations = upgrade.migrations;
+  if (migrations && migrations.length > 0) {
+    for (const migration of migrations) {
+      logger.verbose('running migration: %s', migration.name);
+
+      await migration.migrate({
+        ...options,
+        workspaceDir: workspace.directory,
+      });
+    }
+  }
 }
 
 /**

packages/upgrade/src/jscodeshift.js

@@ -0,0 +1,60 @@
+/**
+ * Copyright IBM Corp. 2019, 2019
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import execa from 'execa';
+
+let _jscodeshift;
+
+function getBinPath() {
+  if (!_jscodeshift) {
+    const directory = path.dirname(require.resolve('jscodeshift'));
+    _jscodeshift = path.join(directory, 'bin', 'jscodeshift.js');
+  }
+  return _jscodeshift;
+}
+
+export async function run(options) {
+  const {
+    cwd,
+    stdio = 'inherit',
+    parser = 'babel',
+    paths,
+    transform,
+  } = options;
+  const args = [
+    paths,
+    `-t=${transform}`,
+    `--parser=${parser}`,
+    `--ignore-pattern=**/build/**`,
+    `--ignore-pattern=**/dist/**`,
+    `--ignore-pattern=**/es/**`,
+    `--ignore-pattern=**/lib/**`,
+    `--ignore-pattern=**/node_modules/**`,
+    `--ignore-pattern=**/storybook-static/**`,
+    `--ignore-pattern=**/umd/**`,
+  ];
+
+  if (options.print) {
+    args.push('--print');
+  }
+
+  if (options.verbose) {
+    args.push('-v');
+  }
+
+  if (options.dry) {
+    args.push('--dry');
+  }
+
+  console.log(args);
+
+  return await execa(getBinPath(), args, {
+    cwd,
+    stdio,
+  });
+}