@react-native/core-cli-utils 0.75.0-nightly-20240427-e2ad6696d → 0.75.0-nightly-20240429-b7de91666

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@react-native/core-cli-utils",
-  "version": "0.75.0-nightly-20240427-e2ad6696d",
+  "version": "0.75.0-nightly-20240429-b7de91666",
   "description": "React Native CLI library for Frameworks to build on",
-  "main": "./src/index.js",
+  "main": "./src/index.flow.js",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -10,11 +10,11 @@
     "directory": "packages/core-cli-utils"
   },
   "exports": {
-    ".": "./dist/index.js",
+    ".": "./dist/index.flow.js",
     "./package.json": "./package.json",
     "./version.js": "./dist/public/version.js"
   },
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.flow.d.ts",
   "homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/core-cli-utils#readme",
   "keywords": [
     "cli-utils",
@@ -25,7 +25,7 @@
     "node": ">=18"
   },
   "files": [
-    "dist"
+    "src"
   ],
   "dependencies": {},
   "devDependencies": {}

package/src/index.flow.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+// @babel/register doesn't like export {foo} from './bar'; statements,
+// so we have to jump through hoops here.
+import {tasks as _android} from './private/android.js';
+import {tasks as _apple} from './private/apple.js';
+import {tasks as _clean} from './private/clean.js';
+import * as _version from './public/version.js';
+
+export const android = _android;
+export const apple = _apple;
+export const clean = _clean;
+export const version = _version;
+
+export type {Task} from './private/types';

package/src/monorepo.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall react_native
+ */
+
+// Should only used when called in the monorepo when we don't want to use the `yarn run build`
+// step to transpile to project. When used as a vanilla npm package, it should be built and
+// exported with `dist/index.flow.js` as main.
+//
+// The reason for this workaround is that flow-api-translator can't understand ESM and CJS style
+// exports in the same file.  Throw in a bit of Flow in the mix and it all goes to hell.
+//
+// See packages/helloworld/cli.js for an example of how to swap this out in the monorepo.
+if (process.env.BUILD_EXCLUDE_BABEL_REGISTER == null) {
+  require('../../../scripts/build/babel-register').registerForMonorepo();
+}
+
+module.exports = require('./index.flow.js');

package/src/private/android.js

