Refactored utilities (#30)

* chore: Updated CI workflow

* chore: Sorted file paths (an order is not guaranteed in glob@v9)

* refactor: Extracted function

* refactor: Renamed variables (copyFiles)

* refactor: Renamed variables (createFiles)

* refactor: Renamed variables (mapFilePaths)

* refactor: Renamed variables (moveFiles)

* refactor: Updated API (removeDirectoryIfEmpty)

* refactor: Renamed variables (removeFiles)

* chore: Installed @codemod-utils packages

* refactor: Simplified utilities for blueprints

* chore: Removed utilities for files

* refactor: Simplified utilities for JSON

* chore: Removed utilities for tests

* chore: Removed unused dependencies

* chore: Ran sort-package-json

---------

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

Author: ijlee2

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ env:
 
 jobs:
   lint:
-    name: Lint files
+    name: Lint
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
@@ -31,8 +31,8 @@ jobs:
         run: yarn lint
 
 
-  test-app:
-    name: Test app
+  test:
+    name: Test
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:

create-test-fixture.sh

@@ -51,7 +51,7 @@ fi
 mkdir -p "tests/fixtures/$DESTINATION/input"
 mkdir -p "tests/fixtures/$DESTINATION/output"
 
-echo "import { convertFixtureToJson } from '../../helpers/testing.js';
+echo "import { convertFixtureToJson } from '@codemod-utils/tests';
 
 const inputProject = convertFixtureToJson('$DESTINATION/input');
 const outputProject = convertFixtureToJson('$DESTINATION/output');

package.json

@@ -17,53 +17,54 @@
   },
   "license": "MIT",
   "author": "Isaac J. Lee",
-  "main": "src/index.js",
   "type": "module",
+  "main": "src/index.js",
   "bin": "./bin/ember-codemod-v1-to-v2.js",
+  "directories": {
+    "test": "tests"
+  },
   "files": [
     "bin/",
     "src/"
   ],
-  "directories": {
-    "test": "tests"
-  },
   "scripts": {
     "changelog": "lerna-changelog",
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --fix",
     "test": "mt tests --quiet"
   },
-  "changelog": {
-    "labels": {
-      "breaking": "Breaking Change",
-      "bug": "Bug Fix",
-      "enhance: code": "Enhancement",
-      "enhance: dependency": "Internal",
-      "enhance: documentation": "Documentation",
-      "user feedback": "User Feedback"
-    }
-  },
   "dependencies": {
-    "glob": "^10.2.2",
-    "lodash.template": "^4.5.0",
+    "@codemod-utils/blueprints": "^0.1.1",
+    "@codemod-utils/files": "^0.1.0",
+    "@codemod-utils/json": "^0.1.1",
     "strip-json-comments": "^5.0.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@babel/core": "^7.21.8",
     "@babel/eslint-parser": "^7.21.8",
+    "@codemod-utils/tests": "^0.1.0",
     "@sondr3/minitest": "^0.1.1",
     "eslint": "^8.39.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "fixturify": "^3.0.0",
     "lerna-changelog": "^2.2.0",
     "prettier": "^2.8.8"
   },
   "engines": {
     "node": ">= 16"
+  },
+  "changelog": {
+    "labels": {
+      "breaking": "Breaking Change",
+      "bug": "Bug Fix",
+      "enhance: code": "Enhancement",
+      "enhance: dependency": "Internal",
+      "enhance: documentation": "Documentation",
+      "user feedback": "User Feedback"
+    }
   }
 }

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

