feat: add run:ios command (#41)

* feat: add run:ios command

* refactor output for more feedback with spinners

* adjust error handling

* slightly better handling of ios-deploy

* remove --list-devices flag

* move error to normalizer

* drastically simplify createRun data flow

* cleanup

* add warnings and handle devices case

* use spawn

* create runOnMac helper

* move single-use utils closer to callsites

* handle prompt cancellation

* move code under src/lib to match repo convention

* add success message

* add missing dot

* remove copyright

* support preferred device; ts was right

* extract selectDevice

* move warnings to helper

* cache per platform, remove unused legacyPath

* fix test

* remove fallback sim logic; prompt for devices when none open or cached

* allow for --simulator without specified name

* remove unixifyPaths

* remove preferred device logic

* perf: use devicectl instead of xcdevice; refactor Device

* base catalyst support with --catalyst flag

* get rid of chdir

* feat: recent devices sort

* filter devices by platform

Author: thymikee

packages/plugin-platform-android/src/lib/commands/runAndroid/__tests__/tryLaunchAppOnDevice.test.ts

@@ -36,6 +36,7 @@ const args: Flags = {
   port: '8081',
   appId: '',
   appIdSuffix: '',
+  mode: 'debug',
 };
 
 const androidProject: AndroidProjectConfig = {

packages/plugin-platform-apple/package.json

@@ -20,6 +20,7 @@
     "@react-native-community/cli-config-apple": "^15.1.2",
     "fast-glob": "^3.3.2",
     "fast-xml-parser": "^4.5.0",
+    "is-interactive": "^2.0.0",
     "nano-spawn": "^0.2.0",
     "picocolors": "^1.1.1",
     "tslib": "^2.3.0"

packages/plugin-platform-apple/src/commands/build/index.ts

@@ -9,6 +9,7 @@ export type BuildFlags = {
   target?: string;
   extraParams?: string[];
   device?: string;
+  catalyst?: boolean;
   buildFolder?: string;
   destination?: string;
 };
@@ -47,8 +48,11 @@ export const getBuildOptions = ({ platformName }: BuilderCommand) => {
     {
       name: '--device [string]',
       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.',
+        '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>',

packages/plugin-platform-apple/src/lib/__tests__/dummy.test.ts

@@ -1,21 +1,20 @@
 import type { BuildFlags } from './buildOptions.js';
-import { supportedPlatforms } from '../../supportedPlatforms.js';
+import { supportedPlatforms } from '../../utils/supportedPlatforms.js';
 import { ApplePlatform, XcodeProjectInfo } from '../../types/index.js';
 import { logger } from '@callstack/rnef-tools';
-import { getConfiguration } from './getConfiguration.js';
 import { simulatorDestinationMap } from './simulatorDestinationMap.js';
 import { spinner } from '@clack/prompts';
-import spawn from 'nano-spawn';
-import { selectFromInteractiveMode } from '../../utils/selectFromInteractiveMode.js';
-import path from 'node:path';
+import spawn, { SubprocessError } from 'nano-spawn';
 
-const buildProject = async (
+export const buildProject = async (
   xcodeProject: XcodeProjectInfo,
+  sourceDir: string,
   platformName: ApplePlatform,
   udid: string | undefined,
+  scheme: string,
+  mode: string,
   args: BuildFlags
 ) => {
-  normalizeArgs(args, xcodeProject);
   const simulatorDest = simulatorDestinationMap[platformName];
 
   if (!simulatorDest) {
@@ -26,15 +25,6 @@ const buildProject = async (
     );
   }
 
-  const { scheme, mode } = args.interactive
-    ? await selectFromInteractiveMode(xcodeProject, args.scheme, args.mode)
-    : await getConfiguration(
-        xcodeProject,
-        args.scheme,
-        args.mode,
-        platformName
-      );
-
   const xcodebuildArgs = [
     xcodeProject.isWorkspace ? '-workspace' : '-project',
     xcodeProject.name,
@@ -56,7 +46,9 @@ const buildProject = async (
         }
       }
 
-      return udid
+      return args.catalyst
+        ? 'platform=macOS,variant=Mac Catalyst'
+        : udid
         ? `id=${udid}`
         : mode === 'Debug' || args.device
         ? `generic/platform=${simulatorDest}`
@@ -74,33 +66,22 @@ const buildProject = async (
     `Builing the app with xcodebuild for ${scheme} scheme in ${mode} mode.`
   );
   logger.debug(`Running "xcodebuild ${xcodebuildArgs.join(' ')}.`);
-
   try {
-    await spawn('xcodebuild', xcodebuildArgs, {
-      stdio: logger.isVerbose() ? 'inherit' : ['ignore', 'ignore', 'inherit'],
+    const { output } = await spawn('xcodebuild', xcodebuildArgs, {
+      cwd: sourceDir,
     });
     loader.stop(
       `Built the app with xcodebuild for ${scheme} scheme in ${mode} mode.`
     );
+    return output;
   } catch (error) {
+    logger.log('');
+    logger.log((error as SubprocessError).stdout);
+    logger.error((error as SubprocessError).stderr);
     loader.stop(
       'Running xcodebuild failed. Check the error message above for details.',
       1
     );
-    throw error;
+    throw new Error('Running xcodebuild failed');
   }
 };
-
-function normalizeArgs(args: BuildFlags, xcodeProject: XcodeProjectInfo) {
-  if (!args.mode) {
-    args.mode = 'Debug';
-  }
-  if (!args.scheme) {
-    args.scheme = path.basename(
-      xcodeProject.name,
-      path.extname(xcodeProject.name)
-    );
-  }
-}
-
-export { buildProject };

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

@@ -0,0 +1,80 @@
+import { BuildFlags } from './buildOptions.js';
+import { buildProject } from './buildProject.js';
+import {
+  BuilderCommand,
+  ProjectConfig,
+  XcodeProjectInfo,
+} from '../../types/index.js';
+import { logger } from '@callstack/rnef-tools';
+import { outro, cancel } from '@clack/prompts';
+import path from 'path';
+import { selectFromInteractiveMode } from '../../utils/selectFromInteractiveMode.js';
+import { getConfiguration } from './getConfiguration.js';
+import isInteractive from 'is-interactive';
+
+export const createBuild = async (
+  platformName: BuilderCommand['platformName'],
+  projectConfig: ProjectConfig,
+  args: BuildFlags
+) => {
+  // TODO: add logic for installing Cocoapods based on @expo/fingerprint & pod-install package.
+
+  const { xcodeProject, sourceDir } = projectConfig;
+
+  if (!xcodeProject) {
+    logger.error(
+      `Could not find Xcode project files in "${sourceDir}" folder. Please make sure that you have installed Cocoapods and "${sourceDir}" is a valid path`
+    );
+    process.exit(1);
+  }
+
+  normalizeArgs(args, xcodeProject);
+
+  const { scheme, mode } = args.interactive
+    ? await selectFromInteractiveMode(
+        xcodeProject,
+        sourceDir,
+        args.scheme,
+        args.mode
+      )
+    : await getConfiguration(
+        xcodeProject,
+        sourceDir,
+        args.scheme,
+        args.mode,
+        platformName
+      );
+
+  try {
+    await buildProject(
+      xcodeProject,
+      sourceDir,
+      platformName,
+      undefined,
+      scheme,
+      mode,
+      args
+    );
+    outro('Success 🎉.');
+  } catch {
+    cancel('Command failed.');
+  }
+};
+
+function normalizeArgs(args: BuildFlags, xcodeProject: XcodeProjectInfo) {
+  if (!args.mode) {
+    args.mode = 'Debug';
+  }
+  if (!args.scheme) {
+    args.scheme = path.basename(
+      xcodeProject.name,
+      path.extname(xcodeProject.name)
+    );
+  }
+  if (args.interactive && !isInteractive()) {
+    logger.warn(
+      'Interactive mode is not supported in non-interactive environments.'
+    );
+    args.interactive = false;
+  }
+}

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

@@ -7,15 +7,13 @@ import color from 'picocolors';
 
 export async function getConfiguration(
   xcodeProject: XcodeProjectInfo,
+  sourceDir: string,
   inputScheme: string,
   inputMode: string,
   platformName: ApplePlatform
 ) {
-  const sourceDir = process.cwd();
   const info = await getInfo(xcodeProject, sourceDir);
-
   checkIfConfigurationExists(info?.configurations ?? [], inputMode);
-
   let scheme = inputScheme;
 
   if (!info?.schemes?.includes(scheme)) {

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

@@ -2,7 +2,7 @@ import { ApplePlatform } from '../../types/index.js';
 
 export const simulatorDestinationMap: Record<ApplePlatform, string> = {
   ios: 'iOS Simulator',
-  // macos: 'macOS',
-  // visionos: 'visionOS Simulator',
-  // tvos: 'tvOS Simulator',
+  macos: 'macOS',
+  visionos: 'visionOS Simulator',
+  tvos: 'tvOS Simulator',
 };