@@ -0,0 +1,128 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+import type {Task} from './types';
+import type {ExecaPromise} from 'execa';
+
+import {isWindows, task, toPascalCase} from './utils';
+import execa from 'execa';
+
+type AndroidBuildMode = 'debug' | 'release';
+
+type AndroidBuild = {
+  sourceDir: string,
+  appName: string,
+  mode: AndroidBuildMode,
+  gradleArgs?: Array<string>,
+};
+
+function gradle(cwd: string, ...args: string[]): ExecaPromise {
+  const gradlew = isWindows ? 'gradlew.bat' : './gradlew';
+  return execa(gradlew, args, {
+    cwd,
+    stdio: 'inherit',
+  });
+}
+
+//
+// Gradle Task wrappers
+//
+
+/**
+ * Assembles an Android app using Gradle
+ */
+export const assemble = (
+  cwd: string,
+  appName: string,
+  mode: AndroidBuildMode,
+  ...args: $ReadOnlyArray<string>
+): ExecaPromise =>
+  gradle(cwd, `${appName}:assemble${toPascalCase(mode)}`, ...args);
+
+/**
+ * Assembles and tests an Android app using Gradle
+ */
+export const build = (
+  cwd: string,
+  appName: string,
+  mode: AndroidBuildMode,
+  ...args: $ReadOnlyArray<string>
+): ExecaPromise =>
+  gradle(cwd, `${appName}:build${toPascalCase(mode)}`, ...args);
+
+/**
+ * Installs an Android app using Gradle
+ */
+export const install = (
+  cwd: string,
+  appName: string,
+  mode: AndroidBuildMode,
+  ...args: $ReadOnlyArray<string>
+): ExecaPromise =>
+  gradle(cwd, `${appName}:install${toPascalCase(mode)}`, ...args);
+
+/**
+ * Runs a custom Gradle task if your frameworks needs aren't handled by assemble, build or install.
+ */
+export const customTask = (
+  cwd: string,
+  customTaskName: string,
+  ...args: $ReadOnlyArray<string>
+): ExecaPromise => gradle(cwd, customTaskName, ...args);
+
+const FIRST = 1;
+
+//
+// Android Tasks
+//
+type AndroidTasks = {
+  assemble: (
+    options: AndroidBuild,
+    ...args: $ReadOnlyArray<string>
+  ) => {run: Task<ExecaPromise>},
+  build: (
+    options: AndroidBuild,
+    ...args: $ReadOnlyArray<string>
+  ) => {run: Task<ExecaPromise>},
+  install: (
+    options: AndroidBuild,
+    ...args: $ReadOnlyArray<string>
+  ) => {run: Task<ExecaPromise>},
+};
+
+export const tasks: AndroidTasks = {
+  assemble: (options: AndroidBuild, ...gradleArgs: $ReadOnlyArray<string>) => ({
+    run: task(FIRST, 'Assemble Android App', () =>
+      assemble(options.sourceDir, options.appName, options.mode, ...gradleArgs),
+    ),
+  }),
+  build: (options: AndroidBuild, ...gradleArgs: $ReadOnlyArray<string>) => ({
+    run: task(FIRST, 'Assembles and tests Android App', () =>
+      build(options.sourceDir, options.appName, options.mode, ...gradleArgs),
+    ),
+  }),
+  /**
+   * Useful extra gradle arguments:
+   *
+   * -PreactNativeDevServerPort=8081 sets the port for the installed app to point towards a Metro
+   *                                 server on (for example) 8081.
+   */
+  install: (options: AndroidBuild, ...gradleArgs: $ReadOnlyArray<string>) => ({
+    run: task(FIRST, 'Installs the assembled Android App', () =>
+      install(options.sourceDir, options.appName, options.mode, ...gradleArgs),
+    ),
+  }),
+
+  // We are not supporting launching the app and setting up the tunnel for metro <-> app, this is
+  // a framework concern. For an example of how one could do this, please look at the community
+  // CLI's code:
+  // https://github.com/react-native-community/cli/blob/54d48a4e08a1aef334ae6168788e0157a666b4f5/packages/cli-platform-android/src/commands/runAndroid/index.ts#L272C1-L290C2
+};

package/src/private/apple.js

