ember-codemod-v1-to-v2 0.1.0

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

@@ -0,0 +1,111 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import glob from 'glob';
+
+function analyzePackageJson(options) {
+  const { projectRoot } = options;
+
+  try {
+    const packageJsonFile = readFileSync(
+      join(projectRoot, 'package.json'),
+      'utf8'
+    );
+
+    const {
+      dependencies,
+      devDependencies,
+      'ember-addon': emberAddon,
+      name,
+      version,
+    } = JSON.parse(packageJsonFile);
+
+    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 a valid JSON. (${e.message})\n`
+    );
+  }
+}
+
+function analyzePackageManager(options) {
+  const { projectRoot } = options;
+
+  const lockFiles = glob.sync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
+    cwd: projectRoot,
+  });
+
+  if (lockFiles.length !== 1) {
+    console.warn('WARNING: Package manager is unknown. Yarn will be assumed.');
+
+    return {
+      isNpm: false,
+      isPnpm: false,
+      isYarn: true,
+    };
+  }
+
+  const [lockFile] = lockFiles;
+
+  return {
+    isNpm: lockFile === 'package-lock.json',
+    isPnpm: lockFile === 'pnpm-lock.yaml',
+    isYarn: lockFile === 'yarn.lock',
+  };
+}
+
+function deriveAddonLocation(addonPackage) {
+  if (!addonPackage.name) {
+    throw new RangeError(
+      `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.`
+    );
+  }
+
+  // Package is scoped
+  if (addonPackage.name.includes('/')) {
+    // 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.`
+      );
+    }
+
+    return packageName;
+  }
+
+  return addonPackage.name;
+}
+
+export function augmentOptions(options) {
+  const addonPackage = analyzePackageJson(options);
+  const packageManager = analyzePackageManager(options);
+
+  return {
+    locations: {
+      addon: options.addonLocation ?? deriveAddonLocation(addonPackage),
+      testApp: options.testAppLocation ?? 'test-app',
+    },
+    packageManager,
+    packages: {
+      addon: addonPackage,
+      testApp: {
+        name: options.testAppName ?? 'test-app',
+      },
+    },
+    projectRoot: options.projectRoot,
+  };
+}

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

@@ -0,0 +1,68 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import glob from 'glob';
+
+import { createFiles } from '../../../utils/files.js';
+import { processTemplate } from '../../../utils/process-template.js';
+
+function getFilePath(blueprintFilePath, options) {
+  const { locations } = options;
+
+  return blueprintFilePath
+    .replace('__addonLocation__', locations.addon)
+    .replace('__testAppLocation__', locations.testApp);
+}
+
+function getFilesToSkip(options) {
+  const { packageManager, packages } = options;
+
+  const files = new Set();
+
+  if (packages.addon.hasTypeScript) {
+    files.add('__addonLocation__/rollup.config.js');
+  } else {
+    files.add('__addonLocation__/rollup.config.mjs');
+    files.add('__addonLocation__/unpublished-development-types/index.d.ts');
+    files.add('__testAppLocation__/types/global.d.ts');
+  }
+
+  if (!packageManager.isPnpm) {
+    files.add('pnpm-workspace.yaml');
+  }
+
+  return [...files];
+}
+
+export function createFilesFromBlueprint(context, options) {
+  const blueprintRoot = 'src/blueprints/ember-addon';
+
+  const filesToSkip = getFilesToSkip(options);
+
+  const blueprintFilePaths = glob.sync('**/*', {
+    cwd: blueprintRoot,
+    dot: true,
+    ignore: filesToSkip,
+    nodir: true,
+  });
+
+  const fileMapping = new Map(
+    blueprintFilePaths.map((blueprintFilePath) => {
+      const filePath = getFilePath(blueprintFilePath, options);
+
+      const blueprintFile = readFileSync(
+        join(blueprintRoot, blueprintFilePath),
+        'utf8'
+      );
+
+      const file = processTemplate(blueprintFile, {
+        context,
+        options,
+      });
+
+      return [filePath, file];
+    })
+  );
+
+  createFiles(fileMapping, options);
+}

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

@@ -0,0 +1,11 @@
+export * from './analyze-addon.js';
+export * from './augment-options.js';
+export * from './create-files-from-blueprint.js';
+export * from './move-addon-files.js';
+export * from './move-project-root-files.js';
+export * from './move-test-app-files.js';
+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

