feat: add platform-cli-apple with reusable utilities for OOT platforms (#2208)

* feat: refactor run-ios to separate files, export more utilities

* [wip] feat: use builder pattern to easily reuse commands for OOT platforms

* feat: add  package

* docs: document cli-platform-apple

* fix: move generated files

* fix: indentation

* fix: building packages

* fix: tests

* fix: account for macOS in simulatorDest

* fix: recheck pods for build command

* feat: add getProjectConfig for OOT platforms

* feat: fallback to first available device

* refactor: use platformInfo utility

* fix: bring back podspecs

* fix: apply reviewers comments

Author: okwasniewski

CODEOWNERS

@@ -6,4 +6,5 @@ packages/cli-doctor/src/tools/healthchecks/android* @cipolleschi
 
 # iOS
 packages/cli-platform-ios/ @cipolleschi
-packages/cli-doctor/src/tools/healthchecks/ios* @cipolleschi
+packages/cli-platform-apple/ @cipolleschi
+packages/cli-doctor/src/tools/healthchecks/ios* @cipolleschi

CONTRIBUTING.md

@@ -35,7 +35,7 @@ And then:
 
 ```sh
 cd /my/new/react-native/project/
-yarn link "@react-native-community/cli-platform-ios" "@react-native-community/cli-platform-android" "@react-native-community/cli" "@react-native-community/cli-server-api" "@react-native-community/cli-types" "@react-native-community/cli-tools" "@react-native-community/cli-debugger-ui" "@react-native-community/cli-hermes" "@react-native-community/cli-clean" "@react-native-community/cli-doctor" "@react-native-community/cli-config"
+yarn link "@react-native-community/cli-platform-ios" "@react-native-community/cli-platform-android" "@react-native-community/cli" "@react-native-community/cli-server-api" "@react-native-community/cli-types" "@react-native-community/cli-tools" "@react-native-community/cli-debugger-ui" "@react-native-community/cli-hermes" "@react-native-community/cli-clean" "@react-native-community/cli-doctor" "@react-native-community/cli-config" "@react-native-community/cli-platform-apple"
 ```
 
 Once you're done with testing and you'd like to get back to regular setup, run `yarn unlink` instead of `yarn link` from above command. Then `yarn install --force`.

packages/cli-doctor/package.json

@@ -11,6 +11,7 @@
     "@react-native-community/cli-config": "13.1.0",
     "@react-native-community/cli-platform-android": "13.1.0",
     "@react-native-community/cli-platform-ios": "13.1.0",
+    "@react-native-community/cli-platform-apple": "13.1.0",
     "@react-native-community/cli-tools": "13.1.0",
     "chalk": "^4.1.2",
     "command-exists": "^1.2.8",

packages/cli-doctor/src/commands/info.ts

@@ -8,7 +8,7 @@
 import getEnvironmentInfo from '../tools/envinfo';
 import {logger, version} from '@react-native-community/cli-tools';
 import {Config} from '@react-native-community/cli-types';
-import {getArchitecture} from '@react-native-community/cli-platform-ios';
+import {getArchitecture} from '@react-native-community/cli-platform-apple';
 import {readFile} from 'fs-extra';
 import path from 'path';
 import {stringify} from 'yaml';

packages/cli-doctor/src/tools/healthchecks/xcodeEnv.ts

@@ -1,4 +1,4 @@
-import {findPodfilePaths} from '@react-native-community/cli-platform-ios';
+import {findPodfilePaths} from '@react-native-community/cli-platform-apple';
 import {
   findProjectRoot,
   resolveNodeModuleDir,

packages/cli-doctor/tsconfig.json

@@ -10,5 +10,6 @@
     {"path": "../cli-config"},
     {"path": "../cli-platform-android"},
     {"path": "../cli-platform-ios"},
+    {"path": "../cli-platform-apple"},
   ]
 }

packages/cli-platform-apple/README.md

@@ -0,0 +1,42 @@
+# @react-native-community/cli-platform-apple
+
+This package is part of the [React Native CLI](../../README.md). It contains utilities for building reusable commands targetting Apple platforms.
+
+## Installation
+
+```sh
+yarn add @react-native-community/cli-platform-apple
+```
+
+## Usage
+
+This package is intended to be used internally in [React Native CLI](../../README.md) and by out of tree platforms.
+
+It exports builder commands that can be used to create custom `run-`, `log-` and `build-` commands for example: `yarn run-<oot-platform>`.
+
+Inside of `<oot-platform>/packages/react-native/react-native.config.js`:
+
+```js
+const {
+  buildOptions,
+  createBuild,
+} = require('@react-native-community/cli-platform-apple');
+
+const buildVisionOS = {
+  name: 'build-visionos',
+  description: 'builds your app for visionOS platform',
+  func: createBuild({platformName: 'visionos'}),
+  examples: [
+    {
+      desc: 'Build the app for visionOS in Release mode',
+      cmd: 'npx react-native build-visionos --mode "Release"',
+    },
+  ],
+  options: buildOptions,
+};
+
+module.exports = {
+  commands: [buildVisionOS], // <- Add command here
+  //..
+};
+```

packages/cli-platform-apple/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@react-native-community/cli-platform-apple",
+  "version": "13.1.0",
+  "license": "MIT",
+  "main": "build/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@react-native-community/cli-tools": "13.1.0",
+    "chalk": "^4.1.2",
+    "execa": "^5.0.0",
+    "fast-xml-parser": "^4.0.12",
+    "glob": "^7.1.3",
+    "ora": "^5.4.1"
+  },
+  "devDependencies": {
+    "@react-native-community/cli-types": "13.1.0",
+    "@types/glob": "^7.1.1",
+    "@types/lodash": "^4.14.149",
+    "hasbin": "^1.2.3"
+  },
+  "files": [
+    "build",
+    "!*.d.ts",
+    "!*.map"
+  ],
+  "homepage": "https://github.com/react-native-community/cli/tree/main/packages/cli-platform-apple",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/react-native-community/cli.git",
+    "directory": "packages/cli-platform-apple"
+  }
+}
+  

packages/cli-platform-ios/src/__tests__/pods.test.ts renamed to packages/cli-platform-apple/src/__tests__/pods.test.ts

@@ -1,6 +1,9 @@
 import {writeFiles, getTempDirectory, cleanup} from '../../../../jest/helpers';
 import installPods from '../tools/installPods';
-import resolvePods, {compareMd5Hashes, getIosDependencies} from '../tools/pods';
+import resolvePods, {
+  compareMd5Hashes,
+  getPlatformDependencies,
+} from '../tools/pods';
 
 const mockGet = jest.fn();
 const mockSet = jest.fn();
@@ -71,9 +74,9 @@ describe('compareMd5Hashes', () => {
   });
 });
 
-describe('getIosDependencies', () => {
+describe('getPlatformDependencies', () => {
   it('should return only dependencies with native code', () => {
-    const result = getIosDependencies(dependenciesConfig);
+    const result = getPlatformDependencies(dependenciesConfig);
     expect(result).toEqual(['[email protected]', '[email protected]']);
   });
 });
@@ -90,7 +93,7 @@ describe('resolvePods', () => {
   it('should install pods when force option is set to true', async () => {
     createTempFiles();
 
-    await resolvePods(DIR, {}, {forceInstall: true});
+    await resolvePods(DIR, {}, 'ios', {forceInstall: true});
 
     expect(installPods).toHaveBeenCalled();
   });