Renamed the two types of options (#9)

* chore: Renamed options to codemodOptions

* chore: Renamed augmentOptions to createOptions

* chore: Renamed augmentedOptions to options

* chore: Fixed linting errors

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

Author: ijlee2

bin/ember-codemod-v1-to-v2.js

@@ -32,11 +32,11 @@ function castEmptyStringToUndefined(string) {
   return string === '' ? undefined : string;
 }
 
-const options = {
+const codemodOptions = {
   addonLocation: castEmptyStringToUndefined(argv['addon-location']),
   projectRoot: argv['root'] ?? process.cwd(),
   testAppLocation: castEmptyStringToUndefined(argv['test-app-location']),
   testAppName: castEmptyStringToUndefined(argv['test-app-name']),
 };
 
-runCodemod(options);
+runCodemod(codemodOptions);

src/index.js

@@ -1,5 +1,5 @@
 import { migrateEmberAddon } from './migration/index.js';
 
-export function runCodemod(options) {
-  migrateEmberAddon(options);
+export function runCodemod(codemodOptions) {
+  migrateEmberAddon(codemodOptions);
 }

src/migration/ember-addon/index.js

@@ -1,7 +1,7 @@
 import {
   analyzeAddon,
-  augmentOptions,
   createFilesFromBlueprint,
+  createOptions,
   moveAddonFiles,
   moveProjectRootFiles,
   moveTestAppFiles,
@@ -12,30 +12,30 @@ import {
   useRelativePaths,
 } from './steps/index.js';
 
-export function migrateEmberAddon(options) {
-  const augmentedOptions = augmentOptions(options);
-  const { isV1Addon } = augmentedOptions.packages.addon;
+export function migrateEmberAddon(codemodOptions) {
+  const options = createOptions(codemodOptions);
+  const { isV1Addon } = options.packages.addon;
 
   // Guarantee idempotency
   if (!isV1Addon) {
     return;
   }
 
   // Prepare for migration
-  const context = analyzeAddon(augmentedOptions);
-  useRelativePaths(augmentedOptions);
+  const context = analyzeAddon(options);
+  useRelativePaths(options);
 
   // Preserve code
-  moveAddonFiles(augmentedOptions);
-  moveTestAppFiles(augmentedOptions);
-  moveProjectRootFiles(augmentedOptions);
+  moveAddonFiles(options);
+  moveTestAppFiles(options);
+  moveProjectRootFiles(options);
 
   // Get the latest code from blueprint
-  createFilesFromBlueprint(context, augmentedOptions);
+  createFilesFromBlueprint(context, options);
 
   // Fine-tune individual files
-  updateAddonPackageJson(augmentedOptions);
-  updateAddonTsconfigJson(augmentedOptions);
-  updateTestAppPackageJson(augmentedOptions);
-  updateTestAppTsconfigJson(augmentedOptions);
+  updateAddonPackageJson(options);
+  updateAddonTsconfigJson(options);
+  updateTestAppPackageJson(options);
+  updateTestAppTsconfigJson(options);
 }

src/migration/ember-addon/steps/augment-options.js renamed to src/migration/ember-addon/steps/create-options.js

@@ -3,8 +3,8 @@ import { join } from 'node:path';
 
 import glob from 'glob';
 
-function analyzePackageJson(options) {
-  const { projectRoot } = options;
+function analyzePackageJson(codemodOptions) {
+  const { projectRoot } = codemodOptions;
 
   try {
     const packageJsonFile = readFileSync(
@@ -48,8 +48,8 @@ function analyzePackageJson(options) {
   }
 }
 
-function analyzePackageManager(options) {
-  const { projectRoot } = options;
+function analyzePackageManager(codemodOptions) {
+  const { projectRoot } = codemodOptions;
 
   const lockFiles = glob.sync('{package-lock.json,pnpm-lock.yaml,yarn.lock}', {
     cwd: projectRoot,
@@ -92,22 +92,22 @@ function deriveAddonLocation(addonPackage) {
   return packageName;
 }
 
-export function augmentOptions(options) {
-  const addonPackage = analyzePackageJson(options);
-  const packageManager = analyzePackageManager(options);
+export function createOptions(codemodOptions) {
+  const addonPackage = analyzePackageJson(codemodOptions);
+  const packageManager = analyzePackageManager(codemodOptions);
 
   return {
     locations: {
-      addon: options.addonLocation ?? deriveAddonLocation(addonPackage),
-      testApp: options.testAppLocation ?? 'test-app',
+      addon: codemodOptions.addonLocation ?? deriveAddonLocation(addonPackage),
+      testApp: codemodOptions.testAppLocation ?? 'test-app',
     },
     packageManager,
     packages: {
       addon: addonPackage,
       testApp: {
-        name: options.testAppName ?? 'test-app',
+        name: codemodOptions.testAppName ?? 'test-app',
       },
     },
-    projectRoot: options.projectRoot,
+    projectRoot: codemodOptions.projectRoot,
   };
 }

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

@@ -1,6 +1,6 @@
 export * from './analyze-addon.js';
-export * from './augment-options.js';
 export * from './create-files-from-blueprint.js';
+export * from './create-options.js';
 export * from './move-addon-files.js';
 export * from './move-project-root-files.js';
 export * from './move-test-app-files.js';

tests/helpers/shared-test-setups/customizations.js

@@ -1,11 +1,11 @@
-const options = {
+const codemodOptions = {
   addonLocation: 'packages/ember-container-query',
   projectRoot: 'tmp/ember-container-query-customizations',
   testAppLocation: 'demo-app',
   testAppName: 'demo-app-for-ember-container-query',
 };
 
-const augmentedOptions = {
+const options = {
   locations: {
     addon: 'packages/ember-container-query',
     testApp: 'demo-app',
@@ -121,4 +121,4 @@ const augmentedOptions = {
   projectRoot: 'tmp/ember-container-query-customizations',
 };
 
-export { augmentedOptions, options };
+export { codemodOptions, options };

tests/helpers/shared-test-setups/glint.js

@@ -1,11 +1,11 @@
-const options = {
+const codemodOptions = {
   addonLocation: undefined,
   projectRoot: 'tmp/ember-container-query-typescript',
   testAppLocation: undefined,
   testAppName: undefined,
 };
 
-const augmentedOptions = {
+const options = {
   locations: {
     addon: 'ember-container-query',
     testApp: 'test-app',
@@ -121,4 +121,4 @@ const augmentedOptions = {
   projectRoot: 'tmp/ember-container-query-typescript',
 };
 
-export { augmentedOptions, options };
+export { codemodOptions, options };

tests/helpers/shared-test-setups/javascript.js

@@ -1,11 +1,11 @@
-const options = {
+const codemodOptions = {
   addonLocation: undefined,
   projectRoot: 'tmp/ember-container-query-javascript',
   testAppLocation: undefined,
   testAppName: undefined,
 };
 
-const augmentedOptions = {
+const options = {
   locations: {
     addon: 'ember-container-query',
     testApp: 'test-app',
@@ -93,4 +93,4 @@ const augmentedOptions = {
   projectRoot: 'tmp/ember-container-query-javascript',
 };
 
-export { augmentedOptions, options };
+export { codemodOptions, options };

tests/helpers/shared-test-setups/typescript.js

@@ -1,11 +1,11 @@
-const options = {
+const codemodOptions = {
   addonLocation: undefined,
   projectRoot: 'tmp/ember-container-query-typescript',
   testAppLocation: undefined,
   testAppName: undefined,
 };
 
-const augmentedOptions = {
+const options = {
   locations: {
     addon: 'ember-container-query',
     testApp: 'test-app',
@@ -117,4 +117,4 @@ const augmentedOptions = {
   projectRoot: 'tmp/ember-container-query-typescript',
 };
 
-export { augmentedOptions, options };
+export { codemodOptions, options };

tests/helpers/testing/assert-fixture.js

@@ -2,8 +2,8 @@ import { strict as assert } from 'node:assert';
 
 import fixturify from 'fixturify';
 
-export function assertFixture(outputProject, options) {
-  const { projectRoot } = options;
+export function assertFixture(outputProject, codemodOptions) {
+  const { projectRoot } = codemodOptions;
 
   assert.deepStrictEqual(fixturify.readSync(projectRoot), outputProject);
 }