@nx/react-native 0.0.0-pr-22179-271588f

package/src/executors/build-ios/build-ios.impl.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const os_1 = require("os");
+const get_cli_options_1 = require("../../utils/get-cli-options");
+async function* buildIosExecutor(options, context) {
+    if ((0, os_1.platform)() !== 'darwin') {
+        throw new Error(`The run-ios build requires Mac to run`);
+    }
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    await runCliBuildIOS(context.root, projectRoot, options);
+    return { success: true };
+}
+exports.default = buildIosExecutor;
+function runCliBuildIOS(workspaceRoot, projectRoot, options) {
+    return new Promise((resolve, reject) => {
+        const childProcess = (0, child_process_1.fork)(require.resolve('react-native/cli.js'), [
+            'build-ios',
+            ...createBuildIOSOptions(options),
+            ...(process.env.NX_VERBOSE_LOGGING === 'true' ? ['--verbose'] : []),
+        ], {
+            cwd: (0, path_1.resolve)(workspaceRoot, projectRoot),
+            env: { ...process.env, RCT_METRO_PORT: options.port.toString() },
+        });
+        /**
+         * Ensure the child process is killed when the parent exits
+         */
+        const processExitListener = (signal) => () => {
+            childProcess.kill(signal);
+            process.exit();
+        };
+        process.once('exit', (signal) => childProcess.kill(signal));
+        process.once('SIGTERM', processExitListener);
+        process.once('SIGINT', processExitListener);
+        process.once('SIGQUIT', processExitListener);
+        childProcess.on('error', (err) => {
+            reject(err);
+        });
+        childProcess.on('exit', (code) => {
+            if (code === 0) {
+                resolve(childProcess);
+            }
+            else {
+                reject(code);
+            }
+        });
+    });
+}
+const startOptions = ['port', 'resetCache'];
+function createBuildIOSOptions(options) {
+    return (0, get_cli_options_1.getCliOptions)(options, startOptions, [
+        'buildFolder',
+    ]);
+}

package/src/executors/build-ios/build-ios.impl.ts

