ember-codemod-v1-to-v2 0.1.1 → 0.1.3

package/README.md

@@ -11,7 +11,7 @@ _Codemod to convert Ember addons to v2 addon format_
 - Switches Ember's "magic" import paths to relative paths
 - Preserves your code whenever possible
 - Supports [`ember-cli-typescript`](https://docs.ember-cli-typescript.com/) and [`glint`](https://typed-ember.gitbook.io/glint/)
-- Focuses on maintainbility and extensibility
+- Focuses on maintainability and extensibility
 
 
 ## Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-codemod-v1-to-v2",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Codemod to convert Ember addons to v2 addon format",
   "keywords": [
     "codemod",

package/src/migration/ember-addon/steps/augment-options.js

@@ -20,6 +20,14 @@ function analyzePackageJson(options) {
       version,
     } = JSON.parse(packageJsonFile);
 
+    if (!name) {
+      throw new SyntaxError('Package name is missing.');
+    }
+
+    if (!version) {
+      throw new SyntaxError('Package version is missing.');
+    }
+
     const projectDependencies = new Map([
       ...Object.entries(dependencies ?? {}),
       ...Object.entries(devDependencies ?? {}),
@@ -35,7 +43,7 @@ function analyzePackageJson(options) {
     };
   } catch (e) {
     throw new SyntaxError(
-      `ERROR: package.json is missing or is not a valid JSON. (${e.message})\n`
+      `ERROR: package.json is missing or is not valid. (${e.message})\n`
     );
   }
 }
@@ -67,27 +75,21 @@ function analyzePackageManager(options) {
 }
 
 function deriveAddonLocation(addonPackage) {
-  if (!addonPackage.name) {
-    throw new RangeError(
-      `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.`
-    );
+  // Package is not scoped
+  if (!addonPackage.name.includes('/')) {
+    return addonPackage.name;
   }
 
-  // Package is scoped
-  if (addonPackage.name.includes('/')) {
-    // eslint-disable-next-line no-unused-vars
-    const [scope, packageName] = addonPackage.name.split('/');
+  // eslint-disable-next-line no-unused-vars
+  const [scope, packageName] = addonPackage.name.split('/');
 
-    if (!packageName) {
-      throw new SyntaxError(
-        `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.`
-      );
-    }
-
-    return packageName;
+  if (!packageName) {
+    throw new SyntaxError(
+      `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.`
+    );
   }
 
-  return addonPackage.name;
+  return packageName;
 }
 
 export function augmentOptions(options) {

package/src/migration/ember-addon/steps/create-files-from-blueprint.js

@@ -1,11 +1,21 @@
 import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 import glob from 'glob';
 
 import { createFiles } from '../../../utils/files.js';
 import { processTemplate } from '../../../utils/process-template.js';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+function getBlueprintRoot() {
+  const codemodRoot = join(__dirname, '../../../..');
+
+  return join(codemodRoot, 'src/blueprints/ember-addon');
+}
+
 function getFilePath(blueprintFilePath, options) {
   const { locations } = options;
 
@@ -36,7 +46,7 @@ function getFilesToSkip(options) {
 }
 
 export function createFilesFromBlueprint(context, options) {
-  const blueprintRoot = 'src/blueprints/ember-addon';
+  const blueprintRoot = getBlueprintRoot();
 
   const filesToSkip = getFilesToSkip(options);
 

package/src/migration/ember-addon/steps/update-addon-package-json.js

@@ -17,12 +17,12 @@ function updateDependencies(packageJson) {
     'ember-cli-htmlbars',
   ];
 
-  const packagesToInstall = ['@embroider/addon-shim'];
-
   packagesToDelete.forEach((packageName) => {
     dependencies.delete(packageName);
   });
 
+  const packagesToInstall = ['@embroider/addon-shim'];
+
   packagesToInstall.forEach((packageName) => {
     const version = decideVersion(packageName, dependencies);
 
@@ -37,12 +37,17 @@ function updateDevDependencies(packageJson, options) {
 
   const devDependencies = convertToMap(packageJson['devDependencies']);
 
-  const packagesToDelete = [
-    '@embroider/macros',
-    'ember-auto-import',
-    'ember-cli-babel',
-    'ember-cli-htmlbars',
-  ];
+  /*
+    For the time being, we'll take the approach of starting over and
+    adding back the development dependencies that are required. For
+    a more conservative approach, we could delete only the following:
+
+      - @embroider/macros
+      - ember-auto-import
+      - ember-cli-babel
+      - ember-cli-htmlbars
+  */
+  devDependencies.clear();
 
   const packagesToInstall = packages.addon.hasTypeScript
     ? [
@@ -65,13 +70,6 @@ function updateDevDependencies(packageJson, options) {
         'rollup-plugin-copy',
       ];
 
-  // May be easier to start over and add missing dependencies
-  devDependencies.clear();
-
-  packagesToDelete.forEach((packageName) => {
-    devDependencies.delete(packageName);
-  });
-
   packagesToInstall.forEach((packageName) => {
     const version = decideVersion(packageName, devDependencies);
 

package/src/migration/ember-addon/steps/update-test-app-package-json.js

@@ -37,7 +37,10 @@ function moveDependenciesToDevDependencies(packageJson, options) {
 function updateDependencies(packageJson) {
   const dependencies = convertToMap(packageJson['dependencies']);
 
-  // May be easier to start over and add missing dependencies
+  /*
+    For the time being, we'll take the approach of starting over and
+    adding back the dependencies that are required.
+  */
   dependencies.clear();
 
   packageJson['dependencies'] = convertToObject(dependencies);
@@ -58,9 +61,9 @@ function updateOtherFields(packageJson, options) {
 
   delete packageJson['ember-addon'];
 
-  packageJson['keywords'] = packageJson['keywords'].filter((keyword) => {
-    return keyword !== 'ember-addon';
-  });
+  packageJson['keywords'] = (packageJson['keywords'] ?? []).filter(
+    (keyword) => keyword !== 'ember-addon'
+  );
 
   packageJson['name'] = packages.testApp.name;