feat: Add migration for existing project

api/__tests__/migrate.test.ts

@@ -171,7 +171,7 @@ describe('api/migrate', () => {
       const mockResponse: MigrationStatus = {
         id: mockMigrationId,
         status: MIGRATION_STATUS.FAILURE,
-        projectErrorsDetail: 'Error details',
+        projectErrorDetail: 'Error details',
         componentErrorDetails: {
           'component-1': 'Component error',
         },

api/migrate.ts

@@ -72,7 +72,7 @@ export interface MigrationSuccess extends MigrationBaseStatus {
 
 export interface MigrationFailed extends MigrationBaseStatus {
   status: typeof MIGRATION_STATUS.FAILURE;
-  projectErrorsDetail?: string;
+  projectErrorDetail: string;
   componentErrorDetails: Record<string, string>;
 }
 
@@ -82,6 +82,15 @@ export type MigrationStatus =
   | MigrationSuccess
   | MigrationFailed;
 
+export function isMigrationStatus(error: unknown): error is MigrationStatus {
+  return (
+    typeof error === 'object' &&
+    error !== null &&
+    'id' in error &&
+    'status' in error
+  );
+}
+
 export async function listAppsForMigration(
   accountId: number
 ): HubSpotPromise<ListAppsResponse> {

commands/__tests__/project.test.ts

@@ -11,6 +11,7 @@ import open from '../project/open';
 import * as dev from '../project/dev';
 import add from '../project/add';
 import migrateApp from '../project/migrateApp';
+import migrate from '../project/migrate';
 import cloneApp from '../project/cloneApp';
 import installDeps from '../project/installDeps';
 
@@ -27,6 +28,7 @@ jest.mock('../project/dev');
 jest.mock('../project/add');
 jest.mock('../project/migrateApp', () => ({}));
 jest.mock('../project/cloneApp', () => ({}));
+jest.mock('../project/migrate', () => ({}));
 jest.mock('../project/installDeps');
 jest.mock('../../lib/commonOpts');
 
@@ -68,6 +70,7 @@ describe('commands/project', () => {
       ['migrateApp', migrateApp],
       ['cloneApp', cloneApp],
       ['installDeps', installDeps],
+      ['migrate', migrate],
     ];
 
     it('should demand the command takes one positional argument', () => {

commands/project.ts

@@ -13,6 +13,7 @@ const open = require('./project/open');
 const dev = require('./project/dev');
 const add = require('./project/add');
 const migrateApp = require('./project/migrateApp');
+const migrate = require('./project/migrate');
 const cloneApp = require('./project/cloneApp');
 const installDeps = require('./project/installDeps');
 
@@ -36,6 +37,7 @@ exports.builder = yargs => {
     .command(download)
     .command(open)
     .command(migrateApp)
+    .command(migrate)
     .command(cloneApp)
     .command(installDeps)
     .demandCommand(1, '');

commands/project/cloneApp.ts

@@ -54,7 +54,7 @@ export const handler = async (options: ArgumentsCamelCase<CloneAppArgs>) => {
   }
 
   if (!isAppDeveloperAccount(accountConfig)) {
-    logInvalidAccountError(i18nKey);
+    logInvalidAccountError();
     process.exit(EXIT_CODES.SUCCESS);
   }
 

commands/project/migrate.ts

@@ -0,0 +1,65 @@
+import { i18n } from '../../lib/lang';
+
+import { ArgumentsCamelCase, Argv, CommandModule } from 'yargs';
+import { logger } from '@hubspot/local-dev-lib/logger';
+import { ProjectMigrateOptions } from '../../types/Yargs';
+import {
+  addAccountOptions,
+  addConfigOptions,
+  addGlobalOptions,
+} from '../../lib/commonOpts';
+import { migrateApp2025_2 } from '../../lib/app/migrate';
+import { getProjectConfig } from '../../lib/projects';
+import { PLATFORM_VERSIONS } from '@hubspot/local-dev-lib/constants/projects';
+import { logError } from '../../lib/errorHandlers';
+import { EXIT_CODES } from '../../lib/enums/exitCodes';
+
+export const command = 'migrate';
+
+export const describe = undefined; // i18n('commands.project.subcommands.migrate.noProjectConfig')
+
+export async function handler(
+  options: ArgumentsCamelCase<ProjectMigrateOptions>
+) {
+  const projectConfig = await getProjectConfig();
+
+  if (!projectConfig.projectConfig) {
+    logger.error(
+      i18n('commands.project.subcommands.migrate.errors.noProjectConfig')
+    );
+    return process.exit(EXIT_CODES.ERROR);
+  }
+
+  const { derivedAccountId } = options;
+  try {
+    await migrateApp2025_2(
+      derivedAccountId,
+      {
+        ...options,
+        name: projectConfig?.projectConfig?.name,
+        platformVersion: PLATFORM_VERSIONS.unstable,
+      },
+      projectConfig
+    );
+  } catch (error) {
+    logError(error);
+    return process.exit(EXIT_CODES.ERROR);
+  }
+  return process.exit(EXIT_CODES.SUCCESS);
+}
+
+export function builder(yargs: Argv) {
+  addConfigOptions(yargs);
+  addAccountOptions(yargs);
+  addGlobalOptions(yargs);
+
+  return yargs as Argv<ProjectMigrateOptions>;
+}
+const migrateAppCommand: CommandModule<unknown, ProjectMigrateOptions> = {
+  command,
+  describe,
+  handler,
+  builder,
+};
+
+export default migrateAppCommand;

lang/en.lyaml

@@ -588,6 +588,7 @@ en:
           componentsToBeMigrated: "The following component types will be migrated: {{ components }}"
           componentsThatWillNotBeMigrated: "[NOTE] These component types are not yet supported for migration but will be available later: {{ components }}"
           errors:
+            noAppsForProject: "No apps associated with project {{ projectName }}"
             noAppsEligible: "No apps in account {{ accountId }} are currently migratable"
             noAccountConfig: "There is no account associated with {{ accountId }} in the config file. Please choose another account and try again, or authenticate {{ accountId }} using {{ authCommand }}."
             invalidAccountTypeTitle: "{{#bold}}Developer account not targeted{{/bold}}"
@@ -614,11 +615,7 @@ en:
             copyingProjectFiles: "Copying migrated project files"
             copyingProjectFilesComplete: "Migrated project files copied"
             copyingProjectFilesFailed: "Unable to copy migrated project files"
-          unmigratableReasons:
-            upToDate: 'App is already up to date'
-            isPrivateApp: 'Private apps are not currently migratable'
-            listedInMarketplace: 'Listed apps are not currently migratable'
-            generic: "Unable to migrate app: {{ reasonCode }}"
+
         cloneApp:
           describe: "Clone a public app using the projects framework."
           examples:
@@ -655,6 +652,12 @@ en:
           examples:
             default: "Create a component within your project"
             withFlags: "Use --name and --type flags to bypass the prompt."
+        migrate:
+            describe: "Migrate a project to the projects framework."
+            errors:
+                noProjectConfig: "No project detected. Please run this command again from a project directory."
+            examples:
+                default: "Migrate a project to the projects framework"
         deploy:
           describe: "Deploy a project build."
           deployBuildIdPrompt: "[--build] Deploy which build?"

lang/en.js → lang/en.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import chalk from 'chalk';
 
 export const commands = {
@@ -994,35 +995,6 @@ export const commands = {
         appWithAppIdNotFound: appId =>
           `Could not find an app with the id ${appId} `,
       },
-      prompt: {
-        chooseApp: 'Which app would you like to migrate?',
-        inputName: '[--name] What would you like to name the project?',
-        inputDest: '[--dest] Where would you like to save the project?',
-        uidForComponent: componentName =>
-          `What UID would you like to use for ${componentName}?`,
-        proceed: 'Would you like to proceed?',
-      },
-      spinners: {
-        beginningMigration: 'Beginning migration',
-        migrationStarted: 'Migration started',
-        unableToStartMigration: 'Unable to begin migration',
-        finishingMigration: 'Wrapping up migration',
-        migrationComplete: 'Migration completed',
-        migrationFailed: 'Migration failed',
-        downloadingProjectContents: 'Downloading migrated project files',
-        downloadingProjectContentsComplete: 'Migrated project files downloaded',
-        downloadingProjectContentsFailed:
-          'Unable to download migrated project files',
-        copyingProjectFiles: 'Copying migrated project files',
-        copyingProjectFilesComplete: 'Migrated project files copied',
-        copyingProjectFilesFailed: 'Unable to copy migrated project files',
-      },
-      migrationNotAllowedReasons: {
-        upToDate: 'App is already up to date',
-        isPrivateApp: 'Private apps are not currently migratable',
-        listedInMarketplace: 'Listed apps are not currently migratable',
-        generic: reasonCode => `Unable to migrate app: ${reasonCode}`,
-      },
     },
     cloneApp: {
       describe: 'Clone a public app using the projects framework.',
@@ -3448,4 +3420,60 @@ export const lib = {
   oauth: {
     missingClientId: 'Error building oauth URL: missing client ID.',
   },
+  migrate: {
+    componentsToBeMigrated: components =>
+      `The following component types will be migrated: ${components}`,
+    componentsThatWillNotBeMigrated: components =>
+      `[NOTE] These component types are not yet supported for migration but will be available later: ${components}`,
+    errors: {
+      project: {
+        invalidConfig:
+          'The project configuration file is invalid. Please check the config file and try again.',
+        doesNotExist: 'Project does not exist, unable to migrate',
+        multipleApps:
+          'Multiple apps found in project, this is not allowed in 2025.2',
+        alreadyExists: projectName =>
+          `A project with name ${projectName} already exists. Please choose another name.`,
+      },
+      unmigratableReasons: {
+        upToDate: 'App is already up to date',
+        isPrivateApp: 'Private apps are not currently migratable',
+        listedInMarketplace: 'Listed apps are not currently migratable',
+        generic: reasonCode => `Unable to migrate app: ${reasonCode}`,
+      },
+      noAppsEligible: (accountId, reasons) =>
+        `No apps in account ${accountId} are currently migratable${reasons.length ? `\n  - ${reasons.join('\n  - ')}` : ''}`,
+
+      invalidAccountTypeTitle: () =>
+        `${chalk.bold('Developer account not targeted')}`,
+      invalidAccountTypeDescription: (useCommand, authCommand) =>
+        `Only public apps created in a developer account can be converted to a project component. Select a connected developer account with ${useCommand} or ${authCommand} and try again.`,
+      appWithAppIdNotFound: appId =>
+        `Could not find an app with the id ${appId} `,
+      noAppsForProject: 'No apps associated with project {{ projectName }}',
+      migrationFailed: 'Migration Failed',
+    },
+    prompt: {
+      chooseApp: 'Which app would you like to migrate?',
+      inputName: '[--name] What would you like to name the project?',
+      inputDest: '[--dest] Where would you like to save the project?',
+      uidForComponent: componentName =>
+        `What UID would you like to use for ${componentName}?`,
+      proceed: 'Would you like to proceed?',
+    },
+    spinners: {
+      beginningMigration: 'Beginning migration',
+      unableToStartMigration: 'Unable to begin migration',
+      finishingMigration: 'Wrapping up migration',
+      migrationComplete: 'Migration completed',
+      migrationFailed: 'Migration failed',
+      downloadingProjectContents: 'Downloading migrated project files',
+      downloadingProjectContentsComplete: 'Migrated project files downloaded',
+      downloadingProjectContentsFailed:
+        'Unable to download migrated project files',
+      copyingProjectFiles: 'Copying migrated project files',
+      copyingProjectFilesComplete: 'Migrated project files copied',
+      copyingProjectFilesFailed: 'Unable to copy migrated project files',
+    },
+  },
 };