ember-codemod-v1-to-v2 0.1.2 → 0.1.4

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.2",
+  "version": "0.1.4",
   "description": "Codemod to convert Ember addons to v2 addon format",
   "keywords": [
     "codemod",
@@ -56,7 +56,7 @@
     "eslint": "^8.32.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-simple-import-sort": "^9.0.0",
     "fixturify": "^3.0.0",
     "lerna-changelog": "^2.2.0",
     "prettier": "^2.8.3"

package/src/blueprints/ember-addon/__addonLocation__/unpublished-development-types/index.d.ts

@@ -1,7 +1,7 @@
 // Add any types here that you need for local development only.
 // These will *not* be published as part of your addon, so be careful that your published code does not rely on them!
-
-<% if (options.packages.addon.hasGlint) { %>import '@glint/environment-ember-loose';
+<% if (options.packages.addon.hasGlint) { %>
+import '@glint/environment-ember-loose';
 
 declare module '@glint/environment-ember-loose/registry' {
   // Remove this once entries have been added! 👇
@@ -10,4 +10,5 @@ declare module '@glint/environment-ember-loose/registry' {
     // Add any registry entries from other addons here that your addon itself uses (in non-strict mode templates)
     // See https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons
   }
-}<% } %>
+}
+<% } %>

package/src/blueprints/ember-addon/package.json

@@ -16,7 +16,7 @@
     "prepare": "npm run build",
     "start": "concurrently 'npm:start:*' --restart-after 5000 --prefix-colors cyan,white,yellow",
     "start:addon": "npm start --workspace <%= options.packages.addon.name %>",
-    "start:tests": "npm start --workspace <%= options.packages.testApp.name %>",
+    "start:test-app": "npm start --workspace <%= options.packages.testApp.name %>",
     "test": "npm run test --workspaces --if-present"
   },
   "devDependencies": {
@@ -41,7 +41,7 @@
     "prepare": "pnpm build",
     "start": "concurrently 'npm:start:*' --restart-after 5000 --prefix-colors cyan,white,yellow",
     "start:addon": "pnpm --filter <%= options.packages.addon.name %> start",
-    "start:test": "pnpm --filter <%= options.packages.testApp.name %> start",
+    "start:test-app": "pnpm --filter <%= options.packages.testApp.name %> start",
     "test": "pnpm --filter '*' test"
   },
   "devDependencies": {
@@ -66,7 +66,7 @@
     "prepare": "yarn build",
     "start": "concurrently 'npm:start:*' --restart-after 5000 --prefix-colors cyan,white,yellow",
     "start:addon": "yarn workspace <%= options.packages.addon.name %> run start",
-    "start:test": "yarn workspace <%= options.packages.testApp.name %> run start",
+    "start:test-app": "yarn workspace <%= options.packages.testApp.name %> run start",
     "test": "yarn workspaces run test"
   },
   "devDependencies": {

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/move-project-root-files.js

@@ -33,6 +33,7 @@ function moveToAddonAndTestApp(options) {
 
   const files = packages.addon.hasTypeScript
     ? [
+        '.eslintignore',
         '.eslintrc.js',
         '.gitignore',
         '.prettierignore',
@@ -43,6 +44,7 @@ function moveToAddonAndTestApp(options) {
         'tsconfig.json',
       ]
     : [
+        '.eslintignore',
         '.eslintrc.js',
         '.gitignore',
         '.prettierignore',
@@ -83,7 +85,6 @@ function moveToTestApp(options) {
 
   const files = [
     '.ember-cli',
-    '.eslintignore',
     '.watchmanconfig',
     'ember-cli-build.js',
     'testem.js',

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

@@ -7,7 +7,7 @@ import {
 } from '../../../utils/convert-json-object.js';
 import { decideVersion } from '../../../utils/decide-version.js';
 
-function updateDependencies(packageJson) {
+function updateDependencies(packageJson, options) {
   const dependencies = convertToMap(packageJson['dependencies']);
 
   const packagesToDelete = [
@@ -17,14 +17,14 @@ 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);
+    const version = decideVersion(packageName, options);
 
     dependencies.set(packageName, version);
   });
@@ -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,15 +70,8 @@ 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);
+    const version = decideVersion(packageName, options);
 
     devDependencies.set(packageName, version);
   });
@@ -119,7 +117,7 @@ export function updateAddonPackageJson(options) {
   const oldFile = readFileSync(oldPath, 'utf8');
   const packageJson = JSON.parse(oldFile);
 
-  updateDependencies(packageJson);
+  updateDependencies(packageJson, options);
   updateDevDependencies(packageJson, options);
   updateScripts(packageJson);
   updateOtherFields(packageJson);

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

@@ -4,6 +4,7 @@ import { join } from 'node:path';
 import {
   convertToMap,
   convertToObject,
+  sanitizeJson,
 } from '../../../utils/convert-json-object.js';
 
 function updateCompilerOptions(tsconfigJson) {
@@ -28,10 +29,7 @@ export function updateAddonTsconfigJson(options) {
 
   const oldPath = join(projectRoot, locations.addon, 'tsconfig.json');
   const oldFile = readFileSync(oldPath, 'utf8');
-  const tsconfigJson = JSON.parse(
-    // Remove comments
-    oldFile.replace(new RegExp('//.*', 'mg'), '')
-  );
+  const tsconfigJson = JSON.parse(sanitizeJson(oldFile));
 
   updateCompilerOptions(tsconfigJson);
   updateInclude(tsconfigJson);

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

@@ -23,7 +23,7 @@ function moveDependenciesToDevDependencies(packageJson, options) {
     : ['ember-auto-import', 'ember-cli-babel', 'ember-cli-htmlbars'];
 
   packagesToMove.forEach((packageName) => {
-    const version = decideVersion(packageName, dependencies);
+    const version = decideVersion(packageName, options);
 
     devDependencies.set(packageName, version);
 
@@ -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;
 

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

@@ -4,6 +4,7 @@ import { join } from 'node:path';
 import {
   convertToMap,
   convertToObject,
+  sanitizeJson,
 } from '../../../utils/convert-json-object.js';
 
 function updateCompilerOptions(tsconfigJson, options) {
@@ -33,10 +34,7 @@ export function updateTestAppTsconfigJson(options) {
 
   const oldPath = join(projectRoot, locations.testApp, 'tsconfig.json');
   const oldFile = readFileSync(oldPath, 'utf8');
-  const tsconfigJson = JSON.parse(
-    // Remove comments
-    oldFile.replace(new RegExp('//.*', 'mg'), '')
-  );
+  const tsconfigJson = JSON.parse(sanitizeJson(oldFile));
 
   updateCompilerOptions(tsconfigJson, options);
   updateInclude(tsconfigJson);

package/src/utils/convert-json-object.js

@@ -7,3 +7,8 @@ export function convertToObject(map) {
 
   return Object.fromEntries(sortedMap);
 }
+
+export function sanitizeJson(jsonFile) {
+  // Remove comments
+  return jsonFile.replace(new RegExp('//.*', 'mg'), '');
+}

package/src/utils/decide-version.js

@@ -16,8 +16,10 @@ const latestVersions = new Map([
   ['rollup-plugin-ts', '3.1.1'],
 ]);
 
-export function decideVersion(packageName, projectDependencies) {
-  const installedVersion = projectDependencies.get(packageName);
+export function decideVersion(packageName, options) {
+  const { packages } = options;
+
+  const installedVersion = packages.addon.dependencies.get(packageName);
   const latestVersion = `^${latestVersions.get(packageName)}`;
 
   return installedVersion ?? latestVersion;