feat: add support for elements migration (#2)

feat/add-elements-migration

packages/upgrade/bin/carbon-upgrade.js

@@ -37,7 +37,7 @@ if (major < 8) {
   process.exit(1);
 }
 
-var main = require('../src');
+var main = require('../src/cli');
 
 main(process).catch(error => {
   console.error(error);

packages/upgrade/fixtures/carbon-colors/a.scss

@@ -0,0 +1,7 @@
+.selector {
+  color: $ibm-colors__blue--50;
+}
+
+.animated {
+  transition-timing-function: map-get($easings, productive);
+}

packages/upgrade/fixtures/carbon-colors/package.json

@@ -1,5 +1,7 @@
 {
   "dependencies": {
-    "@carbon/colors": "0.0.1-alpha.27"
+    "@carbon/colors": "0.0.1-alpha.27",
+    "@carbon/motion": "0.0.1-alpha.27",
+    "carbon-components": "9.x"
   }
 }

packages/upgrade/package.json

@@ -15,9 +15,13 @@
   },
   "dependencies": {
     "chalk": "^2.4.2",
-    "commander": "^2.19.0",
+    "fast-glob": "^2.2.6",
     "fs-extra": "^7.0.1",
-    "inquirer": "^6.2.1"
+    "inquirer": "^6.2.1",
+    "jest-diff": "^23.6.0",
+    "lodash.clonedeep": "^4.5.0",
+    "semver": "^5.6.0",
+    "yargs": "^12.0.5"
   },
   "devDependencies": {
     "@commitlint/cli": "^7.3.2",

packages/upgrade/src/__mocks__/reporter.js

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+module.exports = {
+  reporter: {
+    error: jest.fn(),
+    header: jest.fn(),
+    info: jest.fn(),
+    log: jest.fn(),
+    setLogLevel: jest.fn(),
+    stack: jest.fn(),
+    success: jest.fn(),
+    verbose: jest.fn(),
+  },
+};

packages/upgrade/src/cli.js

@@ -0,0 +1,101 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+const cli = require('yargs');
+const packageJson = require('../package.json');
+const { UpgradeError } = require('./error');
+const { reporter } = require('./reporter');
+const { run, runInDirectory } = require('./runner');
+
+async function main({ argv, cwd }) {
+  cli.scriptName(packageJson.name).version(packageJson.version);
+
+  cli
+    .option('verbose', {
+      default: false,
+      describe: 'display the full output while running a command',
+    })
+    .option('dry', {
+      alias: 'd',
+      describe:
+        'view the result of running this command without changing any files',
+      default: false,
+    })
+    .option('ignore', {
+      alias: 'i',
+      describe: 'provide a glob pattern for directories you would like ignored',
+      default: '',
+    });
+
+  cli
+    .usage('Usage: $0 [options]')
+    .command('$0', 'run to upgrade your project', {}, async args => {
+      const { dry, ignore, verbose } = args;
+      const options = {
+        cwd: cwd(),
+        dry,
+        ignore,
+        verbose,
+      };
+
+      await runCommand(() => runInDirectory(options), options);
+    });
+
+  cli.command(
+    'migrate <package> <from> <to>',
+    'run a specific migration for a package',
+    {},
+    async args => {
+      const { dry, from, ignore, package: packageName, to, verbose } = args;
+      const options = {
+        cwd: cwd(),
+        dry,
+        ignore,
+        verbose,
+      };
+
+      await runCommand(() => run(packageName, from, to, options), options);
+    }
+  );
+
+  cli
+    .demandCommand()
+    .recommendCommands()
+    .strict()
+    .parse(argv.slice(2)).argv;
+}
+
+async function runCommand(makePromise, options) {
+  reporter.info('Thanks for trying out carbon-upgrade! 🙏');
+  reporter.info(
+    'To help prevent any accidental changes, make sure to check in your ' +
+      'work in version control first and use dry mode (-d flag) to ' +
+      'preview any updates!'
+  );
+
+  if (options.verbose) {
+    reporter.setLogLevel('verbose');
+  }
+
+  try {
+    const start = Date.now();
+    await makePromise();
+    console.log(`✨ Done in ${Date.now() - start}ms`);
+  } catch (error) {
+    if (error instanceof UpgradeError) {
+      reporter.error(error.message);
+      return;
+    }
+    reporter.error('Yikes, looks like something really went wrong.');
+    reporter.error('Please make an issue with the following info:');
+    console.log(error);
+  }
+}
+
+module.exports = main;

packages/upgrade/src/__tests__/carbon-upgrade-test.js → packages/upgrade/src/error.js

@@ -3,12 +3,12 @@
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @jest-environment node
  */
 
 'use strict';
 
-test('should work', () => {
-  // ...
-});
+class UpgradeError extends Error {}
+
+module.exports = {
+  UpgradeError,
+};

packages/upgrade/src/migrations/carbon-colors/0.0.1-alpha.31.js

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+const { reporter } = require('../../reporter');
+const { replace } = require('../../tools/replace');
+
+const TARGET_VERSION = '0.0.1-alpha.31';
+
+module.exports = {
+  version: TARGET_VERSION,
+  from: [
+    {
+      version: '<=0.0.1-alpha.30',
+      async migrate(options) {
+        const changes = [
+          {
+            from: /(\$ibm-colors__[a-z]+)(--)([\d]+)/gm,
+            // Capture group $1 refers to $ibm-colors__abcd
+            // $2 refers to double dash (--)
+            // $3 is the grade at the end
+            to: '$1-$3',
+          },
+        ];
+
+        await replace('**/*.scss', changes, options);
+      },
+    },
+  ],
+};

packages/upgrade/src/migrations/carbon-colors/__tests__/0.0.1-alpha.31.js

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ *
+ * @jest-environment node
+ */
+
+'use strict';
+
+const { defineInlineTest } = require('../../../tools/testing');
+
+defineInlineTest(
+  require.resolve('../0.0.1-alpha.31.js'),
+  '0.0.1-alpha.30',
+  `
+$ibm-colors__blue--50;
+$ibm-colors__teal--50;
+  color: $ibm-colors__blue--50;
+  color: $ibm-colors__teal--50;
+  `,
+  `
+$ibm-colors__blue-50;
+$ibm-colors__teal-50;
+  color: $ibm-colors__blue-50;
+  color: $ibm-colors__teal-50;
+  `
+);

packages/upgrade/src/migrations/carbon-colors/index.js

@@ -7,7 +7,7 @@
 
 'use strict';
 
-const migrations = new Set([require('./0.0.1-alpha.28')]);
+const migrations = new Set([require('./0.0.1-alpha.31')]);
 
 module.exports = {
   name: '@carbon/colors',

packages/upgrade/src/migrations/carbon-elements/0.0.1-alpha.31.js

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+const { reporter } = require('../../reporter');
+const colors = require('../carbon-colors/0.0.1-alpha.31');
+const grid = require('../carbon-grid/0.0.1-alpha.31');
+const layout = require('../carbon-layout/0.0.1-alpha.31');
+const motion = require('../carbon-motion/0.0.1-alpha.31');
+
+const TARGET_VERSION = '0.0.1-alpha.31';
+
+module.exports = {
+  version: TARGET_VERSION,
+  from: [
+    {
+      version: '<=0.0.1-alpha.30',
+      async migrate(options) {
+        const migrations = [
+          ...colors.from,
+          ...grid.from,
+          ...layout.from,
+          ...motion.from,
+        ].filter(({ version }) => version === '<=0.0.1-alpha.30');
+        await Promise.all(
+          migrations.map(migration => migration.migrate(options))
+        );
+      },
+    },
+  ],
+};