base catalyst support with --catalyst flag

Author: thymikee

packages/plugin-platform-apple/src/lib/commands/build/buildOptions.ts

@@ -9,6 +9,7 @@ export type BuildFlags = {
   target?: string;
   extraParams?: string[];
   device?: string;
+  catalyst?: boolean;
   buildFolder?: string;
   destination?: string;
 };
@@ -49,6 +50,10 @@ export const getBuildOptions = ({ platformName }: BuilderCommand) => {
       description:
         'Explicitly set the device to use by name or by unique device identifier. If the value is not provided, the app will run on the first available physical device.',
     },
+    {
+      name: '--catalyst',
+      description: 'Run on Mac Catalyst.',
+    },
     {
       name: '--buildFolder <string>',
       description: `Location for ${readableName} build artifacts. Corresponds to Xcode's "-derivedDataPath".`,

packages/plugin-platform-apple/src/lib/commands/build/buildProject.ts

@@ -45,7 +45,9 @@ export const buildProject = async (
         }
       }
 
-      return udid
+      return args.catalyst
+        ? 'platform=macOS,variant=Mac Catalyst'
+        : udid
         ? `id=${udid}`
         : mode === 'Debug' || args.device
         ? `generic/platform=${simulatorDest}`

packages/plugin-platform-apple/src/lib/commands/run/createRun.ts

@@ -19,6 +19,7 @@ import { RunFlags } from './runOptions.js';
 import { selectFromInteractiveMode } from '../../utils/selectFromInteractiveMode.js';
 import { outro, spinner } from '@clack/prompts';
 import { runOnMac } from './runOnMac.js';
+import { runOnMacCatalyst } from './runOnMacCatalyst.js';
 
 export const createRun = async (
   platformName: ApplePlatform,
@@ -50,7 +51,13 @@ export const createRun = async (
       );
 
   if (platformName === 'macos') {
-    return await runOnMac(xcodeProject, mode, scheme, args);
+    await runOnMac(xcodeProject, mode, scheme, args);
+    outro('Success 🎉.');
+    return;
+  } else if (args.catalyst) {
+    await runOnMacCatalyst(platformName, mode, scheme, xcodeProject, args);
+    outro('Success 🎉.');
+    return;
   }
 
   const loader = spinner();
@@ -74,9 +81,10 @@ export const createRun = async (
         scheme,
         args
       );
-    } else {
+    } else if (device.type === 'device') {
       await runOnDevice(device, platformName, mode, scheme, xcodeProject, args);
     }