@@ -0,0 +1,77 @@
+import { ExecutorContext } from '@nx/devkit';
+import { resolve as pathResolve } from 'path';
+import { ChildProcess, fork } from 'child_process';
+import { platform } from 'os';
+
+import { ReactNativeBuildIosOptions } from './schema';
+import { getCliOptions } from '../../utils/get-cli-options';
+
+export interface ReactNativeBuildIosOutput {
+  success: boolean;
+}
+
+export default async function* buildIosExecutor(
+  options: ReactNativeBuildIosOptions,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativeBuildIosOutput> {
+  if (platform() !== 'darwin') {
+    throw new Error(`The run-ios build requires Mac to run`);
+  }
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+
+  await runCliBuildIOS(context.root, projectRoot, options);
+  return { success: true };
+}
+
+function runCliBuildIOS(
+  workspaceRoot: string,
+  projectRoot: string,
+  options: ReactNativeBuildIosOptions
+): Promise<ChildProcess> {
+  return new Promise<ChildProcess>((resolve, reject) => {
+    const childProcess = fork(
+      require.resolve('react-native/cli.js'),
+      [
+        'build-ios',
+        ...createBuildIOSOptions(options),
+        ...(process.env.NX_VERBOSE_LOGGING === 'true' ? ['--verbose'] : []),
+      ],
+      {
+        cwd: pathResolve(workspaceRoot, projectRoot),
+        env: { ...process.env, RCT_METRO_PORT: options.port.toString() },
+      }
+    );
+
+    /**
+     * Ensure the child process is killed when the parent exits
+     */
+    const processExitListener = (signal?: number | NodeJS.Signals) => () => {
+      childProcess.kill(signal);
+      process.exit();
+    };
+    process.once('exit', (signal) => childProcess.kill(signal));
+    process.once('SIGTERM', processExitListener);
+    process.once('SIGINT', processExitListener);
+    process.once('SIGQUIT', processExitListener);
+
+    childProcess.on('error', (err) => {
+      reject(err);
+    });
+    childProcess.on('exit', (code) => {
+      if (code === 0) {
+        resolve(childProcess);
+      } else {
+        reject(code);
+      }
+    });
+  });
+}
+
+const startOptions = ['port', 'resetCache'];
+
+function createBuildIOSOptions(options: ReactNativeBuildIosOptions) {
+  return getCliOptions<ReactNativeBuildIosOptions>(options, startOptions, [
+    'buildFolder',
+  ]);
+}

package/src/executors/build-ios/schema.d.ts

@@ -0,0 +1,17 @@
+// options from https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios/src/commands/buildIOS/index.ts
+
+import { ReactNativeStartOptions } from '../start/schema';
+
+export interface ReactNativeBuildIosOptions extends ReactNativeStartOptions {
+  // react native options
+  simulator?: string;
+  mode: string; // default if 'Debug'
+  scheme?: string;
+  device?: string;
+  udid?: string;
+  verbose?: boolean;
+  port: number; // default is 8081
+  xcconfig?: string;
+  buildFolder?: string;
+  extraParams?: string;
+}

package/src/executors/build-ios/schema.json

@@ -0,0 +1,91 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "version": 2,
+  "cli": "nx",
+  "title": "React Native Build iOS executor",
+  "description": "Build iOS app.",
+  "type": "object",
+  "presets": [
+    {
+      "name": "Build iOS for a simulator",
+      "keys": ["simulator"]
+    },
+    {
+      "name": "Build iOS for a device",
+      "keys": ["device"]
+    },
+    {
+      "name": "Build iOS for a device with udid",
+      "keys": ["udid"]
+    }
+  ],
+  "properties": {
+    "simulator": {
+      "type": "string",
+      "description": "Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: \"iPhone 6 (10.0)\"",
+      "examples": [
+        "iPhone 14",
+        "iPhone 13",
+        "iPhone 12",
+        "iPhone 11",
+        "iPhone X"
+      ],
+      "x-priority": "important"
+    },
+    "mode": {
+      "type": "string",
+      "description": "Explicitly set the scheme configuration to use",
+      "default": "Debug",
+      "examples": ["Debug", "Release"],
+      "x-priority": "important"
+    },
+    "scheme": {
+      "type": "string",
+      "description": "Explicitly set Xcode scheme to use"
+    },
+    "device": {
+      "type": "string",
+      "description": "Explicitly set device to use by name. The value is not required if you have a single device connected."
+    },
+    "udid": {
+      "type": "string",
+      "description": "Explicitly set device to use by udid"
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Do not use xcbeautify or xcpretty even if installed"
+    },
+    "port": {
+      "type": "number",
+      "description": "The port where the packager server is listening on.",
+      "default": 8081
+    },
+    "xcconfig": {
+      "type": "string",
+      "description": "Explicitly set xcconfig to use"
+    },
+    "buildFolder": {
+      "type": "string",
+      "description": "Location for iOS build artifacts. Corresponds to Xcode's \"-derivedDataPath\". Relative to ios directory",
+      "default": "./build"
+    },
+    "interactive": {
+      "type": "boolean",
+      "description": "Explicitly select which scheme and configuration to use before running a build"
+    },
+    "extraParams": {
+      "oneOf": [
+        { "type": "array", "items": { "type": "string" } },
+        { "type": "string" }
+      ],
+      "description": "Custom params that will be passed to xcodebuild command."
+    },
+    "resetCache": {
+      "type": "boolean",
+      "description": "Resets metro cache.",
+      "default": false
+    }
+  },
+  "required": [],
+  "examplesFile": "../../../docs/build-ios-examples.md"
+}

package/src/executors/bundle/bundle.impl.d.ts

@@ -0,0 +1,6 @@
+import { ExecutorContext } from '@nx/devkit';
+import { ReactNativeBundleOptions } from './schema';
+export interface ReactNativeBundleOutput {
+    success: boolean;
+}
+export default function bundleExecutor(options: ReactNativeBundleOptions, context: ExecutorContext): AsyncGenerator<ReactNativeBundleOutput>;

