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

package/README.md

@@ -43,7 +43,7 @@ Step 5. Celebrate.
 
 <sup>1. Before running `ember-codemod-v1-to-v2`, consider [meeting the prerequisites](https://github.com/embroider-build/embroider/blob/v1.8.3/PORTING-ADDONS-TO-V2.md#part-3-prerequisites-for-v2-addon). You can run [`ember-codemod-pod-to-octane`](https://github.com/ijlee2/ember-codemod-pod-to-octane) to un-pod a v1 addon.</sup>
 
-<sup>2. Files such as `.eslintrc.js`, `.gitignore`, `babel.config.json` (addon only), `config/environment.js` (test-app only), `ember-cli-build.js` (test-app only), `package.json`, `rollup.config.js` (addon only), `tsconfig.json`, etc.</sup>
+<sup>2. Files such as `.eslintrc.js`, `.gitignore`, `babel.config.json` (addon only), `config/environment.js` (test-app only), `ember-cli-build.js` (test-app only), `package.json`, `rollup.config.mjs` (addon only), `tsconfig.json`, etc.</sup>
 
 
 ### Arguments

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-codemod-v1-to-v2",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Codemod to convert Ember addons to v2 addon format",
   "keywords": [
     "codemod",
@@ -45,16 +45,16 @@
     }
   },
   "dependencies": {
-    "@babel/core": "^7.20.12",
+    "@babel/core": "^7.21.0",
     "@babel/eslint-parser": "^7.19.1",
-    "glob": "^8.1.0",
+    "glob": "^9.2.1",
     "lodash.template": "^4.5.0",
     "strip-json-comments": "^5.0.0",
-    "yargs": "^17.6.2"
+    "yargs": "^17.7.1"
   },
   "devDependencies": {
     "@sondr3/minitest": "^0.1.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",

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

@@ -13,8 +13,8 @@
 # misc
 /coverage/
 !.*
-.*/
 .eslintcache
+.lint-todo/
 
 # ember-try
 /.node_modules.ember-try/

package/src/blueprints/ember-addon/__gitignore__

@@ -1,18 +1,17 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
 # compiled output
-/dist/
-/tmp/
+dist/
 
 # dependencies
-/bower_components/
-/node_modules/
+node_modules/
 
 # misc
 /.env*
 /.pnp*
+/.pnpm-debug.log
 /.sass-cache
-/.eslintcache
+.eslintcache
 /connect.lock
 /coverage/
 /libpeerconnection.log
@@ -22,11 +21,5 @@
 
 # ember-try
 /.node_modules.ember-try/
-/bower.json.ember-try
-/npm-shrinkwrap.json.ember-try
 /package.json.ember-try
-/package-lock.json.ember-try
 /yarn.lock.ember-try
-
-# broccoli-debug
-/DEBUG/

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

@@ -30,10 +30,6 @@
   "repository": "",
   "license": "MIT",
   "author": "",
-  "workspaces": [
-    "<%= options.locations.addon %>",
-    "<%= options.locations.testApp %>"
-  ],
   "scripts": {
     "build": "pnpm --filter <%= options.packages.addon.name %> build",
     "lint": "pnpm --filter '*' lint",

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

@@ -34,7 +34,7 @@ export function migrateEmberAddon(codemodOptions) {
   createFilesFromBlueprint(context, options);
 
   // Fine-tune individual files
-  updateAddonPackageJson(options);
+  updateAddonPackageJson(context, options);
   updateAddonTsconfigJson(options);
   updateTestAppPackageJson(options);
   updateTestAppTsconfigJson(options);

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

@@ -1,4 +1,4 @@
-import glob from 'glob';
+import { globSync } from 'glob';
 
 import { decideVersion } from '../../../utils/blueprints.js';
 import { renameDirectory } from '../../../utils/files.js';
@@ -6,16 +6,18 @@ import { renameDirectory } from '../../../utils/files.js';
 function getAppReexports(options) {
   const { projectRoot } = options;
 
-  const filePaths = glob.sync('app/**/*.js', {
+  const filePaths = globSync('app/**/*.js', {
     cwd: projectRoot,
   });
 
-  return filePaths.map((filePath) => {
-    return renameDirectory(filePath, {
-      from: 'app',
-      to: '',
-    });
-  });
+  return filePaths
+    .map((filePath) => {
+      return renameDirectory(filePath, {
+        from: 'app',
+        to: '',
+      });
+    })
+    .sort();
 }
 
 function getProjectRootDevDependencies(options) {
@@ -25,10 +27,29 @@ function getProjectRootDevDependencies(options) {
   };
 }
 
+function getPublicAssets(options) {
+  const { projectRoot } = options;
+
+  const filePaths = globSync('public/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  return filePaths
+    .map((filePath) => {
+      return renameDirectory(filePath, {
+        from: 'public',
+        to: '',
+      });
+    })
+    .sort();
+}
+
 function getPublicEntrypoints(options) {
   const { projectRoot } = options;
 
-  const filePaths = glob.sync('{addon,addon-test-support}/**/*.{js,ts}', {
+  const filePaths = globSync('{addon,addon-test-support}/**/*.{js,ts}', {
     cwd: projectRoot,
   });
 
@@ -55,6 +76,7 @@ export function analyzeAddon(options) {
   return {
     addon: {
       appReexports: getAppReexports(options),
+      publicAssets: getPublicAssets(options),
       publicEntrypoints: getPublicEntrypoints(options),
     },
     projectRoot: {

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

@@ -2,7 +2,7 @@ import { readFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
-import glob from 'glob';
+import { globSync } from 'glob';
 
 import { processTemplate } from '../../../utils/blueprints.js';
 import { createFiles } from '../../../utils/files.js';
@@ -47,7 +47,7 @@ export function createFilesFromBlueprint(context, options) {
 
   const filesToSkip = getFilesToSkip(options);
 
-  const blueprintFilePaths = glob.sync('**/*', {
+  const blueprintFilePaths = globSync('**/*', {
     cwd: blueprintRoot,
     dot: true,
     ignore: filesToSkip,

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

@@ -1,7 +1,7 @@
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
 
-import glob from 'glob';
+import { globSync } from 'glob';
 
 function analyzePackageJson(codemodOptions) {
   const { projectRoot } = codemodOptions;
@@ -51,7 +51,7 @@ function analyzePackageJson(codemodOptions) {
 function analyzePackageManager(codemodOptions) {
   const { projectRoot } = codemodOptions;
 
-  const lockFiles = glob.sync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
+  const lockFiles = globSync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
     cwd: projectRoot,
   });
 

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

@@ -1,11 +1,11 @@
-import glob from 'glob';
+import { globSync } from 'glob';
 
 import { mapFilePaths, moveFiles, removeFiles } from '../../../utils/files.js';
 
 function moveAddonFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = glob.sync('addon/**/*', {
+  const filePaths = globSync('addon/**/*', {
     cwd: projectRoot,
     dot: true,
     nodir: true,
@@ -22,7 +22,7 @@ function moveAddonFolder(options) {
 function moveAddonTestSupportFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = glob.sync('addon-test-support/**/*', {
+  const filePaths = globSync('addon-test-support/**/*', {
     cwd: projectRoot,
     dot: true,
     nodir: true,
@@ -39,7 +39,7 @@ function moveAddonTestSupportFolder(options) {
 function moveBlueprintsFolder(options) {
   const { locations, projectRoot } = options;
 
-  const filePaths = glob.sync('blueprints/**/*', {
+  const filePaths = globSync('blueprints/**/*', {
     cwd: projectRoot,
     dot: true,
     nodir: true,
@@ -53,10 +53,27 @@ function moveBlueprintsFolder(options) {
   moveFiles(pathMapping, options);
 }
 
+function movePublicFolder(options) {
+  const { locations, projectRoot } = options;
+
+  const filePaths = globSync('public/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: 'public',
+    to: `${locations.addon}/public`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
 function removeAppFolder(options) {
   const { projectRoot } = options;
 
-  const filePaths = glob.sync('app/**/*', {
+  const filePaths = globSync('app/**/*', {
     cwd: projectRoot,
     dot: true,
     nodir: true,
@@ -69,5 +86,6 @@ export function moveAddonFiles(options) {
   moveAddonFolder(options);
   moveAddonTestSupportFolder(options);
   moveBlueprintsFolder(options);
+  movePublicFolder(options);
   removeAppFolder(options);
 }

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

@@ -1,4 +1,4 @@
-import glob from 'glob';
+import { globSync } from 'glob';
 
 import {
   copyFiles,
@@ -20,7 +20,7 @@ function copyToAddon(options) {
 
   const files = ['LICENSE.md', 'README.md'];
 
-  const filePaths = glob.sync(globPattern(files), {
+  const filePaths = globSync(globPattern(files), {
     cwd: projectRoot,
   });
 
@@ -55,7 +55,7 @@ function moveToAddonAndTestApp(options) {
     files.add('tsconfig.json');
   }
 
-  const filePaths = glob.sync(globPattern([...files]), {
+  const filePaths = globSync(globPattern([...files]), {
     cwd: projectRoot,
   });
 
@@ -86,7 +86,7 @@ function moveToTestApp(options) {
     'testem.js',
   ];
 
-  const filePaths = glob.sync(globPattern(files), {
+  const filePaths = globSync(globPattern(files), {
     cwd: projectRoot,
   });
 
@@ -103,7 +103,7 @@ function removeFromProjectRoot(options) {
 
   const files = ['.npmignore', 'index.js'];
 
-  const filePaths = glob.sync(globPattern(files), {
+  const filePaths = globSync(globPattern(files), {
     cwd: projectRoot,
   });
 

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

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

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

@@ -20,7 +20,7 @@ function updateDependencies(packageJson, options) {
 
   const packagesToInstall = ['@embroider/addon-shim'];
 
-  packagesToInstall.forEach((packageName) => {
+  packagesToInstall.sort().forEach((packageName) => {
     const version = decideVersion(packageName, options);
 
     dependencies.set(packageName, version);
@@ -46,28 +46,23 @@ function updateDevDependencies(packageJson, options) {
   */
   devDependencies.clear();
 
-  const packagesToInstall = packages.addon.hasTypeScript
-    ? [
-        '@babel/core',
-        '@babel/plugin-proposal-class-properties',
-        '@babel/plugin-proposal-decorators',
-        '@babel/preset-typescript',
-        '@embroider/addon-dev',
-        'rollup',
-        'rollup-plugin-copy',
-        'rollup-plugin-ts',
-      ]
-    : [
-        '@babel/core',
-        '@babel/plugin-proposal-class-properties',
-        '@babel/plugin-proposal-decorators',
-        '@embroider/addon-dev',
-        '@rollup/plugin-babel',
-        'rollup',
-        'rollup-plugin-copy',
-      ];
-
-  packagesToInstall.forEach((packageName) => {
+  const packagesToInstall = new Set([
+    '@babel/core',
+    '@babel/plugin-proposal-class-properties',
+    '@babel/plugin-proposal-decorators',
+    '@embroider/addon-dev',
+    '@rollup/plugin-babel',
+    'rollup',
+    'rollup-plugin-copy',
+  ]);
+
+  if (packages.addon.hasTypeScript) {
+    packagesToInstall.add('@babel/preset-typescript');
+    packagesToInstall.add('rollup-plugin-ts');
+    packagesToInstall.delete('@rollup/plugin-babel');
+  }
+
+  [...packagesToInstall].sort().forEach((packageName) => {
     const version = decideVersion(packageName, options);
 
     devDependencies.set(packageName, version);
@@ -76,32 +71,61 @@ function updateDevDependencies(packageJson, options) {
   packageJson['devDependencies'] = convertToObject(devDependencies);
 }
 
-function updateOtherFields(packageJson, options) {
+function updateOtherFields(packageJson, context, options) {
   const { packages } = options;
+  const hasPublicAssets = context.addon.publicAssets.length > 0;
+
+  if (hasPublicAssets) {
+    const publicAssetMapping = context.addon.publicAssets.reduce(
+      (accumulator, filePath) => {
+        const from = `./public/${filePath}`;
+        const to = `/${packages.addon.name}/${filePath}`;
+
+        accumulator[from] = to;
+
+        return accumulator;
+      },
+      {}
+    );
+
+    packageJson['ember-addon'] = {
+      'app-js': {},
+      main: 'addon-main.cjs',
+      'public-assets': publicAssetMapping,
+      type: 'addon',
+      version: 2,
+    };
+  } else {
+    packageJson['ember-addon'] = {
+      'app-js': {},
+      main: 'addon-main.cjs',
+      type: 'addon',
+      version: 2,
+    };
+  }
 
-  packageJson['ember-addon'] = {
-    'app-js': {},
-    main: 'addon-main.cjs',
-    type: 'addon',
-    version: 2,
-  };
-
-  packageJson['exports'] = packages.addon.hasTypeScript
-    ? {
-        '.': './dist/index.js',
-        './*': {
-          types: './dist/*.d.ts',
-          default: './dist/*.js',
-        },
-        './addon-main.js': './addon-main.cjs',
-      }
-    : {
-        '.': './dist/index.js',
-        './*': './dist/*.js',
-        './addon-main.js': './addon-main.cjs',
-      };
-
-  packageJson['files'] = ['addon-main.cjs', 'dist'];
+  if (packages.addon.hasTypeScript) {
+    packageJson['exports'] = {
+      '.': './dist/index.js',
+      './*': {
+        types: './dist/*.d.ts',
+        default: './dist/*.js',
+      },
+      './addon-main.js': './addon-main.cjs',
+    };
+  } else {
+    packageJson['exports'] = {
+      '.': './dist/index.js',
+      './*': './dist/*.js',
+      './addon-main.js': './addon-main.cjs',
+    };
+  }
+
+  if (hasPublicAssets) {
+    packageJson['files'] = ['addon-main.cjs', 'dist', 'public'];
+  } else {
+    packageJson['files'] = ['addon-main.cjs', 'dist'];
+  }
 
   if (packages.addon.hasTypeScript) {
     packageJson['typesVersions'] = {
@@ -126,7 +150,7 @@ function updateScripts(packageJson) {
   packageJson['scripts'] = convertToObject(scripts);
 }
 
-export function updateAddonPackageJson(options) {
+export function updateAddonPackageJson(context, options) {
   const { locations, projectRoot } = options;
 
   const oldPath = join(projectRoot, locations.addon, 'package.json');
@@ -136,7 +160,7 @@ export function updateAddonPackageJson(options) {
   updateDependencies(packageJson, options);
   updateDevDependencies(packageJson, options);
   updateScripts(packageJson);
-  updateOtherFields(packageJson, options);
+  updateOtherFields(packageJson, context, options);
 
   const newFile = JSON.stringify(packageJson, null, 2) + '\n';
 

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

@@ -10,22 +10,26 @@ function moveDependenciesToDevDependencies(packageJson, options) {
   const dependencies = convertToMap(packageJson['dependencies']);
   const devDependencies = convertToMap(packageJson['devDependencies']);
 
-  const packagesToMove = packages.addon.hasTypeScript
-    ? [
-        'ember-auto-import',
-        'ember-cli-babel',
-        'ember-cli-htmlbars',
-        'ember-cli-typescript',
-      ]
-    : ['ember-auto-import', 'ember-cli-babel', 'ember-cli-htmlbars'];
-
-  packagesToMove.forEach((packageName) => {
-    const version = decideVersion(packageName, options);
-
-    devDependencies.set(packageName, version);
-
-    dependencies.delete(packageName);
-  });
+  const packagesToMove = new Set([
+    'ember-auto-import',
+    'ember-cli-babel',
+    'ember-cli-htmlbars',
+  ]);
+
+  if (packages.addon.hasTypeScript) {
+    packagesToMove.add('ember-cli-typescript');
+  }
+
+  [...packagesToMove]
+    .filter((packageName) => dependencies.has(packageName))
+    .sort()
+    .forEach((packageName) => {
+      const version = decideVersion(packageName, options);
+
+      devDependencies.set(packageName, version);
+
+      dependencies.delete(packageName);
+    });
 
   packageJson['dependencies'] = convertToObject(dependencies);
   packageJson['devDependencies'] = convertToObject(devDependencies);

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

@@ -1,7 +1,7 @@
 import { readFileSync, writeFileSync } from 'node:fs';
 import { dirname, join, relative } from 'node:path';
 
-import glob from 'glob';
+import { globSync } from 'glob';
 
 function normalizeRelativePath(relativePath) {
   if (!relativePath.startsWith('..')) {
@@ -38,7 +38,7 @@ function useRelativePathInAddonFolder(options) {
 
   // File extensions had been specified, partly to encode assumptions
   // about Ember, and partly to avoid corrupting non-text files
-  const filePaths = glob.sync('addon/**/*.{d.ts,js,ts}', {
+  const filePaths = globSync('addon/**/*.{d.ts,js,ts}', {
     cwd: projectRoot,
     dot: true,
     nodir: true,
@@ -63,7 +63,7 @@ function useRelativePathInTestsDummyFolder(options) {
 
   // File extensions had been specified, partly to encode assumptions
   // about Ember, and partly to avoid corrupting non-text files
-  const filePaths = glob.sync('tests/dummy/**/*.{d.ts,js,ts}', {
+  const filePaths = globSync('tests/dummy/**/*.{d.ts,js,ts}', {
     cwd: projectRoot,
     dot: true,
     nodir: true,

package/src/utils/blueprints/decide-version.js

@@ -1,17 +1,17 @@
 const latestVersions = new Map([
-  ['@babel/core', '7.20.12'],
+  ['@babel/core', '7.21.0'],
   ['@babel/plugin-proposal-class-properties', '7.18.6'],
-  ['@babel/plugin-proposal-decorators', '7.20.13'],
-  ['@babel/preset-typescript', '7.18.6'],
+  ['@babel/plugin-proposal-decorators', '7.21.0'],
+  ['@babel/preset-typescript', '7.21.0'],
   ['@embroider/addon-dev', '3.0.0'],
   ['@embroider/addon-shim', '1.8.4'],
   ['@rollup/plugin-babel', '6.0.3'],
   ['concurrently', '7.6.0'],
-  ['ember-auto-import', '2.6.0'],
+  ['ember-auto-import', '2.6.1'],
   ['ember-cli-babel', '7.26.11'],
   ['ember-cli-htmlbars', '6.2.0'],
-  ['prettier', '2.8.3'],
-  ['rollup', '3.12.0'],
+  ['prettier', '2.8.4'],
+  ['rollup', '3.18.0'],
   ['rollup-plugin-copy', '3.4.0'],
   ['rollup-plugin-ts', '3.2.0'],
 ]);