@@ -0,0 +1,153 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+import type {Task} from './types';
+import type {ExecaPromise} from 'execa';
+
+import {assertDependencies, isOnPath, task} from './utils';
+import execa from 'execa';
+import fs from 'fs';
+import path from 'path';
+
+type AppleBuildMode = 'Debug' | 'Release';
+
+type AppleBuildOptions = {
+  isWorkspace: boolean,
+  name: string,
+  mode: AppleBuildMode,
+  scheme?: string,
+  destination?: string, // Device or Simulator or UUID
+  ...AppleOptions,
+};
+
+type AppleBootstrapOption = {
+  // Enabled by default
+  newArchitecture: boolean,
+  ...AppleOptions,
+};
+
+type AppleInstallApp = {
+  // Install the app on a simulator or device, typically this is the description from
+  // `xcrun simctl list devices`
+  device: string,
+  appPath: string,
+  bundleId: string,
+  ...AppleOptions,
+};
+
+type AppleOptions = {
+  // The directory where the Xcode project is located
+  cwd: string,
+  // The environment variables to pass to the build command
+  env?: {[key: string]: string | void, ...},
+};
+
+const FIRST = 1,
+  SECOND = 2,
+  THIRD = 3;
+
+/* eslint sort-keys: "off" */
+export const tasks = {
+  // 1. Setup your environment for building the iOS apps
+  bootstrap: (
+    options: AppleBootstrapOption,
+  ): {
+    validate: Task<void>,
+    installRubyGems: Task<ExecaPromise>,
+    installDependencies: Task<ExecaPromise>,
+  } => ({
+    validate: task(FIRST, 'Check Cocoapods and bundle are available', () => {
+      assertDependencies(
+        isOnPath('pod', 'CocoaPods'),
+        isOnPath('bundle', "Bundler to manage Ruby's gems"),
+      );
+    }),
+    installRubyGems: task(SECOND, 'Install Ruby Gems', () =>
+      execa('bundle', ['install'], {
+        cwd: options.cwd,
+      }),
+    ),
+    installDependencies: task(THIRD, 'Install CocoaPods dependencies', () =>
+      execa('bundle', ['exec', 'pod', 'install'], {
+        cwd: options.cwd,
+        env: {RCT_NEW_ARCH_ENABLED: options.newArchitecture ? '1' : '0'},
+      }),
+    ),
+  }),
+
+  // 2. Build the iOS app using a setup environment
+  build: (
+    options: AppleBuildOptions,
+    ...args: $ReadOnlyArray<string>
+  ): {
+    validate: Task<void>,
+    hasPodsInstalled: Task<void>,
+    build: Task<ExecaPromise>,
+  } => ({
+    validate: task(
+      FIRST,
+      "Check you've run xcode-select --install for xcodebuild",
+      () => {
+        assertDependencies(isOnPath('xcodebuild', 'Xcode Commandline Tools'));
+      },
+    ),
+    hasPodsInstalled: task(FIRST, 'Check Pods are installed', () => {
+      for (const file of ['Podfile.lock', 'Pods']) {
+        try {
+          fs.accessSync(
+            path.join(options.cwd, file),
+            /* eslint-disable-next-line no-bitwise */
+            fs.constants.F_OK | fs.constants.R_OK,
+          );
+        } catch {
+          throw new Error('Please run: yarn run boostrap ios');
+        }
+      }
+    }),
+    build: task(SECOND, 'build an app artifact', () => {
+      const _args = [
+        options.isWorkspace ? '-workspace' : '-project',
+        options.name,
+      ];
+      if (options.scheme != null) {
+        _args.push('-scheme', options.scheme);
+      }
+      if (options.destination != null) {
+        _args.push('-destination', options.destination);
+      }
+      _args.push(...args);
+      return execa('xcodebuild', _args, {cwd: options.cwd, env: options.env});
+    }),
+  }),
+
+  // 3. Install the built app on a simulator or device
+  ios: {
+    install: (
+      options: AppleInstallApp,
+    ): {validate: Task<void>, install: Task<ExecaPromise>} => ({
+      validate: task(
+        FIRST,
+        "Check you've run xcode-select --install for xcrun",
+        () => {
+          assertDependencies(
+            isOnPath('xcrun', 'An Xcode Commandline tool: xcrun'),
+          );
+        },
+      ),
+      install: task(SECOND, 'Install the app on a simulator', () =>
+        execa('xcrun', ['simctl', 'install', options.device, options.appPath], {
+          cwd: options.cwd,
+          env: options.env,
+        }),
+      ),
+    }),
+  },
+};

package/src/private/clean.js

