Reorganized utilities and handled multiline comments in JSON (#10)

* refactor: Created a dedicated file for each function related to handling files

* refactor: Grouped mapFilePaths under utilities for files

* refactor: Simplified removeFiles

* refactor: Grouped processTemplate under utilities for blueprints

* refactor: Grouped decideVersion under utilities for blueprints

* refactor: Removed hard-coded latest versions from blueprints

* refactor: Grouped appReexports and publicEntrypoints under addon

* refactor: Created a dedicated file for each function related to handling JSON

* bugfix: Removed multiline comments in a JSON file

* refactor: Extracted context to shared-test-setups

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

Author: ijlee2

package.json

@@ -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": {

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

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

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'] %>"
   }
 }<% } %>

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),
+    },
+  };
 }

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);

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) {

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) {

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;

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']);