Allowed users to specify podModulePrefix (ember-app) (#7)

* refactor: Created the options object in tests * refactor: Passed the options object to migrationStrategy methods * refactor: Created temporary variables to improve code readability * feature: Allowed the end-user to specify the pod path * chore: Added a fixture to test the podPath option (ember-app) * feature: Added tests to test the podPath option (ember-app) * feature: Updated migrations to take podPath into account (ember-app) * bugfix: Ensured that empty directories are removed Co-authored-by: ijlee2 <ijlee2@users.noreply.github.com>
ijlee2 · Jul 25, 2022 · 78315e6 · 78315e6
1 parent 2557e9e
commit 78315e6
Show file tree

Hide file tree

Showing 136 changed files with 2,319 additions and 789 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,19 @@ npx ember-codemod-pod-to-octane --root=<your/project/path>
 </details>
 
 
+<details>
+<summary>Optional: Specify the pod path</summary>
+
+Pass `--pod-path` if `podModulePrefix` is set in `config/environment.js` and has a different value than `modulePrefix`. "Subtract" `modulePrefix` from `podModulePrefix` to get the pod path.
+
+```sh
+# If modulePrefix is 'my-app' and podModulePrefix is 'my-app/pods'
+npx ember-codemod-pod-to-octane --pod-path=pods
+```
+
+</details>
+
+
 ### Limitations
 
 The codemod is designed to cover typical uses of an Ember app, addon, and engine. It is not designed to cover one-off cases.

diff --git a/bin/ember-codemod-pod-to-octane.js b/bin/ember-codemod-pod-to-octane.js
@@ -11,6 +11,11 @@ process.title = 'ember-codemod-pod-to-octane';
 
 // Set codemod options
 const { argv } = yargs(hideBin(process.argv))
+  .option('pod-path', {
+    default: '',
+    describe: 'Namespace used for the pod layout',
+    type: 'string',
+  })
   .option('root', {
     describe: 'Location of your Ember project',
     type: 'string',
@@ -28,6 +33,7 @@ const { argv } = yargs(hideBin(process.argv))
   });
 
 const options = {
+  podPath: argv['pod-path'],
   projectRoot: argv['root'] ?? process.cwd(),
   projectType: argv['type'],
   testRun: argv['test'],

diff --git a/src/migration/ember-addon/addon/component-classes.js b/src/migration/ember-addon/addon/component-classes.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentClasses(projectRoot) {
+export function migrationStrategyForComponentClasses(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('addon/components/**/component.{d.ts,js,ts}', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/addon/component-stylesheets.js b/src/migration/ember-addon/addon/component-stylesheets.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentStylesheets(projectRoot) {
+export function migrationStrategyForComponentStylesheets(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('addon/components/**/styles.{css,scss}', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/addon/component-templates.js b/src/migration/ember-addon/addon/component-templates.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentTemplates(projectRoot) {
+export function migrationStrategyForComponentTemplates(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('addon/components/**/template.hbs', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/addon/index.js b/src/migration/ember-addon/addon/index.js
@@ -2,10 +2,10 @@ import { migrationStrategyForComponentClasses } from './component-classes.js';
 import { migrationStrategyForComponentStylesheets } from './component-stylesheets.js';
 import { migrationStrategyForComponentTemplates } from './component-templates.js';
 
-export function migrationStrategyForAddonFolder(projectRoot) {
+export function migrationStrategyForAddonFolder(options) {
   return new Map([
-    ...migrationStrategyForComponentClasses(projectRoot),
-    ...migrationStrategyForComponentStylesheets(projectRoot),
-    ...migrationStrategyForComponentTemplates(projectRoot),
+    ...migrationStrategyForComponentClasses(options),
+    ...migrationStrategyForComponentStylesheets(options),
+    ...migrationStrategyForComponentTemplates(options),
   ]);
 }
diff --git a/src/migration/ember-addon/app/component-classes.js b/src/migration/ember-addon/app/component-classes.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentClasses(projectRoot) {
+export function migrationStrategyForComponentClasses(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('app/components/**/component.js', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/app/component-stylesheets.js b/src/migration/ember-addon/app/component-stylesheets.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentStylesheets(projectRoot) {
+export function migrationStrategyForComponentStylesheets(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('app/components/**/styles.js', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/app/component-templates.js b/src/migration/ember-addon/app/component-templates.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentTemplates(projectRoot) {
+export function migrationStrategyForComponentTemplates(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync('app/components/**/template.js', {
     cwd: projectRoot,
   });

diff --git a/src/migration/ember-addon/app/index.js b/src/migration/ember-addon/app/index.js
@@ -2,10 +2,10 @@ import { migrationStrategyForComponentClasses } from './component-classes.js';
 import { migrationStrategyForComponentStylesheets } from './component-stylesheets.js';
 import { migrationStrategyForComponentTemplates } from './component-templates.js';
 
-export function migrationStrategyForAppFolder(projectRoot) {
+export function migrationStrategyForAppFolder(options) {
   return new Map([
-    ...migrationStrategyForComponentClasses(projectRoot),
-    ...migrationStrategyForComponentStylesheets(projectRoot),
-    ...migrationStrategyForComponentTemplates(projectRoot),
+    ...migrationStrategyForComponentClasses(options),
+    ...migrationStrategyForComponentStylesheets(options),
+    ...migrationStrategyForComponentTemplates(options),
   ]);
 }
diff --git a/src/migration/ember-addon/index.js b/src/migration/ember-addon/index.js
@@ -5,13 +5,11 @@ import { migrationStrategyForAppFolder } from './app/index.js';
 import { migrationStrategyForTestsFolder } from './tests/index.js';
 
 export function migrateEmberAddon(options) {
-  const { projectRoot, testRun } = options;
+  const migrationStrategyAddon = migrationStrategyForAddonFolder(options);
+  const migrationStrategyApp = migrationStrategyForAppFolder(options);
+  const migrationStrategyTests = migrationStrategyForTestsFolder(options);
 
-  const migrationStrategyAddon = migrationStrategyForAddonFolder(projectRoot);
-  const migrationStrategyApp = migrationStrategyForAppFolder(projectRoot);
-  const migrationStrategyTests = migrationStrategyForTestsFolder(projectRoot);
-
-  if (testRun) {
+  if (options.testRun) {
     console.log({
       migrationStrategyAddon,
       migrationStrategyApp,
@@ -21,23 +19,9 @@ export function migrateEmberAddon(options) {
     return;
   }
 
-  moveFiles({
-    migrationStrategy: migrationStrategyAddon,
-    projectRoot,
-  });
-
-  moveFiles({
-    migrationStrategy: migrationStrategyApp,
-    projectRoot,
-  });
-
-  moveFiles({
-    migrationStrategy: migrationStrategyTests,
-    projectRoot,
-  });
+  moveFiles(migrationStrategyAddon, options);
+  moveFiles(migrationStrategyApp, options);
+  moveFiles(migrationStrategyTests, options);
 
-  updatePaths({
-    migrationStrategy: migrationStrategyApp,
-    projectRoot,
-  });
+  updatePaths(migrationStrategyApp, options);
 }
diff --git a/src/migration/ember-addon/tests/components.js b/src/migration/ember-addon/tests/components.js
@@ -2,7 +2,9 @@ import glob from 'glob';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponents(projectRoot) {
+export function migrationStrategyForComponents(options) {
+  const { projectRoot } = options;
+
   const oldPaths = glob.sync(
     'tests/integration/components/**/component-test.{js,ts}',
     {

diff --git a/src/migration/ember-addon/tests/index.js b/src/migration/ember-addon/tests/index.js
@@ -1,5 +1,5 @@
 import { migrationStrategyForComponents } from './components.js';
 
-export function migrationStrategyForTestsFolder(projectRoot) {
-  return new Map([...migrationStrategyForComponents(projectRoot)]);
+export function migrationStrategyForTestsFolder(options) {
+  return new Map([...migrationStrategyForComponents(options)]);
 }
diff --git a/src/migration/ember-app/app/component-classes.js b/src/migration/ember-app/app/component-classes.js
@@ -1,17 +1,23 @@
 import glob from 'glob';
+import { join } from 'node:path';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentClasses(projectRoot) {
-  const oldPaths = glob.sync('app/components/**/component.{d.ts,js,ts}', {
-    cwd: projectRoot,
-  });
+export function migrationStrategyForComponentClasses(options) {
+  const { podPath, projectRoot } = options;
+
+  const oldPaths = glob.sync(
+    join('app', podPath, 'components', '**', 'component.{d.ts,js,ts}'),
+    {
+      cwd: projectRoot,
+    }
+  );
 
   return oldPaths.map((oldPath) => {
     if (oldPath.endsWith('.d.ts')) {
       return mapPaths(oldPath, {
         find: {
-          directory: 'app/components',
+          directory: join('app', podPath, 'components'),
           file: 'component.d.ts',
         },
         replace(key) {
@@ -23,7 +29,7 @@ export function migrationStrategyForComponentClasses(projectRoot) {
     if (oldPath.endsWith('.ts')) {
       return mapPaths(oldPath, {
         find: {
-          directory: 'app/components',
+          directory: join('app', podPath, 'components'),
           file: 'component.ts',
         },
         replace(key) {
@@ -34,7 +40,7 @@ export function migrationStrategyForComponentClasses(projectRoot) {
 
     return mapPaths(oldPath, {
       find: {
-        directory: 'app/components',
+        directory: join('app', podPath, 'components'),
         file: 'component.js',
       },
       replace(key) {

diff --git a/src/migration/ember-app/app/component-stylesheets.js b/src/migration/ember-app/app/component-stylesheets.js
@@ -1,17 +1,23 @@
 import glob from 'glob';
+import { join } from 'node:path';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentStylesheets(projectRoot) {
-  const oldPaths = glob.sync('app/components/**/styles.{css,scss}', {
-    cwd: projectRoot,
-  });
+export function migrationStrategyForComponentStylesheets(options) {
+  const { podPath, projectRoot } = options;
+
+  const oldPaths = glob.sync(
+    join('app', podPath, 'components', '**', 'styles.{css,scss}'),
+    {
+      cwd: projectRoot,
+    }
+  );
 
   return oldPaths.map((oldPath) => {
     if (oldPath.endsWith('.scss')) {
       return mapPaths(oldPath, {
         find: {
-          directory: 'app/components',
+          directory: join('app', podPath, 'components'),
           file: 'styles.scss',
         },
         replace(key) {
@@ -22,7 +28,7 @@ export function migrationStrategyForComponentStylesheets(projectRoot) {
 
     return mapPaths(oldPath, {
       find: {
-        directory: 'app/components',
+        directory: join('app', podPath, 'components'),
         file: 'styles.css',
       },
       replace(key) {

diff --git a/src/migration/ember-app/app/component-templates.js b/src/migration/ember-app/app/component-templates.js
@@ -1,16 +1,22 @@
 import glob from 'glob';
+import { join } from 'node:path';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForComponentTemplates(projectRoot) {
-  const oldPaths = glob.sync('app/components/**/template.hbs', {
-    cwd: projectRoot,
-  });
+export function migrationStrategyForComponentTemplates(options) {
+  const { podPath, projectRoot } = options;
+
+  const oldPaths = glob.sync(
+    join('app', podPath, 'components', '**', 'template.hbs'),
+    {
+      cwd: projectRoot,
+    }
+  );
 
   return oldPaths.map((oldPath) => {
     return mapPaths(oldPath, {
       find: {
-        directory: 'app/components',
+        directory: join('app', podPath, 'components'),
         file: 'template.hbs',
       },
       replace(key) {

diff --git a/src/migration/ember-app/app/index.js b/src/migration/ember-app/app/index.js
@@ -10,18 +10,18 @@ import { migrationStrategyForRouteStylesheets } from './route-stylesheets.js';
 import { migrationStrategyForRouteTemplates } from './route-templates.js';
 import { migrationStrategyForServices } from './services.js';
 
-export function migrationStrategyForAppFolder(projectRoot) {
+export function migrationStrategyForAppFolder(options) {
   return new Map([
-    ...migrationStrategyForComponentClasses(projectRoot),
-    ...migrationStrategyForComponentStylesheets(projectRoot),
-    ...migrationStrategyForComponentTemplates(projectRoot),
-    ...migrationStrategyForRouteAdapters(projectRoot),
-    ...migrationStrategyForRouteControllers(projectRoot),
-    ...migrationStrategyForRouteModels(projectRoot),
-    ...migrationStrategyForRouteRoutes(projectRoot),
-    ...migrationStrategyForRouteSerializers(projectRoot),
-    ...migrationStrategyForRouteStylesheets(projectRoot),
-    ...migrationStrategyForRouteTemplates(projectRoot),
-    ...migrationStrategyForServices(projectRoot),
+    ...migrationStrategyForComponentClasses(options),
+    ...migrationStrategyForComponentStylesheets(options),
+    ...migrationStrategyForComponentTemplates(options),
+    ...migrationStrategyForRouteAdapters(options),
+    ...migrationStrategyForRouteControllers(options),
+    ...migrationStrategyForRouteModels(options),
+    ...migrationStrategyForRouteRoutes(options),
+    ...migrationStrategyForRouteSerializers(options),
+    ...migrationStrategyForRouteStylesheets(options),
+    ...migrationStrategyForRouteTemplates(options),
+    ...migrationStrategyForServices(options),
   ]);
 }
diff --git a/src/migration/ember-app/app/route-adapters.js b/src/migration/ember-app/app/route-adapters.js
@@ -1,17 +1,20 @@
 import glob from 'glob';
+import { join } from 'node:path';
 
 import { mapPaths } from '../../../utils/map-paths.js';
 
-export function migrationStrategyForRouteAdapters(projectRoot) {
-  const oldPaths = glob.sync('app/**/adapter.{js,ts}', {
+export function migrationStrategyForRouteAdapters(options) {
+  const { podPath, projectRoot } = options;
+
+  const oldPaths = glob.sync(join('app', podPath, '**', 'adapter.{js,ts}'), {
     cwd: projectRoot,
   });
 
   return oldPaths.map((oldPath) => {
     if (oldPath.endsWith('.ts')) {
       return mapPaths(oldPath, {
         find: {
-          directory: 'app',
+          directory: join('app', podPath),
           file: 'adapter.ts',
         },
         replace(key) {
@@ -22,7 +25,7 @@ export function migrationStrategyForRouteAdapters(projectRoot) {
 
     return mapPaths(oldPath, {
       find: {
-        directory: 'app',
+        directory: join('app', podPath),
         file: 'adapter.js',
       },
       replace(key) {