package/src/executors/bundle/bundle.impl.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fileutils_1 = require("@nx/workspace/src/utilities/fileutils");
+const devkit_1 = require("@nx/devkit");
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+async function* bundleExecutor(options, context) {
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    options.bundleOutput = (0, path_1.join)(context.root, options.bundleOutput);
+    (0, fileutils_1.createDirectory)((0, path_1.dirname)(options.bundleOutput));
+    await runCliBuild(context.root, projectRoot, options);
+    yield { success: true };
+}
+exports.default = bundleExecutor;
+function runCliBuild(workspaceRoot, projectRoot, options) {
+    return new Promise((resolve, reject) => {
+        const cliOptions = createBundleOptions(options);
+        const childProcess = (0, child_process_1.fork)(require.resolve('react-native/cli.js'), ['bundle', ...cliOptions], {
+            stdio: 'inherit',
+            cwd: (0, path_1.resolve)(workspaceRoot, projectRoot),
+            env: process.env,
+        });
+        /**
+         * Ensure the child process is killed when the parent exits
+         */
+        const processExitListener = (signal) => () => {
+            childProcess.kill(signal);
+            process.exit();
+        };
+        process.once('exit', (signal) => childProcess.kill(signal));
+        process.once('SIGTERM', processExitListener);
+        process.once('SIGINT', processExitListener);
+        process.once('SIGQUIT', processExitListener);
+        childProcess.on('error', (err) => {
+            reject(err);
+        });
+        childProcess.on('exit', (code) => {
+            if (code === 0) {
+                resolve(childProcess);
+            }
+            else {
+                reject(code);
+            }
+        });
+    });
+}
+function createBundleOptions(options) {
+    return Object.keys(options).reduce((acc, _k) => {
+        const v = options[_k];
+        const k = (0, devkit_1.names)(_k).fileName;
+        if (v === undefined)
+            return acc;
+        acc.push(`--${k}`, v);
+        return acc;
+    }, []);
+}

package/src/executors/bundle/bundle.impl.ts

