ember-codemod-v1-to-v2 0.4.0 → 0.4.1

package/README.md

@@ -8,7 +8,6 @@ _Codemod to convert Ember addons to v2 addon format_
 ## Features
 
 - Scaffolds files according to [`@embroider/addon-blueprint`](https://github.com/embroider-build/addon-blueprint)
-- 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 maintainability and extensibility
@@ -116,7 +115,7 @@ You can also look at another codemod called [`ember-addon-migrator`](https://git
 
 ## Contributing
 
-If you have an open-sourced addon that I can use as a test fixture, reach out to me on [Discord](https://discord.gg/emberjs) at `ijlee2`. Please star this project so that I can gauge its importance to you and the Ember community. ⭐
+If you have an open-sourced addon (v1 or v2) that I can use as a reference, reach out to me on [Discord](https://discord.gg/emberjs) at `ijlee2`. Please star this project so that I can gauge its importance to you and the Ember community. ⭐
 
 
 ## Credits

package/package.json

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

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

@@ -9,7 +9,6 @@ import {
   updateAddonTsconfigJson,
   updateTestAppPackageJson,
   updateTestAppTsconfigJson,
-  useRelativePaths,
 } from './steps/index.js';
 
 export function migrateEmberAddon(codemodOptions) {
@@ -23,7 +22,6 @@ export function migrateEmberAddon(codemodOptions) {
 
   // Prepare for migration
   const context = analyzeAddon(options);
-  useRelativePaths(options);
 
   // Preserve code
   moveAddonFiles(options);

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

@@ -1,12 +1,10 @@
-import { globSync } from 'glob';
-
 import { decideVersion } from '../../../utils/blueprints.js';
-import { renameDirectory } from '../../../utils/files.js';
+import { findFiles, renameDirectory } from '../../../utils/files.js';
 
 function getAppReexports(options) {
   const { projectRoot } = options;
 
-  const filePaths = globSync('app/**/*.js', {
+  const filePaths = findFiles('app/**/*.js', {
     cwd: projectRoot,
   });
 
@@ -30,10 +28,8 @@ function getProjectRootDevDependencies(options) {
 function getPublicAssets(options) {
   const { projectRoot } = options;
 
-  const filePaths = globSync('public/**/*', {
+  const filePaths = findFiles('public/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   return filePaths
@@ -49,7 +45,7 @@ function getPublicAssets(options) {
 function getPublicEntrypoints(options) {
   const { projectRoot } = options;
 
-  const filePaths = globSync('{addon,addon-test-support}/**/*.{js,ts}', {
+  const filePaths = findFiles('{addon,addon-test-support}/**/*.{js,ts}', {
     cwd: projectRoot,
   });
 

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

@@ -1,20 +1,8 @@
 import { readFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
 
-import { globSync } from 'glob';
-
-import { processTemplate } from '../../../utils/blueprints.js';
-import { createFiles } from '../../../utils/files.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-function getBlueprintRoot() {
-  const codemodRoot = join(__dirname, '../../../..');
-
-  return join(codemodRoot, 'src/blueprints/ember-addon');
-}
+import { blueprintRoot, processTemplate } from '../../../utils/blueprints.js';
+import { createFiles, findFiles } from '../../../utils/files.js';
 
 function getFilePath(blueprintFilePath, options) {
   const { locations } = options;
@@ -43,15 +31,11 @@ function getFilesToSkip(options) {
 }
 
 export function createFilesFromBlueprint(context, options) {
-  const blueprintRoot = getBlueprintRoot();
-
   const filesToSkip = getFilesToSkip(options);
 
-  const blueprintFilePaths = globSync('**/*', {
+  const blueprintFilePaths = findFiles('**/*', {
     cwd: blueprintRoot,
-    dot: true,
-    ignore: filesToSkip,
-    nodir: true,
+    ignoreList: filesToSkip,
   });
 
   const fileMapping = new Map(

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

@@ -1,7 +1,26 @@
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import { globSync } from 'glob';
+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.');
+  }
+}
 
 function analyzePackageJson(codemodOptions) {
   const { projectRoot } = codemodOptions;
@@ -20,13 +39,7 @@ function analyzePackageJson(codemodOptions) {
       version,
     } = JSON.parse(packageJsonFile);
 
-    if (!name) {
-      throw new SyntaxError('Package name is missing.');
-    }
-
-    if (!version) {
-      throw new SyntaxError('Package version is missing.');
-    }
+    validatePackageJson({ name, version });
 
     const projectDependencies = new Map([
       ...Object.entries(dependencies ?? {}),
@@ -51,11 +64,19 @@ function analyzePackageJson(codemodOptions) {
 function analyzePackageManager(codemodOptions) {
   const { projectRoot } = codemodOptions;
 
-  const lockFiles = globSync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
+  const mapping = new Map([
+    ['package-lock.json', 'npm'],
+    ['pnpm-lock.yaml', 'pnpm'],
+    ['yarn.lock', 'yarn'],
+  ]);
+
+  const lockFiles = [...mapping.keys()];
+
+  const filePaths = findFiles(unionize(lockFiles), {
     cwd: projectRoot,
   });
 
-  if (lockFiles.length !== 1) {
+  if (filePaths.length !== 1) {
     console.warn('WARNING: Package manager is unknown. Yarn will be assumed.');
 
     return {
@@ -65,12 +86,12 @@ function analyzePackageManager(codemodOptions) {
     };
   }
 
-  const [lockFile] = lockFiles;
+  const packageManager = mapping.get(filePaths[0]);
 
   return {
-    isNpm: lockFile === 'package-lock.json',
-    isPnpm: lockFile === 'pnpm-lock.yaml',
-    isYarn: lockFile === 'yarn.lock',
+    isNpm: packageManager === 'npm',
+    isPnpm: packageManager === 'pnpm',
+    isYarn: packageManager === 'yarn',
   };
 }
 
@@ -81,13 +102,7 @@ function deriveAddonLocation(addonPackage) {
   }
 
   // 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.`
-    );
-  }
+  const [_scope, packageName] = addonPackage.name.split('/');
 
   return packageName;
 }

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

@@ -8,4 +8,3 @@ export * from './update-addon-package-json.js';
 export * from './update-addon-tsconfig-json.js';
 export * from './update-test-app-package-json.js';
 export * from './update-test-app-tsconfig-json.js';
-export * from './use-relative-paths.js';

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

@@ -1,14 +1,15 @@
-import { globSync } from 'glob';
-
-import { mapFilePaths, moveFiles, removeFiles } from '../../../utils/files.js';
+import {
+  findFiles,
+  mapFilePaths,
+  moveFiles,
+  removeFiles,
+} from '../../../utils/files.js';
 
 function moveAddonFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = globSync('addon/**/*', {
+  const filePaths = findFiles('addon/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   const pathMapping = mapFilePaths(filePaths, {
@@ -22,10 +23,8 @@ function moveAddonFolder(options) {
 function moveAddonTestSupportFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = globSync('addon-test-support/**/*', {
+  const filePaths = findFiles('addon-test-support/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   const pathMapping = mapFilePaths(filePaths, {
@@ -39,10 +38,8 @@ function moveAddonTestSupportFolder(options) {
 function moveBlueprintsFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = globSync('blueprints/**/*', {
+  const filePaths = findFiles('blueprints/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   const pathMapping = mapFilePaths(filePaths, {
@@ -56,10 +53,8 @@ function moveBlueprintsFolder(options) {
 function movePublicFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = globSync('public/**/*', {
+  const filePaths = findFiles('public/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   const pathMapping = mapFilePaths(filePaths, {
@@ -73,10 +68,8 @@ function movePublicFolder(options) {
 function removeAppFolder(options) {
   const { projectRoot } = options;
 
-  const filePaths = globSync('app/**/*', {
+  const filePaths = findFiles('app/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   removeFiles(filePaths, options);

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

@@ -1,26 +1,18 @@
-import { globSync } from 'glob';
-
 import {
   copyFiles,
+  findFiles,
   mapFilePaths,
   moveFiles,
   removeFiles,
+  unionize,
 } from '../../../utils/files.js';
 
-function globPattern(files) {
-  if (files.length <= 1) {
-    return files.join(',');
-  }
-
-  return `{${files.join(',')}}`;
-}
-
 function copyToAddon(options) {
   const { locations, projectRoot } = options;
 
   const files = ['LICENSE.md', 'README.md'];
 
-  const filePaths = globSync(globPattern(files), {
+  const filePaths = findFiles(unionize(files), {
     cwd: projectRoot,
   });
 
@@ -55,7 +47,7 @@ function moveToAddonAndTestApp(options) {
     files.add('tsconfig.json');
   }
 
-  const filePaths = globSync(globPattern([...files]), {
+  const filePaths = findFiles(unionize([...files]), {
     cwd: projectRoot,
   });
 
@@ -86,7 +78,7 @@ function moveToTestApp(options) {
     'testem.js',
   ];
 
-  const filePaths = globSync(globPattern(files), {
+  const filePaths = findFiles(unionize(files), {
     cwd: projectRoot,
   });
 
@@ -103,7 +95,7 @@ function removeFromProjectRoot(options) {
 
   const files = ['.npmignore', 'index.js'];
 
-  const filePaths = globSync(globPattern(files), {
+  const filePaths = findFiles(unionize(files), {
     cwd: projectRoot,
   });
 

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

@@ -1,17 +1,13 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import { globSync } from 'glob';
-
-import { mapFilePaths, moveFiles } from '../../../utils/files.js';
+import { findFiles, mapFilePaths, moveFiles } from '../../../utils/files.js';
 
 function moveTestsFolder(options) {
   const { locations, projectRoot } = options;
 
-  let filePaths = globSync('tests/dummy/**/*', {
+  let filePaths = findFiles('tests/dummy/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   let pathMapping = mapFilePaths(filePaths, {
@@ -21,11 +17,9 @@ function moveTestsFolder(options) {
 
   moveFiles(pathMapping, options);
 
-  filePaths = globSync('tests/**/*', {
+  filePaths = findFiles('tests/**/*', {
     cwd: projectRoot,
-    dot: true,
-    ignore: 'tests/dummy/**/*',
-    nodir: true,
+    ignoreList: ['tests/dummy/**/*'],
   });
 
   pathMapping = mapFilePaths(filePaths, {
@@ -43,10 +37,8 @@ function moveTypesFolder(options) {
     return;
   }
 
-  let filePaths = globSync('types/dummy/**/*', {
+  let filePaths = findFiles('types/dummy/**/*', {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   let pathMapping = mapFilePaths(filePaths, {
@@ -56,11 +48,9 @@ function moveTypesFolder(options) {
 
   moveFiles(pathMapping, options);
 
-  filePaths = globSync('types/**/*', {
+  filePaths = findFiles('types/**/*', {
     cwd: projectRoot,
-    dot: true,
-    ignore: 'types/dummy/**/*',
-    nodir: true,
+    ignoreList: ['types/dummy/**/*'],
   });
 
   pathMapping = mapFilePaths(filePaths, {
@@ -76,10 +66,8 @@ function renameDummy(options) {
 
   // File extensions had been specified, partly to encode assumptions
   // about Ember, and partly to avoid corrupting non-text files
-  const filePaths = globSync(`${locations.testApp}/**/*.{d.ts,html,js,ts}`, {
+  const filePaths = findFiles(`${locations.testApp}/**/*.{d.ts,html,js,ts}`, {
     cwd: projectRoot,
-    dot: true,
-    nodir: true,
   });
 
   filePaths.forEach((filePath) => {

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

@@ -108,6 +108,9 @@ function updateOtherFields(packageJson, context, options) {
     packageJson['exports'] = {
       '.': './dist/index.js',
       './*': {
+        /*
+          This object has an order dependency. The `default` key must appear last.
+        */
         types: './dist/*.d.ts',
         default: './dist/*.js',
       },

package/src/utils/blueprints/blueprint-root.js

@@ -0,0 +1,13 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+function getBlueprintRoot() {
+  const srcDirectory = join(__dirname, '../..');
+
+  return join(srcDirectory, 'blueprints/ember-addon');
+}
+
+export const blueprintRoot = getBlueprintRoot();

package/src/utils/blueprints.js

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

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

@@ -0,0 +1,28 @@
+import { globSync } from 'glob';
+
+export function findFiles(pattern, { cwd, ignoreList = [] }) {
+  if (!pattern) {
+    throw new RangeError('ERROR: The glob pattern is unknown.\n');
+  }
+
+  if (!cwd) {
+    throw new RangeError('ERROR: The current working directory is unknown.\n');
+  }
+
+  const filePaths = globSync(pattern, {
+    cwd,
+    dot: true,
+    ignore: ignoreList,
+    nodir: true,
+  });
+
+  return filePaths;
+}
+
+export function unionize(files) {
+  if (files.length <= 1) {
+    return files.join(',');
+  }
+
+  return `{${files.join(',')}}`;
+}

package/src/utils/files.js

@@ -1,5 +1,6 @@
 export * from './files/copy-files.js';
 export * from './files/create-files.js';
+export * from './files/find-files.js';
 export * from './files/map-file-paths.js';
 export * from './files/move-files.js';
 export * from './files/remove-directory-if-empty.js';

package/src/migration/ember-addon/steps/use-relative-paths.js

@@ -1,89 +0,0 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { dirname, join, relative } from 'node:path';
-
-import { globSync } from 'glob';
-
-function normalizeRelativePath(relativePath) {
-  if (!relativePath.startsWith('..')) {
-    return `./${relativePath}`;
-  }
-
-  return relativePath;
-}
-
-function updateFile(oldFile, { filePath, projectName, projectRoot }) {
-  const regex = new RegExp(`(?:'|")(${projectName}/(.*/)*(.*))(?:'|")`, 'g');
-  const matchResults = [...oldFile.matchAll(regex)];
-
-  let newFile = oldFile;
-
-  matchResults.forEach((matchResult) => {
-    // eslint-disable-next-line no-unused-vars
-    const [_, oldPath, remainingDirectories, fileName] = matchResult;
-
-    const from = dirname(filePath);
-    const to = join(projectRoot, remainingDirectories);
-
-    const relativePath = join(relative(from, to), fileName);
-    const newPath = normalizeRelativePath(relativePath);
-
-    newFile = newFile.replace(oldPath, newPath);
-  });
-
-  return newFile;
-}
-
-function useRelativePathInAddonFolder(options) {
-  const { packages, projectRoot } = options;
-
-  // File extensions had been specified, partly to encode assumptions
-  // about Ember, and partly to avoid corrupting non-text files
-  const filePaths = globSync('addon/**/*.{d.ts,js,ts}', {
-    cwd: projectRoot,
-    dot: true,
-    nodir: true,
-  });
-
-  filePaths.forEach((filePath) => {
-    const oldPath = join(projectRoot, filePath);
-    const oldFile = readFileSync(oldPath, 'utf8');
-
-    const newFile = updateFile(oldFile, {
-      filePath,
-      projectName: packages.addon.name,
-      projectRoot: 'addon',
-    });
-
-    writeFileSync(oldPath, newFile, 'utf8');
-  });
-}
-
-function useRelativePathInTestsDummyFolder(options) {
-  const { projectRoot } = options;
-
-  // File extensions had been specified, partly to encode assumptions
-  // about Ember, and partly to avoid corrupting non-text files
-  const filePaths = globSync('tests/dummy/**/*.{d.ts,js,ts}', {
-    cwd: projectRoot,
-    dot: true,
-    nodir: true,
-  });
-
-  filePaths.forEach((filePath) => {
-    const oldPath = join(projectRoot, filePath);
-    const oldFile = readFileSync(oldPath, 'utf8');
-
-    const newFile = updateFile(oldFile, {
-      filePath,
-      projectName: 'dummy',
-      projectRoot: 'tests/dummy/app',
-    });
-
-    writeFileSync(oldPath, newFile, 'utf8');
-  });
-}
-
-export function useRelativePaths(options) {
-  useRelativePathInAddonFolder(options);
-  useRelativePathInTestsDummyFolder(options);
-}