@@ -0,0 +1,203 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+import type {Task} from './types';
+import type {ExecaPromise, Options as ExecaOptions} from 'execa';
+
+import {assertDependencies, isMacOS, isOnPath, isWindows, task} from './utils';
+import execa from 'execa';
+import {existsSync, readdirSync, rm} from 'fs';
+import os from 'os';
+import path from 'path';
+
+const FIRST = 1,
+  SECOND = 2;
+
+const rmrf = (pathname: string) => {
+  if (!existsSync(pathname)) {
+    return;
+  }
+  rm(pathname, {force: true, maxRetries: 3, recursive: true});
+};
+
+/**
+ * Removes the contents of a directory matching a given pattern, but keeps the directory.
+ * @private
+ */
+export function deleteDirectoryContents(
+  directory: string,
+  filePattern: RegExp,
+): () => Promise<void> {
+  return async function deleteDirectoryContentsAction() {
+    const base = path.dirname(directory);
+    const files = readdirSync(base).filter((filename: string) =>
+      filePattern.test(filename),
+    );
+    for (const filename of files) {
+      rmrf(path.join(base, filename));
+    }
+  };
+}
+
+/**
+ * Removes a directory recursively.
+ * @private
+ */
+export function deleteDirectory(directory: string): () => Promise<void> {
+  return async function cleanDirectoryAction() {
+    rmrf(directory);
+  };
+}
+
+/**
+ * Deletes the contents of the tmp directory matching a given pattern.
+ * @private
+ */
+export function deleteTmpDirectoryContents(
+  filepattern: RegExp,
+): () => Promise<void> {
+  return deleteDirectoryContents(os.tmpdir(), filepattern);
+}
+
+const platformGradlew = isWindows ? 'gradlew.bat' : 'gradlew';
+
+type CocoaPodsClean = {
+  clean: Task<ExecaPromise>,
+};
+type AndroidClean = {
+  validate: Task<void>,
+  run: Task<ExecaPromise>,
+};
+type MetroClean = {
+  metro: Task<Promise<void>>,
+  haste: Task<Promise<void>>,
+  react_native: Task<Promise<void>>,
+};
+
+type NpmClean = {
+  node_modules: Task<Promise<void>>,
+  verify_cache: Task<ExecaPromise>,
+};
+
+type WatchmanClean = {
+  stop: Task<ExecaPromise>,
+  cache: Task<ExecaPromise>,
+};
+
+type YarnClean = {
+  clean: Task<ExecaPromise>,
+};
+
+type CleanTasks = {
+  android: (andoirdSrcDir: ?string, opts?: ExecaOptions) => AndroidClean,
+  cocoapods: CocoaPodsClean,
+  metro: () => MetroClean,
+  npm: (projectRootDir: string) => NpmClean,
+  watchman: (projectRootDir: string) => WatchmanClean,
+  yarn: (projectRootDir: string) => YarnClean,
+  cocoapods?: (projectRootDir: string) => CocoaPodsClean,
+};
+
+// The tasks that cleanup various build artefacts.
+/* eslint sort-keys: "off" */
+export const tasks: CleanTasks = {
+  /**
+   * Cleans up the Android Gradle cache
+   */
+  android: (androidSrcDir: ?string, opts?: ExecaOptions) => ({
+    validate: task(FIRST, 'Check gradlew is available', () => {
+      assertDependencies(isOnPath(platformGradlew, 'Gradle wrapper'));
+    }),
+    run: task(SECOND, '🧹 Clean Gradle cache', () => {
+      const gradlew = path.join(androidSrcDir ?? 'android', platformGradlew);
+      const script = path.basename(gradlew);
+      const cwd = path.dirname(gradlew);
+      return execa(isWindows ? script : './' + script, ['clean'], {
+        cwd,
+        ...opts,
+      });
+    }),
+  }),
+
+  /**
+   * Aggressively cleans up all Metro caches.
+   */
+  metro: () => ({
+    metro: task(
+      FIRST,
+      '🧹 Clean Metro cache',
+      deleteTmpDirectoryContents(/^metro-.+/),
+    ),
+    haste: task(
+      FIRST,
+      '🧹 Clean Haste cache',
+      deleteTmpDirectoryContents(/^haste-map-.+/),
+    ),
+    react_native: task(
+      FIRST,
+      '🧹 Clean React Native cache',
+      deleteTmpDirectoryContents(/^react-.+/),
+    ),
+  }),
+
+  /**
+   * Cleans up the `node_modules` folder and optionally garbage collects the npm cache.
+   */
+  npm: (projectRootDir: string) => ({
+    node_modules: task(
+      FIRST,
+      '🧹 Clean node_modules',
+      deleteDirectory(path.join(projectRootDir, 'node_modules')),
+    ),
+    verify_cache: task(SECOND, '🔬 Verify npm cache', (opts?: ExecaOptions) =>
+      execa('npm', ['cache', 'verify'], {cwd: projectRootDir, ...opts}),
+    ),
+  }),
+
+  /**
+   * Stops Watchman and clears its cache
+   */
+  watchman: (projectRootDir: string) => ({
+    stop: task(FIRST, '✋ Stop Watchman', (opts?: ExecaOptions) =>
+      execa(isWindows ? 'tskill' : 'killall', ['watchman'], {
+        cwd: projectRootDir,
+        ...opts,
+      }),
+    ),
+    cache: task(SECOND, '🧹 Delete Watchman cache', (opts?: ExecaOptions) =>
+      execa('watchman', ['watch-del-all'], {cwd: projectRootDir, ...opts}),
+    ),
+  }),
+
+  /**
+   * Cleans up the Yarn cache
+   */
+  yarn: (projectRootDir: string) => ({
+    clean: task(FIRST, '🧹 Clean Yarn cache', (opts?: ExecaOptions) =>
+      execa('yarn', ['cache', 'clean'], {cwd: projectRootDir, ...opts}),
+    ),
+  }),
+};
+
+if (isMacOS) {
+  /**
+   * Cleans up the local and global CocoaPods cache
+   */
+  tasks.cocoapods = (projectRootDir: string) => ({
+    // TODO: add project root
+    clean: task(FIRST, '🧹 Clean CocoaPods pod cache', (opts?: ExecaOptions) =>
+      execa('bundle', ['exec', 'pod', 'deintegrate'], {
+        cwd: projectRootDir,
+        ...opts,
+      }),
+    ),
+  });
+}