@@ -0,0 +1,79 @@
+import glob from 'glob';
+
+import { moveFiles, removeFiles } from '../../../utils/files.js';
+import { mapFilePaths } from '../../../utils/map-file-paths.js';
+
+function moveAddonFolder(options) {
+  const { locations, projectRoot } = options;
+
+  const filePaths = glob.sync('addon/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: 'addon',
+    to: `${locations.addon}/src`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function moveAddonTestSupportFolder(options) {
+  const { locations, projectRoot } = options;
+
+  const filePaths = glob.sync('addon-test-support/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: 'addon-test-support',
+    to: `${locations.addon}/src/test-support`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function moveBlueprintsFolder(options) {
+  const { locations, projectRoot } = options;
+
+  const filePaths = glob.sync('blueprints/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: 'blueprints',
+    to: `${locations.addon}/blueprints`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function removeAppFolder(options) {
+  const { projectRoot } = options;
+
+  const filePaths = glob.sync('app/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: 'app',
+    to: 'app',
+  });
+
+  removeFiles(pathMapping, options);
+}
+
+export function moveAddonFiles(options) {
+  moveAddonFolder(options);
+  moveAddonTestSupportFolder(options);
+  moveBlueprintsFolder(options);
+  removeAppFolder(options);
+}

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

@@ -0,0 +1,126 @@
+import glob from 'glob';
+
+import { copyFiles, moveFiles, removeFiles } from '../../../utils/files.js';
+import { mapFilePaths } from '../../../utils/map-file-paths.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 = glob.sync(globPattern(files), {
+    cwd: projectRoot,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: locations.addon,
+  });
+
+  copyFiles(pathMapping, options);
+}
+
+function moveToAddonAndTestApp(options) {
+  const { locations, packages, projectRoot } = options;
+
+  const files = packages.addon.hasTypeScript
+    ? [
+        '.eslintrc.js',
+        '.gitignore',
+        '.prettierignore',
+        '.prettierrc.js',
+        '.stylelintrc.js',
+        '.template-lintrc.js',
+        'package.json',
+        'tsconfig.json',
+      ]
+    : [
+        '.eslintrc.js',
+        '.gitignore',
+        '.prettierignore',
+        '.prettierrc.js',
+        '.stylelintrc.js',
+        '.template-lintrc.js',
+        'package.json',
+      ];
+
+  const filePaths = glob.sync(globPattern(files), {
+    cwd: projectRoot,
+  });
+
+  let pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: locations.addon,
+  });
+
+  copyFiles(pathMapping, options);
+
+  pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: locations.testApp,
+  });
+
+  copyFiles(pathMapping, options);
+
+  pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: '',
+  });
+
+  removeFiles(pathMapping, options);
+}
+
+function moveToTestApp(options) {
+  const { locations, projectRoot } = options;
+
+  const files = [
+    '.ember-cli',
+    '.eslintignore',
+    '.watchmanconfig',
+    'ember-cli-build.js',
+    'testem.js',
+  ];
+
+  const filePaths = glob.sync(globPattern(files), {
+    cwd: projectRoot,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: locations.testApp,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function removeFromProjectRoot(options) {
+  const { projectRoot } = options;
+
+  const files = ['.npmignore', 'index.js'];
+
+  const filePaths = glob.sync(globPattern(files), {
+    cwd: projectRoot,
+  });
+
+  const pathMapping = mapFilePaths(filePaths, {
+    from: '',
+    to: '',
+  });
+
+  removeFiles(pathMapping, options);
+}
+
+export function moveProjectRootFiles(options) {
+  copyToAddon(options);
+  moveToAddonAndTestApp(options);
+  moveToTestApp(options);
+  removeFromProjectRoot(options);
+}

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

@@ -0,0 +1,103 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import glob from 'glob';
+
+import { moveFiles } from '../../../utils/files.js';
+import { mapFilePaths } from '../../../utils/map-file-paths.js';
+
+function moveTestsFolder(options) {
+  const { locations, projectRoot } = options;
+
+  let filePaths = glob.sync('tests/dummy/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  let pathMapping = mapFilePaths(filePaths, {
+    from: 'tests/dummy',
+    to: locations.testApp,
+  });
+
+  moveFiles(pathMapping, options);
+
+  filePaths = glob.sync('tests/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    ignore: 'tests/dummy/**/*',
+    nodir: true,
+  });
+
+  pathMapping = mapFilePaths(filePaths, {
+    from: 'tests',
+    to: `${locations.testApp}/tests`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function moveTypesFolder(options) {
+  const { locations, packages, projectRoot } = options;
+
+  if (!packages.addon.hasTypeScript) {
+    return;
+  }
+
+  let filePaths = glob.sync('types/dummy/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  let pathMapping = mapFilePaths(filePaths, {
+    from: 'types/dummy',
+    to: `${locations.testApp}/types/${packages.testApp.name}`,
+  });
+
+  moveFiles(pathMapping, options);
+
+  filePaths = glob.sync('types/**/*', {
+    cwd: projectRoot,
+    dot: true,
+    ignore: 'types/dummy/**/*',
+    nodir: true,
+  });
+
+  pathMapping = mapFilePaths(filePaths, {
+    from: 'types',
+    to: `${locations.testApp}/types`,
+  });
+
+  moveFiles(pathMapping, options);
+}
+
+function renameDummy(options) {
+  const { locations, packages, projectRoot } = 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}`, {
+    cwd: projectRoot,
+    dot: true,
+    nodir: true,
+  });
+
+  filePaths.forEach((filePath) => {
+    const oldPath = join(projectRoot, filePath);
+    const oldFile = readFileSync(oldPath, 'utf8');
+
+    const newFile = oldFile.replace(
+      new RegExp('dummy', 'g'),
+      packages.testApp.name
+    );
+
+    writeFileSync(oldPath, newFile, 'utf8');
+  });
+}
+
+export function moveTestAppFiles(options) {
+  moveTestsFolder(options);
+  moveTypesFolder(options);
+  renameDummy(options);
+}

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

@@ -0,0 +1,130 @@
+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';
+
+function updateDependencies(packageJson) {
+  const dependencies = convertToMap(packageJson['dependencies']);
+
+  const packagesToDelete = [
+    '@embroider/macros',
+    'ember-auto-import',
+    'ember-cli-babel',
+    'ember-cli-htmlbars',
+  ];
+
+  const packagesToInstall = ['@embroider/addon-shim'];
+
+  packagesToDelete.forEach((packageName) => {
+    dependencies.delete(packageName);
+  });
+
+  packagesToInstall.forEach((packageName) => {
+    const version = decideVersion(packageName, dependencies);
+
+    dependencies.set(packageName, version);
+  });
+
+  packageJson['dependencies'] = convertToObject(dependencies);
+}
+
+function updateDevDependencies(packageJson, options) {
+  const { packages } = options;
+
+  const devDependencies = convertToMap(packageJson['devDependencies']);
+
+  const packagesToDelete = [
+    '@embroider/macros',
+    'ember-auto-import',
+    'ember-cli-babel',
+    'ember-cli-htmlbars',
+  ];
+
+  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',
+      ];
+
+  // May be easier to start over and add missing dependencies
+  devDependencies.clear();
+
+  packagesToDelete.forEach((packageName) => {
+    devDependencies.delete(packageName);
+  });
+
+  packagesToInstall.forEach((packageName) => {
+    const version = decideVersion(packageName, devDependencies);
+
+    devDependencies.set(packageName, version);
+  });
+
+  packageJson['devDependencies'] = convertToObject(devDependencies);
+}
+
+function updateOtherFields(packageJson) {
+  packageJson['ember-addon'] = {
+    'app-js': {},
+    main: 'addon-main.js',
+    type: 'addon',
+    version: 2,
+  };
+
+  packageJson['exports'] = {
+    '.': './dist/index.js',
+    './*': './dist/*.js',
+    './addon-main.js': './addon-main.js',
+  };
+
+  packageJson['files'] = ['addon-main.js', 'dist'];
+}
+
+function updateScripts(packageJson) {
+  const scripts = convertToMap(packageJson.scripts);
+
+  scripts.set('build', 'rollup --config');
+  scripts.set('prepack', 'rollup --config');
+  scripts.set('start', 'rollup --config --watch');
+  scripts.set(
+    'test',
+    "echo 'A v2 addon does not have tests, run tests in test-app'"
+  );
+
+  packageJson['scripts'] = convertToObject(scripts);
+}
+
+export function updateAddonPackageJson(options) {
+  const { locations, projectRoot } = options;
+
+  const oldPath = join(projectRoot, locations.addon, 'package.json');
+  const oldFile = readFileSync(oldPath, 'utf8');
+  const packageJson = JSON.parse(oldFile);
+
+  updateDependencies(packageJson);
+  updateDevDependencies(packageJson, options);
+  updateScripts(packageJson);
+  updateOtherFields(packageJson);
+
+  const newFile = JSON.stringify(packageJson, null, 2) + '\n';
+
+  writeFileSync(oldPath, newFile, 'utf8');
+}

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

@@ -0,0 +1,42 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import {
+  convertToMap,
+  convertToObject,
+} from '../../../utils/convert-json-object.js';
+
+function updateCompilerOptions(tsconfigJson) {
+  const compilerOptions = convertToMap(tsconfigJson['compilerOptions']);
+
+  compilerOptions.delete('baseUrl');
+  compilerOptions.delete('paths');
+
+  tsconfigJson['compilerOptions'] = convertToObject(compilerOptions);
+}
+
+function updateInclude(tsconfigJson) {
+  tsconfigJson['include'] = ['src/**/*', 'unpublished-development-types/**/*'];
+}
+
+export function updateAddonTsconfigJson(options) {
+  const { locations, packages, projectRoot } = options;
+
+  if (!packages.addon.hasTypeScript) {
+    return;
+  }
+
+  const oldPath = join(projectRoot, locations.addon, 'tsconfig.json');
+  const oldFile = readFileSync(oldPath, 'utf8');
+  const tsconfigJson = JSON.parse(
+    // Remove comments
+    oldFile.replace(new RegExp('//.*', 'mg'), '')
+  );
+
+  updateCompilerOptions(tsconfigJson);
+  updateInclude(tsconfigJson);
+
+  const newFile = JSON.stringify(tsconfigJson, null, 2) + '\n';
+
+  writeFileSync(oldPath, newFile, 'utf8');
+}