@carbon/upgrade 10.16.0 → 11.0.0-rc.0

package/transforms/sort-prop-types.js

@@ -0,0 +1,88 @@
+/**
+ * Copyright IBM Corp. 2016, 2020
+ *
+ * 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 defaultOptions = {
+  quote: 'single',
+  trailingComma: true,
+};
+
+function transform(fileInfo, api, options) {
+  const printOptions = options.printOptions || defaultOptions;
+  const j = api.jscodeshift;
+  const root = j(fileInfo.source);
+
+  root
+    .find(j.AssignmentExpression, {
+      left: {
+        type: 'MemberExpression',
+        property: {
+          name: 'propTypes',
+        },
+      },
+    })
+    .forEach((path) => {
+      path.node.right.properties.sort((a, b) => {
+        if (a.type === 'Property' && b.type === 'Property') {
+          if (getPropName(a) > getPropName(b)) {
+            return 1;
+          }
+          return -1;
+        }
+
+        if (a.type === 'SpreadElement' && b.type === 'SpreadElement') {
+          if (getPropName(a) > getPropName(b)) {
+            return 1;
+          }
+          return -1;
+        }
+
+        if (a.type === 'SpreadElement') {
+          return -1;
+        }
+
+        return 1;
+      });
+    });
+
+  root
+    .find(j.ClassProperty, {
+      key: {
+        name: 'propTypes',
+      },
+    })
+    .forEach((path) => {
+      path.node.value.properties.sort((a, b) => {
+        if (getPropName(a) > getPropName(b)) {
+          return 1;
+        }
+        return -1;
+      });
+    });
+
+  function getPropName(node) {
+    if (node.type === 'SpreadElement') {
+      return node.argument.name;
+    }
+
+    if (node.type === 'Property') {
+      if (node.key.type === 'Identifier') {
+        return node.key.name;
+      }
+      if (node.key.type === 'Literal') {
+        return node.key.value;
+      }
+    }
+
+    throw new Error(`Unknown node of type: ${node.type}`);
+  }
+
+  return root.toSource(printOptions);
+}
+
+module.exports = transform;

package/transforms/update-carbon-components-react-import-to-scoped.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright IBM Corp. 2016, 2020
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * Rewrites imports from 'carbon-components-react' to '@carbon/react'
+ *
+ * Transforms:
+ *
+ * import { Button } from 'carbon-components-react';
+ *
+ * Into:
+ *
+ * import { Button } from "@carbon/react";
+ */
+
+function transformer(file, api) {
+  const j = api.jscodeshift;
+
+  return j(file.source)
+    .find(j.ImportDeclaration, {
+      source: {
+        value: 'carbon-components-react',
+      },
+    })
+    .forEach((path) => {
+      path.get('source').replace(j.stringLiteral('@carbon/react'));
+    })
+    .toSource();
+}
+
+module.exports = transformer;

package/src/cli.js

