@sps-woodland/codemods 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+## [@sps-woodland/codemods](https://github.com/SPSCommerce/woodland/tree/master/packages/@sps-woodland/codemods#readme)
+
+SPS Woodland Design System codemods

package/changeList.js

@@ -0,0 +1,3 @@
+export const changeList = [
+  { oldName: "SpsCardV2", newName: "Card", newPackage: "@woodland/cards", oldPackage: "@spscommerce/ds-react" }
+];

package/main.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+const yargs = require("yargs");
+const { run } = require("jscodeshift/src/Runner")
+
+const yargv = yargs
+    .usage("Usage: $0 [options]")
+    .option("verbose", {
+        alias: "v",
+        type: "boolean",
+        description: "Print additional details to console"
+    })
+    .help("help")
+    .alias("help", "h").argv;
+
+console.log(yargv);
+
+const res = await run("transform.js", ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"], {
+    dry: true,
+    print: true,
+    verbose: 1,
+});
+console.log(res);

package/mods/imports.js

@@ -0,0 +1,46 @@
+export function modImports(source, j, changes) {
+  // Find all nodes that match a type of `ImportDeclaration`
+  const imports = source.find(j.ImportDeclaration);
+  const newPackageImports = new Map();
+
+  for (const oldPackage of Object.keys(changes.byOldPackage)) {
+    const { oldNames, newPackages } = changes.byOldPackage[oldPackage];
+    imports
+      .filter(path => path.node.source.value === oldPackage)
+      .forEach((oldImport) => {
+        const jImport = j(oldImport)
+          // Replace the existing node with a new one
+          .replaceWith(
+            // Build a new import declaration node based on the existing one for stuff still coming from the old package
+            j.importDeclaration(
+              // copy over the existing import specificers (things being imported) not in the list
+              oldImport.node.specifiers.filter(specifier => !oldNames.has(specifier.imported.name)),
+              // Keep source (where it's being imported from)
+              oldImport.node.source,
+            ),
+          );
+
+        for (const newPackage of Object.keys(newPackages)) {
+          const newNames = newPackages[newPackage];
+          // if there's already an import created for this package, we need to update it (via replacement, as above ^)
+          // otherwise we create one
+          if (newPackageImports.has(newPackage)) {
+            const newImport = newPackageImports.get(newPackage);
+            const newNewImport = j.importDeclaration(
+              [...newImport.node.specifiers, ...newNames.map((name) => j.importSpecifier(j.identifier(name)))],
+              newImport.node.source,
+            );
+            newPackageImports.set(newPackage, newNewImport);
+            j(newImport).replaceWith(newNewImport);
+          } else {
+            const newImport = j.importDeclaration(
+              newNames.map((name) => j.importSpecifier(j.identifier(name))),
+              j.literal(newPackage),
+            );
+            newPackageImports.set(newPackage, newImport);
+            jImport.insertAfter(newImport);
+          }
+        }
+      });
+  }
+}

package/mods/jsx.js

@@ -0,0 +1,32 @@
+export function modJsx(source, j, changes) {
+  const jsxOpeningElements = source.find(j.JSXOpeningElement);
+  const jsxClosingElements = source.find(j.JSXClosingElement);
+
+  for (const { oldName, newName } of changes.list) {
+    jsxOpeningElements
+      .filter(element => element.node.name.name === oldName)
+      .forEach(jsxElement => {
+        j(jsxElement)
+          .replaceWith(
+            j.jsxOpeningElement(
+              j.jsxIdentifier(newName),
+              jsxElement.node.attributes,
+              jsxElement.node.selfClosing,
+            )
+          )
+      });
+
+    jsxClosingElements
+      .filter(element => element.node.name.name === oldName)
+      .forEach(jsxElement => {
+        j(jsxElement)
+          .replaceWith(
+            j.jsxClosingElement(
+              j.jsxIdentifier(newName),
+              jsxElement.node.attributes,
+              jsxElement.node.selfClosing,
+            )
+          )
+      });
+  }
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@sps-woodland/codemods",
+  "description": "SPS Woodland Design System codemods",
+  "version": "0.0.1",
+  "author": "SPS Commerce",
+  "license": "UNLICENSED",
+  "repository": "https://github.com/spscommerce/woodland/tree/master/packages/@sps-woodland/codemods",
+  "homepage": "https://github.com/spscommerce/woodland/tree/master/packages/@sps-woodland/codemods#readme",
+  "main": "./main.js",
+  "bin": "./main.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@babel/core": ">=7.13.0 <8.0.0",
+    "@babel/preset-env": "^7.1.6",
+    "chalk": "^2.4.1",
+    "concat-stream": "^1.6.2",
+    "jscodeshift": "^0.13.1",
+    "yargs": "^12.0.2"
+  },
+  "scripts": {
+    "clean": "git clean -fdX",
+    "pub": "pnpm pack && node ../../../scripts/publish-package.js"
+  }
+}

package/transform.js

@@ -0,0 +1,46 @@
+import { modImports } from "./mods/imports";
+import { modJsx } from "./mods/jsx";
+import { changeList } from "./changeList";
+
+/**
+ * changesByPackage example result:
+ * {
+ *   "@spscommerce/ds-react": {
+ *     oldNames: new Set(["SpsCardV2", "SpsCardHeaderV2", "SpsTabsV2"]),
+ *     newPackages: {
+ *       "@woodland/cards": ["Card", "CardHeader"],
+ *       "@woodland/tabs": ["Tabs"]
+ *     }
+ *   }
+ * }
+ */
+const changesByPackage = changeList.reduce((acc, changeInfo) => {
+  let entryForThisOldPkg = acc[changeInfo.oldPackage];
+  if (!entryForThisOldPkg) {
+    acc[changeInfo.oldPackage] = entryForThisOldPkg = {
+      oldNames: new Set(),
+      newPackages: {}
+    };
+  }
+  entryForThisOldPkg.oldNames.add(changeInfo.oldName);
+  let newPkgEntry = entryForThisOldPkg.newPackages[changeInfo.newPackage];
+  if (!newPkgEntry) {
+    entryForThisOldPkg.newPackages[changeInfo.newPackage] = newPkgEntry = [];
+  }
+  newPkgEntry.push(changeInfo.newName);
+  return acc;
+}, {});
+
+const changes = {
+  list: changeList,
+  byOldPackage: changesByPackage,
+};
+
+export default function transformer(file, { jscodeshift: j }, options) {
+  const source = j(file.source);
+
+  modImports(source, j, changes);
+  modJsx(source, j, changes);
+
+  return source.toSource();
+}