Merged v1-addon and engine (#65)

* breaking: Ignored styles.js in an addon's app folder

* feature: Handled controllers, routes, services, and route templates in v1 addons

* refactor: Used migrateV1Addon() to migrate engines

* breaking: Removed engine as a possible option for --type

* refactor: Removed unused code

---------

Co-authored-by: ijlee2 <[email protected]>

README.md

@@ -32,9 +32,11 @@ Step 3. Update references originating from, as well as pointing to, the moved fi
 You must pass `--type` to indicate what type of project you have.
 
 ```sh
+# For classic apps
 npx ember-codemod-pod-to-octane --type app
+
+# For v1 addons (including engines)
 npx ember-codemod-pod-to-octane --type v1-addon
-npx ember-codemod-pod-to-octane --type engine
 ```
 
 
@@ -103,16 +105,7 @@ To account for a bug (found when Ember CLI is combined with Ember Data), the cod
 
 <summary>Addons</summary>
 
-The codemod assumes that an addon is used to define components (not models or routes).
-
-</details>
-
-
-<details>
-
-<summary>Engines</summary>
-
-The codemod assumes that an engine is used to define routes and route-specific components.
+The codemod doesn't consider things related to Ember Data (i.e. adapters, models, and serializers).
 
 </details>
 

bin/ember-codemod-pod-to-octane.ts

@@ -27,7 +27,7 @@ const argv = yargs(hideBin(process.argv))
     type: 'boolean',
   })
   .option('type', {
-    choices: ['app', 'engine', 'v1-addon'] as const,
+    choices: ['app', 'v1-addon'] as const,
     demandOption: true,
     describe: 'Type of your Ember project',
     type: 'string',

src/index.ts

@@ -1,8 +1,4 @@
-import {
-  migrateApp,
-  migrateEngine,
-  migrateV1Addon,
-} from './migration/index.js';
+import { migrateApp, migrateV1Addon } from './migration/index.js';
 import type { CodemodOptions } from './types/index.js';
 
 export function runCodemod(codemodOptions: CodemodOptions): void {
@@ -12,11 +8,6 @@ export function runCodemod(codemodOptions: CodemodOptions): void {
       break;
     }
 
-    case 'engine': {
-      migrateEngine(codemodOptions);
-      break;
-    }
-
     case 'v1-addon': {
       migrateV1Addon(codemodOptions);
       break;

src/migration/index.ts

@@ -1,3 +1,2 @@
 export * from './app/index.js';
-export * from './engine/index.js';
 export * from './v1-addon/index.js';

src/migration/v1-addon/steps/create-file-path-maps/addon/index.ts

@@ -2,11 +2,21 @@ import type { FilePathMap, Options } from '../../../../../types/index.js';
 import { mapComponentClasses } from './map-component-classes.js';
 import { mapComponentStylesheets } from './map-component-stylesheets.js';
 import { mapComponentTemplates } from './map-component-templates.js';
+import { mapRouteControllers } from './map-route-controllers.js';
+import { mapRouteRoutes } from './map-route-routes.js';
+import { mapRouteStylesheets } from './map-route-stylesheets.js';
+import { mapRouteTemplates } from './map-route-templates.js';
+import { mapServices } from './map-services.js';
 
 export function mapAddonFolder(options: Options): FilePathMap {
   return new Map([
     ...mapComponentClasses(options),
     ...mapComponentStylesheets(options),
     ...mapComponentTemplates(options),
+    ...mapRouteControllers(options),
+    ...mapRouteRoutes(options),
+    ...mapRouteStylesheets(options),
+    ...mapRouteTemplates(options),
+    ...mapServices(options),
   ]);
 }

src/migration/v1-addon/steps/create-file-path-maps/app/map-component-stylesheets.ts → src/migration/v1-addon/steps/create-file-path-maps/addon/map-services.ts

@@ -6,18 +6,18 @@ import type {
 } from '../../../../../types/index.js';
 import { renamePodPath } from '../../../../../utils/files/index.js';
 
-export function mapComponentStylesheets(options: Options): FilePathMapEntries {
+export function mapServices(options: Options): FilePathMapEntries {
   const { projectRoot } = options;
 
-  const filePaths = findFiles('app/components/**/styles.js', {
+  const filePaths = findFiles('addon/**/service.{js,ts}', {
     projectRoot,
   });
 
   return filePaths.map((oldFilePath) => {
     const newFilePath = renamePodPath(oldFilePath, {
-      entityDir: 'app/components',
+      entityDir: 'addon',
       replace: (key: string) => {
-        return `app/components/${key}`;
+        return `addon/services/${key}`;
       },
     });
 

src/migration/v1-addon/steps/create-file-path-maps/app/index.ts

@@ -1,12 +1,18 @@
 import type { FilePathMap, Options } from '../../../../../types/index.js';
 import { mapComponentClasses } from './map-component-classes.js';
-import { mapComponentStylesheets } from './map-component-stylesheets.js';
 import { mapComponentTemplates } from './map-component-templates.js';
+import { mapRouteControllers } from './map-route-controllers.js';
+import { mapRouteRoutes } from './map-route-routes.js';
+import { mapRouteTemplates } from './map-route-templates.js';
+import { mapServices } from './map-services.js';
 
 export function mapAppFolder(options: Options): FilePathMap {
   return new Map([
     ...mapComponentClasses(options),
-    ...mapComponentStylesheets(options),
     ...mapComponentTemplates(options),
+    ...mapRouteControllers(options),
+    ...mapRouteRoutes(options),
+    ...mapRouteTemplates(options),
+    ...mapServices(options),
   ]);
 }

src/migration/engine/steps/create-file-path-maps/addon/map-component-classes.ts → src/migration/v1-addon/steps/create-file-path-maps/app/map-route-controllers.ts

@@ -6,18 +6,18 @@ import type {
 } from '../../../../../types/index.js';
 import { renamePodPath } from '../../../../../utils/files/index.js';
 
-export function mapComponentClasses(options: Options): FilePathMapEntries {
+export function mapRouteControllers(options: Options): FilePathMapEntries {
   const { projectRoot } = options;
 
-  const filePaths = findFiles('addon/components/**/component.{d.ts,js,ts}', {
+  const filePaths = findFiles('app/**/controller.js', {
     projectRoot,
   });
 
   return filePaths.map((oldFilePath) => {
     const newFilePath = renamePodPath(oldFilePath, {
-      entityDir: 'addon/components',
+      entityDir: 'app',
       replace: (key: string) => {
-        return `addon/components/${key}`;
+        return `app/controllers/${key}`;
       },
     });
 

src/migration/engine/steps/create-file-path-maps/addon/map-component-stylesheets.ts → src/migration/v1-addon/steps/create-file-path-maps/app/map-route-routes.ts

@@ -6,18 +6,18 @@ import type {
 } from '../../../../../types/index.js';
 import { renamePodPath } from '../../../../../utils/files/index.js';
 
-export function mapComponentStylesheets(options: Options): FilePathMapEntries {
+export function mapRouteRoutes(options: Options): FilePathMapEntries {
   const { projectRoot } = options;
 
-  const filePaths = findFiles('addon/components/**/styles.{css,scss}', {
+  const filePaths = findFiles('app/**/route.js', {
     projectRoot,
   });
 
   return filePaths.map((oldFilePath) => {
     const newFilePath = renamePodPath(oldFilePath, {
-      entityDir: 'addon/components',
+      entityDir: 'app',
       replace: (key: string) => {
-        return `addon/components/${key}`;
+        return `app/routes/${key}`;
       },
     });
 

src/migration/engine/steps/create-file-path-maps/addon/map-component-templates.ts → src/migration/v1-addon/steps/create-file-path-maps/app/map-route-templates.ts

@@ -6,18 +6,18 @@ import type {
 } from '../../../../../types/index.js';
 import { renamePodPath } from '../../../../../utils/files/index.js';
 
-export function mapComponentTemplates(options: Options): FilePathMapEntries {
+export function mapRouteTemplates(options: Options): FilePathMapEntries {
   const { projectRoot } = options;
 
-  const filePaths = findFiles('addon/components/**/template.hbs', {
+  const filePaths = findFiles('app/!(components)/**/template.js', {
     projectRoot,
   });
 
   return filePaths.map((oldFilePath) => {
     const newFilePath = renamePodPath(oldFilePath, {
-      entityDir: 'addon/components',
+      entityDir: 'app',
       replace: (key: string) => {
-        return `addon/components/${key}`;
+        return `app/templates/${key}`;
       },
     });
 

src/migration/v1-addon/steps/create-file-path-maps/app/map-services.ts

@@ -0,0 +1,26 @@
+import { findFiles } from '@codemod-utils/files';
+
+import type {
+  FilePathMapEntries,
+  Options,
+} from '../../../../../types/index.js';
+import { renamePodPath } from '../../../../../utils/files/index.js';
+
+export function mapServices(options: Options): FilePathMapEntries {
+  const { projectRoot } = options;
+
+  const filePaths = findFiles('app/**/service.js', {
+    projectRoot,
+  });
+
+  return filePaths.map((oldFilePath) => {
+    const newFilePath = renamePodPath(oldFilePath, {
+      entityDir: 'app',
+      replace: (key: string) => {
+        return `app/services/${key}`;
+      },
+    });
+
+    return [oldFilePath, newFilePath];
+  });
+}

src/migration/v1-addon/steps/create-file-path-maps/tests/index.ts

@@ -1,6 +1,14 @@
 import type { FilePathMap, Options } from '../../../../../types/index.js';
 import { mapComponents } from './map-components.js';
+import { mapRouteControllers } from './map-route-controllers.js';
+import { mapRouteRoutes } from './map-route-routes.js';
+import { mapServices } from './map-services.js';
 
 export function mapTestsFolder(options: Options): FilePathMap {
-  return new Map([...mapComponents(options)]);
+  return new Map([
+    ...mapComponents(options),
+    ...mapRouteControllers(options),
+    ...mapRouteRoutes(options),
+    ...mapServices(options),
+  ]);
 }

src/migration/engine/steps/create-file-path-maps/tests/map-components.ts → src/migration/v1-addon/steps/create-file-path-maps/tests/map-services.ts

@@ -1,3 +1,5 @@
+import { join } from 'node:path';
+
 import { findFiles } from '@codemod-utils/files';
 
 import type {
@@ -6,21 +8,21 @@ import type {
 } from '../../../../../types/index.js';
 import { renamePodPath } from '../../../../../utils/files/index.js';
 
-export function mapComponents(options: Options): FilePathMapEntries {
+export function mapServices(options: Options): FilePathMapEntries {
   const { projectRoot } = options;
 
   const filePaths = findFiles(
-    'tests/integration/components/**/component-test.{js,ts}',
+    join('tests/unit/!(services)/**/service-test.{js,ts}'),
     {
       projectRoot,
     },
   );
 
   return filePaths.map((oldFilePath) => {
     const newFilePath = renamePodPath(oldFilePath, {
-      entityDir: 'tests/integration/components',
+      entityDir: 'tests/unit',
       replace: (key: string) => {
-        return `tests/integration/components/${key}-test`;
+        return `tests/unit/services/${key}-test`;
       },
     });
 

src/types/index.ts

@@ -3,7 +3,7 @@ import type { FilePath, FilePathMap } from '@codemod-utils/files';
 type CodemodOptions = {
   podPath: string;
   projectRoot: string;
-  projectType: 'app' | 'engine' | 'v1-addon';
+  projectType: 'app' | 'v1-addon';
   testRun: boolean;
 };
 
@@ -12,7 +12,7 @@ type FilePathMapEntries = [FilePath, FilePath][];
 type Options = {
   podPath: string;
   projectRoot: string;
-  projectType: 'app' | 'engine' | 'v1-addon';
+  projectType: 'app' | 'v1-addon';
   testRun: boolean;
 };