@@ -1,100 +0,0 @@
-/**
- * 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 isGitClean = require('is-git-clean');
-const packageJson = require('../package.json');
-const { UpgradeError } = require('./error');
-const { Migration } = require('./migration');
-const { Planner } = require('./planner');
-const { Project } = require('./project');
-const { Runner } = 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('write', {
-      alias: 'w',
-      describe: 'update the files with changes found by running the migration',
-      default: false,
-    })
-    .option('ignore', {
-      alias: 'i',
-      describe:
-        'provide a list of glob pattern for directories you would like ignored',
-      default: [],
-      array: true,
-    });
-
-  cli.usage('Usage: $0 [options]').command(
-    '$0',
-    'run to upgrade your project',
-    {},
-    run(async (args) => {
-      const { ignore, verbose, write } = args;
-      const options = {
-        cwd: cwd(),
-        ignore,
-        verbose,
-        write,
-      };
-
-      const project = await Project.detect(options.cwd);
-      const migrationsByWorkspace = await Migration.getMigrationsByWorkspace(
-        Array.from(project.getWorkspaces()),
-        Migration.getMigrations()
-      );
-      const migrationsToRun = await Planner.getSelectedMigrations(
-        migrationsByWorkspace
-      );
-
-      await Runner.run(migrationsToRun, options);
-    })
-  );
-
-  cli.strict().parse(argv.slice(2)).argv;
-}
-
-function run(command) {
-  return async (...args) => {
-    // checks git status on pwd, returns true if clean / false if not
-    let isClean = isGitClean.sync();
-
-    console.log('Thanks for trying out @carbon/upgrade! 🙏');
-    console.log('Checking git status...👀');
-
-    if (!isClean) {
-      console.error(
-        'Git directory is not clean. Please stash or commit your changes.'
-      );
-      process.exit(1);
-    }
-
-    try {
-      await command(...args);
-      console.log('Done! ✨');
-    } catch (error) {
-      if (error instanceof UpgradeError) {
-        console.error(error.message);
-        process.exit(1);
-      }
-      console.error('Yikes, looks like something really went wrong.');
-      console.error('Please make an issue with the following info:');
-      console.log(error);
-      process.exit(1);
-    }
-  };
-}
-
-module.exports = main;

package/src/error.js

@@ -1,21 +0,0 @@
-/**
- * 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';
-
-class CustomError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = this.constructor.name;
-  }
-}
-
-class UpgradeError extends CustomError {}
-
-module.exports = {
-  UpgradeError,
-};

package/src/hash.js

@@ -1,87 +0,0 @@
-/**
- * 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 BASE62 = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
-
-/**
- * Murmur hash implementation
- * @see https://github.com/garycourt/murmurhash-js
- * @param {string} str
- * @returns {string}
- */
-function hash(str) {
-  const length = str.length;
-  const rem = length & 3;
-  const len = length ^ rem;
-
-  let h = 0;
-  let i = 0;
-  let k;
-
-  while (i !== len) {
-    const ch4 = str.charCodeAt(i + 3);
-
-    k =
-      str.charCodeAt(i) ^
-      (str.charCodeAt(i + 1) << 8) ^
-      (str.charCodeAt(i + 2) << 16) ^
-      ((ch4 & 0xff) << 24) ^
-      ((ch4 & 0xff00) >> 8);
-
-    i += 4;
-
-    k = (k * 0x2d51 + (k & 0xffff) * 0xcc9e0000) >>> 0;
-    k = (k << 15) | (k >>> 17);
-    k = (k * 0x3593 + (k & 0xffff) * 0x1b870000) >>> 0;
-    h ^= k;
-    h = (h << 13) | (h >>> 19);
-    h = (h * 5 + 0xe6546b64) >>> 0;
-  }
-
-  k = 0;
-  switch (rem) {
-    /* eslint-disable no-fallthrough */
-    case 3:
-      k ^= str.charCodeAt(len + 2) << 16;
-    case 2:
-      k ^= str.charCodeAt(len + 1) << 8;
-    case 1:
-      k ^= str.charCodeAt(len);
-
-      k = (k * 0x2d51 + (k & 0xffff) * 0xcc9e0000) >>> 0;
-      k = (k << 15) | (k >>> 17);
-      k = (k * 0x3593 + (k & 0xffff) * 0x1b870000) >>> 0;
-      h ^= k;
-  }
-
-  h ^= length;
-  h ^= h >>> 16;
-  h = (h * 0xca6b + (h & 0xffff) * 0x85eb0000) >>> 0;
-  h ^= h >>> 13;
-  h = (h * 0xae35 + (h & 0xffff) * 0xc2b20000) >>> 0;
-  h ^= h >>> 16;
-
-  h >>>= 0;
-
-  if (!h) {
-    return '0';
-  }
-
-  let s = '';
-  while (h) {
-    const d = h % 62;
-    s = BASE62[d] + s;
-    h = (h - d) / 62;
-  }
-  return s;
-}
-
-module.exports = {
-  hash,
-};