@@ -1,5 +1,6 @@
-import { decideVersion } from '../../../utils/blueprints.js';
-import { findFiles, renameDirectory } from '../../../utils/files.js';
+import { findFiles, renameDirectory } from '@codemod-utils/files';
+
+import { getVersion } from '../../../utils/blueprints.js';
 
 function getAppReexports(options) {
   const { projectRoot } = options;
@@ -20,7 +21,7 @@ function getAppReexports(options) {
 
 function getProjectRootDevDependencies(options) {
   return {
-    concurrently: decideVersion('concurrently', options),
+    concurrently: getVersion('concurrently', options),
   };
 }
 

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

@@ -1,17 +1,10 @@
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import { blueprintsRoot, processTemplate } from '../../../utils/blueprints.js';
-import { createFiles, findFiles } from '../../../utils/files.js';
+import { processTemplate } from '@codemod-utils/blueprints';
+import { createFiles, findFiles } from '@codemod-utils/files';
 
-function getFilePath(blueprintFilePath, options) {
-  const { locations } = options;
-
-  return blueprintFilePath
-    .replace('__addonLocation__', locations.addon)
-    .replace('__gitignore__', '.gitignore')
-    .replace('__testAppLocation__', locations.testApp);
-}
+import { blueprintsRoot } from '../../../utils/blueprints.js';
 
 function getFilesToSkip(options) {
   const { packageManager, packages } = options;
@@ -30,23 +23,29 @@ function getFilesToSkip(options) {
   return [...files];
 }
 
+function resolveBlueprintFilePath(blueprintFilePath, options) {
+  const { locations } = options;
+
+  return blueprintFilePath
+    .replace('__addonLocation__', locations.addon)
+    .replace('__gitignore__', '.gitignore')
+    .replace('__testAppLocation__', locations.testApp);
+}
+
 export function createFilesFromBlueprint(context, options) {
   const filesToSkip = getFilesToSkip(options);
-  const emberAddonBlueprintsRoot = join(blueprintsRoot, 'ember-addon');
+  const cwd = join(blueprintsRoot, 'ember-addon');
 
   const blueprintFilePaths = findFiles('**/*', {
-    cwd: emberAddonBlueprintsRoot,
+    cwd,
     ignoreList: filesToSkip,
   });
 
-  const fileMapping = new Map(
+  const fileMap = new Map(
     blueprintFilePaths.map((blueprintFilePath) => {
-      const filePath = getFilePath(blueprintFilePath, options);
+      const filePath = resolveBlueprintFilePath(blueprintFilePath, options);
 
-      const blueprintFile = readFileSync(
-        join(emberAddonBlueprintsRoot, blueprintFilePath),
-        'utf8',
-      );
+      const blueprintFile = readFileSync(join(cwd, blueprintFilePath), 'utf8');
 
       const file = processTemplate(blueprintFile, {
         context,
@@ -57,5 +56,5 @@ export function createFilesFromBlueprint(context, options) {
     }),
   );
 
-  createFiles(fileMapping, options);
+  createFiles(fileMap, options);
 }

src/migration/ember-addon/steps/create-options.js

@@ -1,64 +1,28 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-
-import { findFiles, unionize } from '../../../utils/files.js';
-
-function validatePackageJson({ name, version }) {
-  if (!name) {
-    throw new SyntaxError('Package name is missing.');
-  }
-
-  if (name.includes('/')) {
-    // eslint-disable-next-line no-unused-vars
-    const [_scope, packageName] = name.split('/');
-
-    if (!packageName) {
-      throw new SyntaxError('Package name is missing.');
-    }
-  }
-
-  if (!version) {
-    throw new SyntaxError('Package version is missing.');
-  }
-}
+import { findFiles, unionize } from '@codemod-utils/files';
+import { readPackageJson } from '@codemod-utils/json';
 
 function analyzePackageJson(codemodOptions) {
-  const { projectRoot } = codemodOptions;
-
-  try {
-    const packageJsonFile = readFileSync(
-      join(projectRoot, 'package.json'),
-      'utf8',
-    );
-
-    const {
-      dependencies,
-      devDependencies,
-      'ember-addon': emberAddon,
-      name,
-      version,
-    } = JSON.parse(packageJsonFile);
-
-    validatePackageJson({ name, version });
-
-    const projectDependencies = new Map([
-      ...Object.entries(dependencies ?? {}),
-      ...Object.entries(devDependencies ?? {}),
-    ]);
+  const {
+    dependencies,
+    devDependencies,
+    'ember-addon': emberAddon,
+    name,
+    version,
+  } = readPackageJson(codemodOptions);
+
+  const projectDependencies = new Map([
+    ...Object.entries(dependencies ?? {}),
+    ...Object.entries(devDependencies ?? {}),
+  ]);
 
-    return {
-      dependencies: projectDependencies,
-      hasGlint: projectDependencies.has('@glint/core'),
-      hasTypeScript: projectDependencies.has('typescript'),
-      isV1Addon: Boolean(emberAddon),
-      name,
-      version,
-    };
-  } catch (e) {
-    throw new SyntaxError(
-      `ERROR: package.json is missing or is not valid. (${e.message})\n`,
-    );
-  }
+  return {
+    dependencies: projectDependencies,
+    hasGlint: projectDependencies.has('@glint/core'),
+    hasTypeScript: projectDependencies.has('typescript'),
+    isV1Addon: Boolean(emberAddon),
+    name,
+    version,
+  };
 }
 
 function analyzePackageManager(codemodOptions) {

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

@@ -3,7 +3,7 @@ import {
   mapFilePaths,
   moveFiles,
   removeFiles,
-} from '../../../utils/files.js';
+} from '@codemod-utils/files';
 
 function moveAddonFolder(options) {
   const { locations, projectRoot } = options;
@@ -12,12 +12,12 @@ function moveAddonFolder(options) {
     cwd: projectRoot,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
+  const filePathMap = mapFilePaths(filePaths, {
     from: 'addon',
     to: `${locations.addon}/src`,
   });
 
-  moveFiles(pathMapping, options);
+  moveFiles(filePathMap, options);
 }
 
 function moveAddonTestSupportFolder(options) {
@@ -27,12 +27,12 @@ function moveAddonTestSupportFolder(options) {
     cwd: projectRoot,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
+  const filePathMap = mapFilePaths(filePaths, {
     from: 'addon-test-support',
     to: `${locations.addon}/src/test-support`,
   });
 
-  moveFiles(pathMapping, options);
+  moveFiles(filePathMap, options);
 }
 
 function moveBlueprintsFolder(options) {
@@ -42,12 +42,12 @@ function moveBlueprintsFolder(options) {
     cwd: projectRoot,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
+  const filePathMap = mapFilePaths(filePaths, {
     from: 'blueprints',
     to: `${locations.addon}/blueprints`,
   });
 
-  moveFiles(pathMapping, options);
+  moveFiles(filePathMap, options);
 }
 
 function movePublicFolder(options) {
@@ -57,12 +57,12 @@ function movePublicFolder(options) {
     cwd: projectRoot,
   });
 
-  const pathMapping = mapFilePaths(filePaths, {
+  const filePathMap = mapFilePaths(filePaths, {
     from: 'public',
     to: `${locations.addon}/public`,
   });
 
-  moveFiles(pathMapping, options);
+  moveFiles(filePathMap, options);
 }
 
 function removeAppFolder(options) {