@@ -0,0 +1,77 @@
+import { createDirectory } from '@nx/workspace/src/utilities/fileutils';
+import { names, ExecutorContext } from '@nx/devkit';
+import { dirname, join, resolve as pathResolve } from 'path';
+import { ChildProcess, fork } from 'child_process';
+
+import { ReactNativeBundleOptions } from './schema';
+
+export interface ReactNativeBundleOutput {
+  success: boolean;
+}
+
+export default async function* bundleExecutor(
+  options: ReactNativeBundleOptions,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativeBundleOutput> {
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+
+  options.bundleOutput = join(context.root, options.bundleOutput);
+
+  createDirectory(dirname(options.bundleOutput));
+
+  await runCliBuild(context.root, projectRoot, options);
+  yield { success: true };
+}
+
+function runCliBuild(
+  workspaceRoot: string,
+  projectRoot: string,
+  options: ReactNativeBundleOptions
+): Promise<ChildProcess> {
+  return new Promise<ChildProcess>((resolve, reject) => {
+    const cliOptions = createBundleOptions(options);
+    const childProcess = fork(
+      require.resolve('react-native/cli.js'),
+      ['bundle', ...cliOptions],
+      {
+        stdio: 'inherit',
+        cwd: pathResolve(workspaceRoot, projectRoot),
+        env: process.env,
+      }
+    );
+
+    /**
+     * Ensure the child process is killed when the parent exits
+     */
+    const processExitListener = (signal?: number | NodeJS.Signals) => () => {
+      childProcess.kill(signal);
+      process.exit();
+    };
+    process.once('exit', (signal) => childProcess.kill(signal));
+    process.once('SIGTERM', processExitListener);
+    process.once('SIGINT', processExitListener);
+    process.once('SIGQUIT', processExitListener);
+
+    childProcess.on('error', (err) => {
+      reject(err);
+    });
+    childProcess.on('exit', (code) => {
+      if (code === 0) {
+        resolve(childProcess);
+      } else {
+        reject(code);
+      }
+    });
+  });
+}
+
+function createBundleOptions(options: ReactNativeBundleOptions) {
+  return Object.keys(options).reduce((acc, _k) => {
+    const v = options[_k];
+    const k = names(_k).fileName;
+    if (v === undefined) return acc;
+    acc.push(`--${k}`, v);
+    return acc;
+  }, []);
+}

package/src/executors/bundle/schema.d.ts

@@ -0,0 +1,16 @@
+// options form https://github.com/facebook/react-native/tree/main/packages/community-cli-plugin#bundle
+export interface ReactNativeBundleOptions {
+  entryFile: string;
+  platform: string;
+  transfrom?: string;
+  dev: boolean; // default is true
+  minify?: boolean; // default is false, if dev is false, then minify will become true
+  bundleOutput: string;
+  maxWorkers: number;
+  sourcemapOutput?: string;
+  sourcemapSourcesRoot?: string;
+  sourcemapUseAbsolutePath: boolean; // default is false
+  assetDest?: string;
+  resetCache: boolean; // default is false
+  readGlobalCache?: boolean; // default is false
+}

package/src/executors/bundle/schema.json

@@ -0,0 +1,92 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativeBundle",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Offline JS Bundle for React Native",
+  "description": "JS Bundle target options.",
+  "type": "object",
+  "presets": [
+    {
+      "name": "Bundle for a specific platform",
+      "keys": ["platform"]
+    },
+    {
+      "name": "Bundle a development build",
+      "keys": ["dev"]
+    },
+    {
+      "name": "Bundle to a specific output path",
+      "keys": ["bundleOutput"]
+    },
+    {
+      "name": "Bundle without global cache",
+      "keys": ["resetCache"]
+    }
+  ],
+  "properties": {
+    "entryFile": {
+      "type": "string",
+      "description": "The entry file relative to project root.",
+      "x-completion-type": "file",
+      "x-completion-glob": "main@(.js|.ts)"
+    },
+    "platform": {
+      "enum": ["ios", "android"],
+      "alias": "p",
+      "description": "Platform to build for."
+    },
+    "transformer": {
+      "type": "string",
+      "description": "Specify a custom transformer to be used."
+    },
+    "dev": {
+      "type": "boolean",
+      "description": "Generate a development build.",
+      "default": true
+    },
+    "minify": {
+      "type": "boolean",
+      "description": "Allows overriding whether bundle is minified."
+    },
+    "bundleOutput": {
+      "type": "string",
+      "description": "The output path of the generated files.",
+      "x-completion-type": "directory"
+    },
+    "maxWorkers": {
+      "type": "number",
+      "description": "The number of workers we should parallelize the transformer on."
+    },
+    "sourcemapOutput": {
+      "type": "string",
+      "description": "File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map."
+    },
+    "sourcemapSourcesRoot": {
+      "type": "string",
+      "description": "Path to make sourcemaps sources entries relative to, ex. /root/dir."
+    },
+    "sourcemapUseAbsolutePath": {
+      "type": "boolean",
+      "description": "Report SourceMapURL using its full path.",
+      "default": false
+    },
+    "assetsDest": {
+      "type": "string",
+      "description": "Directory name where to store assets referenced in the bundle."
+    },
+    "resetCache": {
+      "type": "boolean",
+      "description": "Removes cached files.",
+      "default": false
+    },
+    "readGlobalCache": {
+      "type": "boolean",
+      "description": "Try to fetch transformed JS code from the global cache, if configured.",
+      "default": false
+    }
+  },
+  "required": ["platform", "entryFile", "bundleOutput"],
+  "examplesFile": "../../../docs/bundle-examples.md"
+}

package/src/executors/ensure-symlink/ensure-symlink.impl.d.ts

@@ -0,0 +1,9 @@
+import { ExecutorContext } from '@nx/devkit';
+export interface ReactNativeEnsureSymlinkOutput {
+    success: boolean;
+}
+/**
+ * TODO (@xiongemi): remove this function in v19.
+ * @deprecated It is no longer needed for react native 73.
+ */
+export default function ensureSymlinkExecutor(_: any, context: ExecutorContext): AsyncGenerator<ReactNativeEnsureSymlinkOutput>;

package/src/executors/ensure-symlink/ensure-symlink.impl.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ensure_node_modules_symlink_1 = require("../../utils/ensure-node-modules-symlink");
+/**
+ * TODO (@xiongemi): remove this function in v19.
+ * @deprecated It is no longer needed for react native 73.
+ */
+async function* ensureSymlinkExecutor(_, context) {
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    (0, ensure_node_modules_symlink_1.ensureNodeModulesSymlink)(context.root, projectRoot);
+    yield { success: true };
+}
+exports.default = ensureSymlinkExecutor;