package/src/migration.js

@@ -1,85 +0,0 @@
-/**
- * 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 semver = require('semver');
-const migrations = require('./migrations');
-
-const codes = {
-  // The migration is supported for the current workspace for the matching
-  // dependency
-  SUPPORTED: 'supported',
-  // The migration is supported for the current dependency in the workspace but
-  // the version range does not intersect
-  RANGE_MISMATCH: 'range_mismatch',
-};
-
-/**
- * Get the currently supported migrations
- * @returns {Array<Migration>}
- */
-function getMigrations() {
-  return migrations;
-}
-
-function getMigrationsByWorkspace(workspaces, migrations) {
-  return workspaces
-    .map((workspace) => {
-      const { dependencies } = workspace;
-
-      return {
-        workspace,
-        migrationOptions: migrations
-          .filter((migration) => {
-            return dependencies.find((dependency) => {
-              return dependency.name === migration.packageName;
-            });
-          })
-          .map((migration) => {
-            const dependency = dependencies.find((dependency) => {
-              return dependency.name === migration.packageName;
-            });
-
-            if (semver.intersects(migration.from, dependency.version)) {
-              return {
-                dependency,
-                migration,
-                available: true,
-                code: codes.SUPPORTED,
-              };
-            }
-
-            return {
-              dependency,
-              migration,
-              available: false,
-              code: codes.RANGE_MISMATCH,
-            };
-          }),
-      };
-    })
-    .filter((workspace) => {
-      return workspace.migrationOptions.length > 0;
-    });
-}
-
-function applyMigrations() {}
-
-/**
- * A module for finding and running migrations
- */
-const Migration = {
-  codes,
-  getMigrations,
-  getMigrationsByWorkspace,
-  applyMigrations,
-};
-
-module.exports = {
-  Migration,
-};

package/src/migrations/index.js

@@ -1,41 +0,0 @@
-/**
- * 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 supported = [
-  {
-    packageName: 'react',
-    // the range we would like to migrate *from*
-    from: '>=16',
-    // the version we would like to migrate *to*
-    to: '18.0.0',
-
-    async migrate(workspace) {
-      console.log(
-        'migrate the react package in the %s workspace',
-        workspace.name
-      );
-    },
-  },
-  {
-    packageName: 'react-dom',
-    // the range we would like to migrate *from*
-    from: '>=16',
-    // the version we would like to migrate *to*
-    to: '18.0.0',
-
-    async migrate(workspace) {
-      console.log(
-        'migrate the react-dom package in the %s workspace',
-        workspace.name
-      );
-    },
-  },
-];
-
-module.exports = supported;

package/src/planner.js

@@ -1,58 +0,0 @@
-/**
- * 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 { prompt } = require('inquirer');
-
-const Planner = {
-  /**
-   * Prompt the user to see which migrations they would like to apply for each
-   * workspace
-   * @param {Array<WorkspaceMigration>} migrationsByWorkspace
-   * @returns {Array<WorkspaceMigration>}
-   */
-  async getSelectedMigrations(migrationsByWorkspace) {
-    const answers = [];
-
-    for (const { workspace, migrationOptions } of migrationsByWorkspace) {
-      const answer = await prompt({
-        type: 'checkbox',
-        message: `Migrations available for ${workspace.name}`,
-        name: 'selected',
-        choices: migrationOptions
-          .filter((migrationOption) => {
-            return migrationOption.available === true;
-          })
-          .map((migrationOption) => {
-            const { dependency, migration } = migrationOption;
-            return {
-              name: `Migrate ${dependency.name} from: ${dependency.version} to: ${migration.to}`,
-              value: migration,
-              checked: true,
-            };
-          }),
-      });
-
-      answers.push(answer);
-    }
-
-    return migrationsByWorkspace.map(({ workspace, migrationOptions }, i) => {
-      const answer = answers[i];
-      return {
-        workspace,
-        migrationOptions: migrationOptions.filter((migrationOption) => {
-          return answer.selected.includes(migrationOption.migration);
-        }),
-      };
-    });
-  },
-};
-
-module.exports = {
-  Planner,
-};