package/src/private/utils.js

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+import type {Task} from './types';
+
+import execa from 'execa';
+import os from 'os';
+
+export function task<R>(
+  order: number,
+  label: string,
+  action: Task<R>['action'],
+): Task<R> {
+  return {
+    action,
+    label,
+    order,
+  };
+}
+
+export const isWindows = os.platform() === 'win32';
+export const isMacOS = os.platform() === 'darwin';
+
+export const toPascalCase = (label: string): string =>
+  label.length === 0 ? '' : label[0].toUpperCase() + label.slice(1);
+
+type PathCheckResult = {
+  found: boolean,
+  dep: string,
+  description: string,
+};
+
+export function isOnPath(dep: string, description: string): PathCheckResult {
+  const cmd = isWindows ? ['where', [dep]] : ['command', ['-v', dep]];
+  try {
+    const args = isWindows ? ['where', [dep]] : ['command', ['-v', dep]];
+    return {
+      dep,
+      description,
+      found: execa.sync(...cmd).exitCode === 0,
+    };
+  } catch {
+    return {
+      dep,
+      description,
+      found: false,
+    };
+  }
+}
+
+export function assertDependencies(
+  ...deps: $ReadOnlyArray<ReturnType<typeof isOnPath>>
+) {
+  for (const {found, dep, description} of deps) {
+    if (!found) {
+      throw new Error(`"${dep}" not found, ${description}`);
+    }
+  }
+}

package/{dist/public/version.js.flow → src/public/version.js}

@@ -27,20 +27,27 @@
 //
 // For react-native@0.75.0 you have to have a version of XCode >= 12
 
-declare export const android: {
-  ANDROID_NDK: ">= 23.x",
-  ANDROID_SDK: ">= 33.x",
+export const android = {
+  ANDROID_NDK: '>= 23.x',
+  ANDROID_SDK: '>= 33.x',
 };
 
-declare export const apple: { COCOAPODS: ">= 1.10.0", XCODE: ">= 12.x" };
+export const apple = {
+  COCOAPODS: '>= 1.10.0',
+  XCODE: '>= 12.x',
+};
 
-declare export const common: {
-  BUN: ">= 1.0.0",
-  JAVA: ">= 17 <= 20",
-  NODE_JS: ">= 18",
-  NPM: ">= 4.x",
-  RUBY: ">= 2.6.10",
-  YARN: ">= 1.10.x",
+export const common = {
+  BUN: '>= 1.0.0',
+  JAVA: '>= 17 <= 20',
+  NODE_JS: '>= 18',
+  NPM: '>= 4.x',
+  RUBY: '>= 2.6.10',
+  YARN: '>= 1.10.x',
 };
 
-declare export const all: { ...apple, ...android, ...common };
+export const all = {
+  ...apple,
+  ...android,
+  ...common,
+};

package/dist/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *
- * @format
- * @oncall react_native
- */
-
-export * from "./index.flow.js";