feat(migrate): Expose dependent path migration

BREAKING CHANGE: rename result properties, default path migrations

packages/migrate/README.md

@@ -66,18 +66,18 @@ migrate({
     // The programtic api does not come with this by default and can be overwritten.
     return prompt(options);
   }
-}).then(({ updated, moved }) => {
+}).then(({ fileContents, fileNames }) => {
   // Output contains an object with all of the migrated component sources.
   console.log("migrated all files");
 
-  for (const file in updated) {
+  for (const file in fileContents) {
     // Save all updated files to disk.
-    fs.writeFileSync(file, output[file], "utf-8");
+    fs.writeFileSync(file, fileContents[file], "utf-8");
   }
 
-  for (const file in moved) {
+  for (const file in fileNames) {
     // Update locations of moved files on disk.
-    fs.renameSync(file, moved[file]);
+    fs.renameSync(file, fileNames[file]);
   }
 });
 ```

packages/migrate/src/cli.js

@@ -80,16 +80,22 @@ export async function run(options, markoCli) {
     ...options
   };
 
-  const { updated, moved } = await markoMigrate(options);
+  const { fileContents, fileNames, dependentPaths } = await markoMigrate(
+    options
+  );
+
   await Promise.all(
-    Object.entries(updated).map(([file, source]) => {
+    Object.entries(fileContents).map(([file, source]) => {
       return fs.writeFile(file, source, "utf-8");
     })
   );
 
-  for (const from in moved) {
-    const to = moved[from];
+  await Promise.all(
+    Object.entries(fileNames).map(([from, to]) => fs.rename(from, to))
+  );
 
+  for (const from in dependentPaths) {
+    const to = dependentPaths[from];
     await Promise.all(
       Object.entries(
         await dependentPathUpdate({
@@ -99,9 +105,7 @@ export async function run(options, markoCli) {
           from,
           to
         })
-      )
-        .map(([file, source]) => fs.writeFile(file, source, "utf-8"))
-        .concat(fs.rename(from, to))
+      ).map(([file, source]) => fs.writeFile(file, source, "utf-8"))
     );
   }
 }

packages/migrate/src/index.js

@@ -18,19 +18,16 @@ const defaultGlobOptions = {
   ignore: ["node_modules/**"]
 };
 
-export default async function(options = {}) {
-  let { dir, ignore, files: filePatterns, prompt } = options;
-
-  if (!filePatterns || !filePatterns.length) {
-    filePatterns = ["**/*.marko"];
-  }
-
-  if (typeof prompt !== "function") {
+export default async function(options) {
+  if (!options || typeof options.prompt !== "function") {
     throw new Error("The 'prompt' option is required.");
   }
 
-  dir = dir || process.cwd();
-
+  const {
+    dir = process.cwd(),
+    files: filePatterns = ["**/*.marko"],
+    ignore
+  } = options;
   const packageRoot = getPackageRoot(dir);
   const markoCompiler = requireFromRoot("marko/compiler", packageRoot);
 
@@ -51,8 +48,11 @@ export default async function(options = {}) {
   }
 
   const files = await getFiles(filePatterns, globOptions);
-  const updatedFiles = {};
-  const movedFiles = {};
+  const results = {
+    dependentPaths: {},
+    fileContents: {},
+    fileNames: {}
+  };
 
   await Promise.all(
     files.map(async file => {
@@ -65,15 +65,15 @@ export default async function(options = {}) {
         const ast = markoCompiler.parse(source, file, {
           onContext(ctx) {
             ctx.addMigration = add;
-            addDefaultMigrations(ctx, updatedFiles, movedFiles);
+            addDefaultMigrations(ctx, results);
           },
           migrate: true,
           raw: true
         });
 
         await runAutoMigrations(migrateHelper);
 
-        updatedFiles[file] = markoPrettyprint.prettyPrintAST(ast, {
+        results.fileContents[file] = markoPrettyprint.prettyPrintAST(ast, {
           syntax: options.syntax,
           maxLen: options.maxLen,
           noSemi: options.noSemi,
@@ -84,10 +84,7 @@ export default async function(options = {}) {
     })
   );
 
-  return {
-    moved: movedFiles,
-    updated: updatedFiles
-  };
+  return results;
 }
 
 function getPackageRoot(dir) {

packages/migrate/src/util/default-migrations/component-file.js

@@ -1,11 +1,12 @@
 import migrateWidget from "@marko/migrate-v3-widget";
 
-export default function addComponentMigration(ctx, updatedFiles) {
+export default function addComponentMigration(ctx, { fileContents }) {
   ctx.addMigration({
     name: "componentFile",
     description: "Migrating widget file with defineComponent",
-    async apply(helper, { filename }) {
-      updatedFiles[filename] = await migrateWidget(filename, {
+    async apply(_, { componentFile, templateFile }) {
+      fileContents[componentFile] = await migrateWidget(componentFile, {
+        templateFile,
         onContext(hub) {
           hub.addMigration = ctx.addMigration;
         }

packages/migrate/src/util/default-migrations/index.js

@@ -1,6 +1,6 @@
-import renameFile from "./rename-file";
+import updatePaths from "./update-paths";
 import componentFile from "./component-file";
-export default function addFileMigrations(ctx, migratedFiles, renamedFiles) {
-  renameFile(ctx, migratedFiles, renamedFiles);
-  componentFile(ctx, migratedFiles);
+export default function addFileMigrations(ctx, result) {
+  updatePaths(ctx, result);
+  componentFile(ctx, result);
 }

packages/migrate/src/util/default-migrations/update-paths.js

@@ -0,0 +1,18 @@
+export default function addComponentMigration(
+  ctx,
+  { fileNames, dependentPaths }
+) {
+  ctx.addMigration({
+    name: "updateFilePath",
+    apply(_, { from, to }) {
+      fileNames[from] = to;
+    }
+  });
+
+  ctx.addMigration({
+    name: "updateDependentPaths",
+    apply(_, { from, to }) {
+      dependentPaths[from] = to;
+    }
+  });
+}

packages/migrate/test/fixtures/single-template-rename/migrator.js

@@ -3,7 +3,7 @@ const path = require("path");
 module.exports = (root, context) => {
   context.addMigration({
     apply(helper) {
-      return helper.run("renameFile", {
+      return helper.run("updateFilePath", {
         from: context.filename,
         to: path.join(context.dirname, "index.marko")
       });

packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/marko.json

@@ -0,0 +1,3 @@
+{
+  "migrator": "./migrator"
+}

packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/migrator.js

@@ -0,0 +1,14 @@
+const path = require("path");
+
+module.exports = (root, context) => {
+  const widgetFile = path.join(context.dirname, "index.js");
+  const newWidgetFile = path.join(context.dirname, "component.js");
+  context.addMigration({
+    apply(helper) {
+      return helper.run("updateDependentPaths", {
+        from: widgetFile,
+        to: newWidgetFile
+      });
+    }
+  });
+};

packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/snapshot-expected.marko

@@ -0,0 +1,6 @@
+<!-- packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/template.marko -->
+
+<div/>
+
+
+<!-- dependents: packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/index.js => packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/component.js -->

packages/migrate/test/fixtures/single-widget-rename-and-dependent-paths/template.marko

@@ -0,0 +1 @@
+<div/>

packages/migrate/test/index.test.js

@@ -7,21 +7,34 @@ const CWD = process.cwd();
 describe("scope(migrate)", () => {
   autotest("fixtures", async ({ dir, test, snapshot }) => {
     test(async () => {
-      const { updated, moved } = await migrate({
+      const { fileContents, fileNames, dependentPaths } = await migrate({
         prompt() {},
         ignore: ["**/snapshot-*.*"],
         files: [`${dir}/**/*.marko`]
       });
 
       snapshot(
-        Object.entries(updated)
+        Object.entries(fileContents)
           .sort(([a], [b]) => a.localeCompare(b))
           .map(
             ([file, source]) =>
               `<!-- ${path.relative(CWD, file)}${
-                moved[file] ? ` => ${path.relative(CWD, moved[file])}` : ""
+                fileNames[file]
+                  ? ` => ${path.relative(CWD, fileNames[file])}`
+                  : ""
               } -->\n\n${source}`
           )
+          .concat(
+            Object.entries(dependentPaths)
+              .sort(([a], [b]) => a.localeCompare(b))
+              .map(
+                ([from, to]) =>
+                  `<!-- dependents: ${path.relative(
+                    CWD,
+                    from
+                  )} => ${path.relative(CWD, to)} -->`
+              )
+          )
           .join("\n\n"),
         {
           ext: ".marko",