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

package/bin/ember-codemod-v1-to-v2.js

@@ -32,11 +32,11 @@ function castEmptyStringToUndefined(string) {
   return string === '' ? undefined : string;
 }
 
-const options = {
+const codemodOptions = {
   addonLocation: castEmptyStringToUndefined(argv['addon-location']),
   projectRoot: argv['root'] ?? process.cwd(),
   testAppLocation: castEmptyStringToUndefined(argv['test-app-location']),
   testAppName: castEmptyStringToUndefined(argv['test-app-name']),
 };
 
-runCodemod(options);
+runCodemod(codemodOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-codemod-v1-to-v2",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Codemod to convert Ember addons to v2 addon format",
   "keywords": [
     "codemod",
@@ -49,6 +49,7 @@
     "@babel/eslint-parser": "^7.19.1",
     "glob": "^8.1.0",
     "lodash.template": "^4.5.0",
+    "strip-json-comments": "^5.0.0",
     "yargs": "^17.6.2"
   },
   "devDependencies": {

package/src/blueprints/ember-addon/__addonLocation__/rollup.config.js

@@ -15,12 +15,12 @@ export default {
   plugins: [
     // These are the modules that users should be able to import from your
     // addon. Anything not listed here may get optimized away.
-    addon.publicEntrypoints([<%= context.publicEntrypoints.map((filePath) => `'${filePath}'`).join(', ') %>]),
+    addon.publicEntrypoints([<%= context.addon.publicEntrypoints.map((filePath) => `'${filePath}'`).join(', ') %>]),
 
     // These are the modules that should get reexported into the traditional
     // "app" tree. Things in here should also be in publicEntrypoints above, but
     // not everything in publicEntrypoints necessarily needs to go here.
-    addon.appReexports([<%= context.appReexports.map((filePath) => `'${filePath}'`).join(', ') %>]),
+    addon.appReexports([<%= context.addon.appReexports.map((filePath) => `'${filePath}'`).join(', ') %>]),
 
     // Follow the V2 Addon rules about dependencies. Your code can import from
     // `dependencies` and `peerDependencies` as well as standard Ember-provided

package/src/blueprints/ember-addon/__addonLocation__/rollup.config.mjs

@@ -15,12 +15,12 @@ export default {
   plugins: [
     // These are the modules that users should be able to import from your
     // addon. Anything not listed here may get optimized away.
-    addon.publicEntrypoints([<%= context.publicEntrypoints.map((filePath) => `'${filePath}'`).join(', ') %>]),
+    addon.publicEntrypoints([<%= context.addon.publicEntrypoints.map((filePath) => `'${filePath}'`).join(', ') %>]),
 
     // These are the modules that should get reexported into the traditional
     // "app" tree. Things in here should also be in publicEntrypoints above, but
     // not everything in publicEntrypoints necessarily needs to go here.
-    addon.appReexports([<%= context.appReexports.map((filePath) => `'${filePath}'`).join(', ') %>]),
+    addon.appReexports([<%= context.addon.appReexports.map((filePath) => `'${filePath}'`).join(', ') %>]),
 
     // Follow the V2 Addon rules about dependencies. Your code can import from
     // `dependencies` and `peerDependencies` as well as standard Ember-provided

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

@@ -20,8 +20,8 @@
     "test": "npm run test --workspaces --if-present"
   },
   "devDependencies": {
-    "concurrently": "<%= options.packages.addon.dependencies.get('concurrently') ?? '^7.6.0' %>",
-    "prettier": "<%= options.packages.addon.dependencies.get('prettier') ?? '^2.8.3' %>"
+    "concurrently": "<%= context.projectRoot.devDependencies['concurrently'] %>",
+    "prettier": "<%= context.projectRoot.devDependencies['prettier'] %>"
   }
 }<% } else if (options.packageManager.isPnpm) { %>{
   "name": "<%= options.packages.addon.name %>",
@@ -45,8 +45,8 @@
     "test": "pnpm --filter '*' test"
   },
   "devDependencies": {
-    "concurrently": "<%= options.packages.addon.dependencies.get('concurrently') ?? '^7.6.0' %>",
-    "prettier": "<%= options.packages.addon.dependencies.get('prettier') ?? '^2.8.3' %>"
+    "concurrently": "<%= context.projectRoot.devDependencies['concurrently'] %>",
+    "prettier": "<%= context.projectRoot.devDependencies['prettier'] %>"
   }
 }<% } else if (options.packageManager.isYarn) { %>{
   "name": "<%= options.packages.addon.name %>",
@@ -70,7 +70,7 @@
     "test": "yarn workspaces run test"
   },
   "devDependencies": {
-    "concurrently": "<%= options.packages.addon.dependencies.get('concurrently') ?? '^7.6.0' %>",
-    "prettier": "<%= options.packages.addon.dependencies.get('prettier') ?? '^2.8.3' %>"
+    "concurrently": "<%= context.projectRoot.devDependencies['concurrently'] %>",
+    "prettier": "<%= context.projectRoot.devDependencies['prettier'] %>"
   }
 }<% } %>

package/src/index.js

@@ -1,5 +1,5 @@
 import { migrateEmberAddon } from './migration/index.js';
 
-export function runCodemod(options) {
-  migrateEmberAddon(options);
+export function runCodemod(codemodOptions) {
+  migrateEmberAddon(codemodOptions);
 }

package/src/migration/ember-addon/index.js

@@ -1,7 +1,7 @@
 import {
   analyzeAddon,
-  augmentOptions,
   createFilesFromBlueprint,
+  createOptions,
   moveAddonFiles,
   moveProjectRootFiles,
   moveTestAppFiles,
@@ -12,9 +12,9 @@ import {
   useRelativePaths,
 } from './steps/index.js';
 
-export function migrateEmberAddon(options) {
-  const augmentedOptions = augmentOptions(options);
-  const { isV1Addon } = augmentedOptions.packages.addon;
+export function migrateEmberAddon(codemodOptions) {
+  const options = createOptions(codemodOptions);
+  const { isV1Addon } = options.packages.addon;
 
   // Guarantee idempotency
   if (!isV1Addon) {
@@ -22,20 +22,20 @@ export function migrateEmberAddon(options) {
   }
 
   // Prepare for migration
-  const context = analyzeAddon(augmentedOptions);
-  useRelativePaths(augmentedOptions);
+  const context = analyzeAddon(options);
+  useRelativePaths(options);
 
   // Preserve code
-  moveAddonFiles(augmentedOptions);
-  moveTestAppFiles(augmentedOptions);
-  moveProjectRootFiles(augmentedOptions);
+  moveAddonFiles(options);
+  moveTestAppFiles(options);
+  moveProjectRootFiles(options);
 
   // Get the latest code from blueprint
-  createFilesFromBlueprint(context, augmentedOptions);
+  createFilesFromBlueprint(context, options);
 
   // Fine-tune individual files
-  updateAddonPackageJson(augmentedOptions);
-  updateAddonTsconfigJson(augmentedOptions);
-  updateTestAppPackageJson(augmentedOptions);
-  updateTestAppTsconfigJson(augmentedOptions);
+  updateAddonPackageJson(options);
+  updateAddonTsconfigJson(options);
+  updateTestAppPackageJson(options);
+  updateTestAppTsconfigJson(options);
 }

package/src/migration/ember-addon/steps/analyze-addon.js

@@ -2,6 +2,8 @@ import { join } from 'node:path';
 
 import glob from 'glob';
 
+import { decideVersion } from '../../../utils/blueprints.js';
+
 function getAppReexports(options) {
   const { projectRoot } = options;
 
@@ -12,6 +14,13 @@ function getAppReexports(options) {
   return filePaths;
 }
 
+function getProjectRootDevDependencies(options) {
+  return {
+    concurrently: decideVersion('concurrently', options),
+    prettier: decideVersion('prettier', options),
+  };
+}
+
 function getPublicEntrypoints(options) {
   const { projectRoot } = options;
 
@@ -23,8 +32,13 @@ function getPublicEntrypoints(options) {
 }
 
 export function analyzeAddon(options) {
-  const appReexports = getAppReexports(options);
-  const publicEntrypoints = getPublicEntrypoints(options);
-
-  return { appReexports, publicEntrypoints };
+  return {
+    addon: {
+      appReexports: getAppReexports(options),
+      publicEntrypoints: getPublicEntrypoints(options),
+    },
+    projectRoot: {
+      devDependencies: getProjectRootDevDependencies(options),
+    },
+  };
 }

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

@@ -4,8 +4,8 @@ import { fileURLToPath } from 'node:url';
 
 import glob from 'glob';
 
+import { processTemplate } from '../../../utils/blueprints.js';
 import { createFiles } from '../../../utils/files.js';
-import { processTemplate } from '../../../utils/process-template.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);

package/src/migration/ember-addon/steps/{augment-options.js → create-options.js}

@@ -3,8 +3,8 @@ import { join } from 'node:path';
 
 import glob from 'glob';
 
-function analyzePackageJson(options) {
-  const { projectRoot } = options;
+function analyzePackageJson(codemodOptions) {
+  const { projectRoot } = codemodOptions;
 
   try {
     const packageJsonFile = readFileSync(
@@ -48,8 +48,8 @@ function analyzePackageJson(options) {
   }
 }
 
-function analyzePackageManager(options) {
-  const { projectRoot } = options;
+function analyzePackageManager(codemodOptions) {
+  const { projectRoot } = codemodOptions;
 
   const lockFiles = glob.sync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
     cwd: projectRoot,
@@ -92,22 +92,22 @@ function deriveAddonLocation(addonPackage) {
   return packageName;
 }
 
-export function augmentOptions(options) {
-  const addonPackage = analyzePackageJson(options);
-  const packageManager = analyzePackageManager(options);
+export function createOptions(codemodOptions) {
+  const addonPackage = analyzePackageJson(codemodOptions);
+  const packageManager = analyzePackageManager(codemodOptions);
 
   return {
     locations: {
-      addon: options.addonLocation ?? deriveAddonLocation(addonPackage),
-      testApp: options.testAppLocation ?? 'test-app',
+      addon: codemodOptions.addonLocation ?? deriveAddonLocation(addonPackage),
+      testApp: codemodOptions.testAppLocation ?? 'test-app',
     },
     packageManager,
     packages: {
       addon: addonPackage,
       testApp: {
-        name: options.testAppName ?? 'test-app',
+        name: codemodOptions.testAppName ?? 'test-app',
       },
     },
-    projectRoot: options.projectRoot,
+    projectRoot: codemodOptions.projectRoot,
   };
 }

package/src/migration/ember-addon/steps/index.js

@@ -1,6 +1,6 @@
 export * from './analyze-addon.js';
-export * from './augment-options.js';
 export * from './create-files-from-blueprint.js';
+export * from './create-options.js';
 export * from './move-addon-files.js';
 export * from './move-project-root-files.js';
 export * from './move-test-app-files.js';

package/src/migration/ember-addon/steps/move-addon-files.js

@@ -1,7 +1,6 @@
 import glob from 'glob';
 
-import { moveFiles, removeFiles } from '../../../utils/files.js';
-import { mapFilePaths } from '../../../utils/map-file-paths.js';
+import { mapFilePaths, moveFiles, removeFiles } from '../../../utils/files.js';
 
 function moveAddonFolder(options) {
   const { locations, projectRoot } = options;
@@ -63,12 +62,7 @@ function removeAppFolder(options) {
     nodir: true,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
-    from: 'app',
-    to: 'app',
-  });
-
-  removeFiles(pathMapping, options);
+  removeFiles(filePaths, options);
 }
 
 export function moveAddonFiles(options) {

package/src/migration/ember-addon/steps/move-project-root-files.js

@@ -1,7 +1,11 @@
 import glob from 'glob';
 
-import { copyFiles, moveFiles, removeFiles } from '../../../utils/files.js';
-import { mapFilePaths } from '../../../utils/map-file-paths.js';
+import {
+  copyFiles,
+  mapFilePaths,
+  moveFiles,
+  removeFiles,
+} from '../../../utils/files.js';
 
 function globPattern(files) {
   if (files.length <= 1) {
@@ -72,12 +76,7 @@ function moveToAddonAndTestApp(options) {
 
   copyFiles(pathMapping, options);
 
-  pathMapping = mapFilePaths(filePaths, {
-    from: '',
-    to: '',
-  });
-
-  removeFiles(pathMapping, options);
+  removeFiles(filePaths, options);
 }
 
 function moveToTestApp(options) {
@@ -111,12 +110,7 @@ function removeFromProjectRoot(options) {
     cwd: projectRoot,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
-    from: '',
-    to: '',
-  });
-
-  removeFiles(pathMapping, options);
+  removeFiles(filePaths, options);
 }
 
 export function moveProjectRootFiles(options) {

package/src/migration/ember-addon/steps/move-test-app-files.js

@@ -3,8 +3,7 @@ import { join } from 'node:path';
 
 import glob from 'glob';
 
-import { moveFiles } from '../../../utils/files.js';
-import { mapFilePaths } from '../../../utils/map-file-paths.js';
+import { mapFilePaths, moveFiles } from '../../../utils/files.js';
 
 function moveTestsFolder(options) {
   const { locations, projectRoot } = options;

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

@@ -1,11 +1,8 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import {
-  convertToMap,
-  convertToObject,
-} from '../../../utils/convert-json-object.js';
-import { decideVersion } from '../../../utils/decide-version.js';
+import { decideVersion } from '../../../utils/blueprints.js';
+import { convertToMap, convertToObject } from '../../../utils/json.js';
 
 function updateDependencies(packageJson, options) {
   const dependencies = convertToMap(packageJson['dependencies']);

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

@@ -5,7 +5,7 @@ import {
   convertToMap,
   convertToObject,
   sanitizeJson,
-} from '../../../utils/convert-json-object.js';
+} from '../../../utils/json.js';
 
 function updateCompilerOptions(tsconfigJson) {
   const compilerOptions = convertToMap(tsconfigJson['compilerOptions']);

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

@@ -1,11 +1,8 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import {
-  convertToMap,
-  convertToObject,
-} from '../../../utils/convert-json-object.js';
-import { decideVersion } from '../../../utils/decide-version.js';
+import { decideVersion } from '../../../utils/blueprints.js';
+import { convertToMap, convertToObject } from '../../../utils/json.js';
 
 function moveDependenciesToDevDependencies(packageJson, options) {
   const { packages } = options;

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

@@ -5,7 +5,7 @@ import {
   convertToMap,
   convertToObject,
   sanitizeJson,
-} from '../../../utils/convert-json-object.js';
+} from '../../../utils/json.js';
 
 function updateCompilerOptions(tsconfigJson, options) {
   const { packages } = options;

package/src/utils/{process-template.js → blueprints/process-template.js}

@@ -1,12 +1,12 @@
 /* https://github.com/ember-cli/ember-cli/blob/v4.9.2/lib/utilities/process-template.js */
 import template from 'lodash.template';
 
-export function processTemplate(content, context) {
-  const options = {
+export function processTemplate(file, data) {
+  const settings = {
     escape: /<%-([\s\S]+?)%>/g,
     evaluate: /<%([\s\S]+?)%>/g,
     interpolate: /<%=([\s\S]+?)%>/g,
   };
 
-  return template(content, options)(context);
+  return template(file, settings)(data);
 }

package/src/utils/blueprints.js

@@ -0,0 +1,2 @@
+export * from './blueprints/decide-version.js';
+export * from './blueprints/process-template.js';

package/src/utils/files/copy-files.js

@@ -0,0 +1,19 @@
+import { copyFileSync, existsSync, mkdirSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+
+export function copyFiles(pathMapping, options) {
+  const { projectRoot } = options;
+
+  pathMapping.forEach((newPath, oldPath) => {
+    const oldAbsolutePath = join(projectRoot, oldPath);
+
+    const newAbsolutePath = join(projectRoot, newPath);
+    const newDirectory = dirname(newAbsolutePath);
+
+    if (!existsSync(newDirectory)) {
+      mkdirSync(newDirectory, { recursive: true });
+    }
+
+    copyFileSync(oldAbsolutePath, newAbsolutePath);
+  });
+}

package/src/utils/files/create-files.js

@@ -0,0 +1,17 @@
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+
+export function createFiles(fileMapping, options) {
+  const { projectRoot } = options;
+
+  fileMapping.forEach((file, newPath) => {
+    const newAbsolutePath = join(projectRoot, newPath);
+    const newDirectory = dirname(newAbsolutePath);
+
+    if (!existsSync(newDirectory)) {
+      mkdirSync(newDirectory, { recursive: true });
+    }
+
+    writeFileSync(newAbsolutePath, file, 'utf8');
+  });
+}

package/src/utils/files/move-files.js

@@ -0,0 +1,22 @@
+import { existsSync, mkdirSync, renameSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+
+import { removeDirectoryIfEmpty } from './remove-directory-if-empty.js';
+
+export function moveFiles(pathMapping, options) {
+  const { projectRoot } = options;
+
+  pathMapping.forEach((newPath, oldPath) => {
+    const oldAbsolutePath = join(projectRoot, oldPath);
+
+    const newAbsolutePath = join(projectRoot, newPath);
+    const newDirectory = dirname(newAbsolutePath);
+
+    if (!existsSync(newDirectory)) {
+      mkdirSync(newDirectory, { recursive: true });
+    }
+
+    renameSync(oldAbsolutePath, newAbsolutePath);
+    removeDirectoryIfEmpty({ oldPath, projectRoot });
+  });
+}

package/src/utils/files/remove-directory-if-empty.js

@@ -0,0 +1,19 @@
+import { readdirSync, rmSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+
+export function removeDirectoryIfEmpty({ oldPath, projectRoot }) {
+  const directories = dirname(oldPath).split('/');
+  const depth = directories.length;
+
+  for (let i = 0; i < depth; i++) {
+    const directory = join(projectRoot, ...directories);
+    const numFilesLeft = readdirSync(directory).length;
+
+    if (numFilesLeft > 0) {
+      continue;
+    }
+
+    rmSync(directory, { recursive: true });
+    directories.pop();
+  }
+}

package/src/utils/files/remove-files.js

@@ -0,0 +1,15 @@
+import { rmSync } from 'node:fs';
+import { join } from 'node:path';
+
+import { removeDirectoryIfEmpty } from './remove-directory-if-empty.js';
+
+export function removeFiles(oldPaths, options) {
+  const { projectRoot } = options;
+
+  oldPaths.forEach((oldPath) => {
+    const oldAbsolutePath = join(projectRoot, oldPath);
+
+    rmSync(oldAbsolutePath);
+    removeDirectoryIfEmpty({ oldPath, projectRoot });
+  });
+}

package/src/utils/files.js

@@ -1,88 +1,6 @@
-import {
-  copyFileSync,
-  existsSync,
-  mkdirSync,
-  readdirSync,
-  renameSync,
-  rmSync,
-  writeFileSync,
-} from 'node:fs';
-import { dirname, join } from 'node:path';
-
-function removeDirectoryIfEmpty({ oldPath, projectRoot }) {
-  const directories = dirname(oldPath).split('/');
-  const depth = directories.length;
-
-  for (let i = 0; i < depth; i++) {
-    const directory = join(projectRoot, ...directories);
-    const numFilesLeft = readdirSync(directory).length;
-
-    if (numFilesLeft > 0) {
-      continue;
-    }
-
-    rmSync(directory, { recursive: true });
-    directories.pop();
-  }
-}
-
-export function copyFiles(pathMapping, options) {
-  const { projectRoot } = options;
-
-  pathMapping.forEach((newPath, oldPath) => {
-    const oldAbsolutePath = join(projectRoot, oldPath);
-
-    const newAbsolutePath = join(projectRoot, newPath);
-    const newDirectory = dirname(newAbsolutePath);
-
-    if (!existsSync(newDirectory)) {
-      mkdirSync(newDirectory, { recursive: true });
-    }
-
-    copyFileSync(oldAbsolutePath, newAbsolutePath);
-  });
-}
-
-export function createFiles(fileMapping, options) {
-  const { projectRoot } = options;
-
-  fileMapping.forEach((file, newPath) => {
-    const newAbsolutePath = join(projectRoot, newPath);
-    const newDirectory = dirname(newAbsolutePath);
-
-    if (!existsSync(newDirectory)) {
-      mkdirSync(newDirectory, { recursive: true });
-    }
-
-    writeFileSync(newAbsolutePath, file, 'utf8');
-  });
-}
-
-export function moveFiles(pathMapping, options) {
-  const { projectRoot } = options;
-
-  pathMapping.forEach((newPath, oldPath) => {
-    const oldAbsolutePath = join(projectRoot, oldPath);
-
-    const newAbsolutePath = join(projectRoot, newPath);
-    const newDirectory = dirname(newAbsolutePath);
-
-    if (!existsSync(newDirectory)) {
-      mkdirSync(newDirectory, { recursive: true });
-    }
-
-    renameSync(oldAbsolutePath, newAbsolutePath);
-    removeDirectoryIfEmpty({ oldPath, projectRoot });
-  });
-}
-
-export function removeFiles(pathMapping, options) {
-  const { projectRoot } = options;
-
-  pathMapping.forEach((newPath, oldPath) => {
-    const oldAbsolutePath = join(projectRoot, oldPath);
-
-    rmSync(oldAbsolutePath);
-    removeDirectoryIfEmpty({ oldPath, projectRoot });
-  });
-}
+export * from './files/copy-files.js';
+export * from './files/create-files.js';
+export * from './files/map-file-paths.js';
+export * from './files/move-files.js';
+export * from './files/remove-directory-if-empty.js';
+export * from './files/remove-files.js';

package/src/utils/json/convert-to-map.js

@@ -0,0 +1,3 @@
+export function convertToMap(object = {}) {
+  return new Map(Object.entries(object));
+}

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

@@ -0,0 +1,5 @@
+export function convertToObject(map) {
+  const sortedMap = new Map([...map.entries()].sort());
+
+  return Object.fromEntries(sortedMap);
+}

package/src/utils/json/sanitize-json.js

@@ -0,0 +1,7 @@
+import stripJsonComments from 'strip-json-comments';
+
+export function sanitizeJson(jsonFile) {
+  return stripJsonComments(jsonFile, {
+    whitespace: false,
+  });
+}

package/src/utils/json.js

@@ -0,0 +1,3 @@
+export * from './json/convert-to-map.js';
+export * from './json/convert-to-object.js';
+export * from './json/sanitize-json.js';

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

@@ -1,14 +0,0 @@
-export function convertToMap(object = {}) {
-  return new Map(Object.entries(object));
-}
-
-export function convertToObject(map) {
-  const sortedMap = new Map([...map.entries()].sort());
-
-  return Object.fromEntries(sortedMap);
-}
-
-export function sanitizeJson(jsonFile) {
-  // Remove comments
-  return jsonFile.replace(new RegExp('//.*', 'mg'), '');
-}