package/src/project/__tests__/project-test.js

@@ -1,52 +0,0 @@
-/**
- * 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 { Volume } = require('memfs');
-
-function setupProject(mockVol) {
-  jest.mock('fs', () => {
-    const { createFsFromVolume } = require('memfs');
-    const fs = createFsFromVolume(mockVol);
-
-    // Our usage of `fs-extra` requires a fs.realpath.native value that memfs
-    // does not seem to provide.
-    Object.defineProperty(fs.realpath, 'native', {
-      value: jest.fn(),
-      enumerable: true,
-      writable: false,
-    });
-
-    return fs;
-  });
-  return require('../project').Project;
-}
-
-describe('Project', () => {
-  afterEach(() => {
-    jest.resetModules();
-  });
-
-  it('should detect a project from the current working directory', async () => {
-    const directory = '/test';
-    const Project = setupProject(
-      Volume.fromJSON(
-        {
-          './package.json': JSON.stringify({}),
-          './src/test.js': '',
-        },
-        directory
-      )
-    );
-
-    const project = await Project.detect('/test/src');
-    expect(project.directory).toEqual('/test');
-  });
-});

package/src/project/__tests__/workspace-test.js

@@ -1,92 +0,0 @@
-/**
- * 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 { Volume } = require('memfs');
-
-function setupWorkspace(mockVol) {
-  jest.mock('fs', () => {
-    const { createFsFromVolume } = require('memfs');
-    const fs = createFsFromVolume(mockVol);
-
-    // Our usage of `fs-extra` requires a fs.realpath.native value that memfs
-    // does not seem to provide.
-    Object.defineProperty(fs.realpath, 'native', {
-      value: jest.fn(),
-      enumerable: true,
-      writable: false,
-    });
-
-    return fs;
-  });
-  return require('../workspace').Workspace;
-}
-
-describe('Workspace', () => {
-  afterEach(() => {
-    jest.resetModules();
-  });
-
-  it('should load a single directory with a `package.json`', async () => {
-    const directory = '/test';
-    const Workspace = setupWorkspace(
-      Volume.fromJSON(
-        {
-          './package.json': JSON.stringify({}),
-        },
-        directory
-      )
-    );
-    const workspace = await Workspace.load(directory);
-
-    expect(
-      Array.from(workspace.getWorkspaces()).map((w) => w.directory)
-    ).toEqual(['/test']);
-
-    await expect(Workspace.load(directory)).resolves.toBeInstanceOf(Workspace);
-  });
-
-  it('should load a workspace', async () => {
-    const directory = '/test';
-    const Workspace = setupWorkspace(
-      Volume.fromJSON(
-        {
-          './package.json': JSON.stringify({
-            workspaces: ['packages/*'],
-          }),
-          'packages/a/package.json': JSON.stringify({
-            version: '0.1.0',
-          }),
-          'packages/b/package.json': JSON.stringify({
-            dependencies: {
-              a: '^0.1.0',
-            },
-          }),
-          'packages/c/package.json': JSON.stringify({
-            workspaces: ['examples/*'],
-          }),
-          'packages/c/examples/d/package.json': JSON.stringify({}),
-        },
-        directory
-      )
-    );
-
-    const workspace = await Workspace.load(directory);
-    expect(
-      Array.from(workspace.getWorkspaces()).map((w) => w.directory)
-    ).toEqual([
-      '/test',
-      '/test/packages/a',
-      '/test/packages/b',
-      '/test/packages/c',
-      '/test/packages/c/examples/d',
-    ]);
-  });
-});

package/src/project/index.js

@@ -1,16 +0,0 @@
-/**
- * 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 { Project } = require('./project');
-const { Workspace } = require('./workspace');
-
-module.exports = {
-  Project,
-  Workspace,
-};