package/src/executors/ensure-symlink/ensure-symlink.impl.ts

@@ -0,0 +1,22 @@
+import { ExecutorContext } from '@nx/devkit';
+import { ensureNodeModulesSymlink } from '../../utils/ensure-node-modules-symlink';
+
+export interface ReactNativeEnsureSymlinkOutput {
+  success: boolean;
+}
+
+/**
+ * TODO (@xiongemi): remove this function in v19.
+ * @deprecated It is no longer needed for react native 73.
+ */
+export default async function* ensureSymlinkExecutor(
+  _,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativeEnsureSymlinkOutput> {
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+
+  ensureNodeModulesSymlink(context.root, projectRoot);
+
+  yield { success: true };
+}

package/src/executors/ensure-symlink/schema.json

@@ -0,0 +1,11 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativeEnsureSymlink",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Ensure Symlink for React Native",
+  "description": "Ensure workspace node_modules is symlink under app's node_modules folder.",
+  "type": "object",
+  "properties": {}
+}

package/src/executors/pod-install/pod-install.impl.d.ts

@@ -0,0 +1,6 @@
+import { ExecutorContext } from '@nx/devkit';
+import { ReactNativePodInstallOptions } from './schema';
+export interface ReactNativePodInstallOutput {
+    success: boolean;
+}
+export default function podInstall(options: ReactNativePodInstallOptions, context: ExecutorContext): AsyncGenerator<ReactNativePodInstallOutput>;

package/src/executors/pod-install/pod-install.impl.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const pod_install_task_1 = require("../../utils/pod-install-task");
+async function* podInstall(options, context) {
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    const iosDirectory = (0, path_1.join)(context.root, projectRoot, 'ios');
+    await (0, pod_install_task_1.runPodInstall)(iosDirectory, true, options)();
+    yield { success: true };
+}
+exports.default = podInstall;

package/src/executors/pod-install/pod-install.impl.ts

@@ -0,0 +1,21 @@
+import { join } from 'path';
+import { ExecutorContext } from '@nx/devkit';
+
+import { runPodInstall } from '../../utils/pod-install-task';
+import { ReactNativePodInstallOptions } from './schema';
+
+export interface ReactNativePodInstallOutput {
+  success: boolean;
+}
+
+export default async function* podInstall(
+  options: ReactNativePodInstallOptions,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativePodInstallOutput> {
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+  const iosDirectory = join(context.root, projectRoot, 'ios');
+  await runPodInstall(iosDirectory, true, options)();
+
+  yield { success: true };
+}

package/src/executors/pod-install/schema.d.ts

@@ -0,0 +1,6 @@
+export interface ReactNativePodInstallOptions {
+  buildFolder: string; // default is './build'
+  repoUpdate: boolean; // default is false
+  deployment: boolean; // default is false
+  useBundler: boolean; // default is false
+}

package/src/executors/pod-install/schema.json

@@ -0,0 +1,33 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativePodInstall",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Run Pod Install for React Native iOS Project",
+  "description": "Run `pod install` for React Native iOS Project.",
+  "type": "object",
+  "properties": {
+    "buildFolder": {
+      "description": "Location for iOS build artifacts. Corresponds to Xcode's \"-derivedDataPath\". Relative to ios directory.",
+      "type": "string",
+      "default": "./build"
+    },
+    "repoUpdate": {
+      "description": "Force running `pod repo update` before install.",
+      "type": "boolean",
+      "default": false
+    },
+    "deployment": {
+      "description": "Disallow any changes to the Podfile or the Podfile.lock during installation.",
+      "type": "boolean",
+      "default": false
+    },
+    "useBundler": {
+      "description": "Run cocoapods within a Bundler environment, i.e. with the `bundle exec pod install` command",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": ["buildFolder"]
+}

package/src/executors/run-android/run-android.impl.d.ts

@@ -0,0 +1,6 @@
+import { ExecutorContext } from '@nx/devkit';
+import { ReactNativeRunAndroidOptions } from './schema';
+export interface ReactNativeRunAndroidOutput {
+    success: boolean;
+}
+export default function runAndroidExecutor(options: ReactNativeRunAndroidOptions, context: ExecutorContext): AsyncGenerator<ReactNativeRunAndroidOutput>;