+    outro('Success 🎉.');
     return;
   } else {
     const bootedSimulators = devices.filter(

packages/plugin-platform-apple/src/lib/commands/run/getBuildPath.ts

@@ -4,8 +4,7 @@ import { ApplePlatform } from '../../types/index.js';
 
 export function getBuildPath(
   buildSettings: BuildSettings,
-  platform: ApplePlatform = 'ios',
-  isCatalyst = false
+  platform: ApplePlatform
 ) {
   const targetBuildDir = buildSettings.TARGET_BUILD_DIR;
   const executableFolderPath = buildSettings.EXECUTABLE_FOLDER_PATH;
@@ -23,9 +22,7 @@ export function getBuildPath(
     throw new Error('Failed to get product name.');
   }
 
-  if (isCatalyst) {
-    return path.join(`${targetBuildDir}-maccatalyst`, executableFolderPath);
-  } else if (platform === 'macos') {
+  if (platform === 'macos') {
     return path.join(targetBuildDir, fullProductName);
   } else {
     return path.join(targetBuildDir, executableFolderPath);

packages/plugin-platform-apple/src/lib/commands/run/installApp.ts

@@ -13,7 +13,7 @@ type Options = {
   target?: string;
   udid: string;
   binaryPath?: string;
-  platform?: ApplePlatform;
+  platform: ApplePlatform;
 };
 
 export default async function installApp({

packages/plugin-platform-apple/src/lib/commands/run/runOnDevice.ts

@@ -15,12 +15,6 @@ export async function runOnDevice(
   xcodeProject: XcodeProjectInfo,
   args: RunFlags
 ) {
-  if (args.binaryPath && selectedDevice.type === 'catalyst') {
-    throw new Error(
-      'binary-path was specified for catalyst device, which is not supported.'
-    );
-  }
-
   try {
     await spawn('ios-deploy', ['--version']);
   } catch {
@@ -31,8 +25,9 @@ export async function runOnDevice(
     );
   }
 
-  if (selectedDevice.type === 'catalyst') {
-    const buildOutput = await buildProject(
+  let buildOutput, appPath;
+  if (!args.binaryPath) {
+    buildOutput = await buildProject(
       xcodeProject,
       platform,
       selectedDevice.udid,
@@ -52,57 +47,27 @@ export async function runOnDevice(
       throw new Error('Failed to get build settings for your project');
     }
 
-    const appPath = getBuildPath(buildSettings, platform, true);
-    const appProcess = spawn(`${appPath}/${scheme}`, [], {
-      detached: true,
-      stdio: 'ignore',
-    });
-    (await appProcess.nodeChildProcess).unref();
+    appPath = getBuildPath(buildSettings, platform);
   } else {
-    let buildOutput, appPath;
-    if (!args.binaryPath) {
-      buildOutput = await buildProject(
-        xcodeProject,
-        platform,
-        selectedDevice.udid,
-        scheme,
-        mode,
-        args
-      );
-
-      const buildSettings = await getBuildSettings(
-        xcodeProject,
-        mode,
-        buildOutput,
-        scheme
-      );
-
-      if (!buildSettings) {
-        throw new Error('Failed to get build settings for your project');
-      }
-
-      appPath = getBuildPath(buildSettings, platform);
-    } else {
-      appPath = args.binaryPath;
-    }
+    appPath = args.binaryPath;
+  }
 
-    const iosDeployInstallArgs = [
-      '--bundle',
-      appPath,
-      '--id',
-      selectedDevice.udid,
-      '--justlaunch',
-    ];
+  const iosDeployInstallArgs = [
+    '--bundle',
+    appPath,
+    '--id',
+    selectedDevice.udid,
+    '--justlaunch',
+  ];
 
-    logger.info(`Installing and launching your app on ${selectedDevice.name}`);
+  logger.info(`Installing and launching your app on ${selectedDevice.name}`);
 
-    try {
-      await spawn('ios-deploy', iosDeployInstallArgs, { stdio: 'inherit' });
-    } catch (error) {
-      throw new Error(
-        `Failed to install the app on the device with "ios-deploy": ${error}`
-      );
-    }
+  try {
+    await spawn('ios-deploy', iosDeployInstallArgs, { stdio: 'inherit' });
+  } catch (error) {
+    throw new Error(
+      `Failed to install the app on the device with "ios-deploy": ${error}`
+    );
   }
 
   return logger.success('Installed the app on the device.');

packages/plugin-platform-apple/src/lib/commands/run/runOnMacCatalyst.ts

@@ -0,0 +1,46 @@
+import { ApplePlatform, XcodeProjectInfo } from '../../types/index.js';
+import { buildProject } from '../build/buildProject.js';
+import { getBuildPath } from './getBuildPath.js';
+import { getBuildSettings } from './getBuildSettings.js';
+import { RunFlags } from './runOptions.js';
+import spawn from 'nano-spawn';
+
+export async function runOnMacCatalyst(
+  platform: ApplePlatform,
+  mode: string,
+  scheme: string,
+  xcodeProject: XcodeProjectInfo,
+  args: RunFlags
+) {
+  if (args.binaryPath) {
+    throw new Error(
+      'The "--binary-path" flag is not supported for Mac Catalyst device.'
+    );
+  }
+  const buildOutput = await buildProject(
+    xcodeProject,
+    platform,
+    undefined,
+    scheme,
+    mode,
+    args
+  );
+
+  const buildSettings = await getBuildSettings(
+    xcodeProject,
+    mode,
+    buildOutput,
+    scheme
+  );
+
+  if (!buildSettings) {
+    throw new Error('Failed to get build settings for your project');
+  }
+
+  const appPath = getBuildPath(buildSettings, platform);
+  const appProcess = spawn(`${appPath}/${scheme}`, [], {
+    detached: true,
+    stdio: 'ignore',
+  });
+  (await appProcess.nodeChildProcess).unref();
+}

packages/plugin-platform-apple/src/lib/commands/run/runOnSimulator.ts

@@ -63,6 +63,7 @@ export async function runOnSimulator(
     target,
     udid: simulator.udid,
     binaryPath,
+    platform,
   });
   loader.stop(`Installed the app on "${simulator.name}".`);
 }

packages/plugin-platform-apple/src/lib/types/index.ts

@@ -12,7 +12,7 @@ export interface Device {
   state?: 'Booted' | 'Shutdown';
 }
 
-export type DeviceType = 'simulator' | 'device' | 'catalyst';
+export type DeviceType = 'simulator' | 'device';
 
 export interface Info {
   name: string;