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

package/src/executors/run-android/run-android.impl.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const start_impl_1 = require("../start/start.impl");
+const chmod_android_gradle_files_1 = require("../../utils/chmod-android-gradle-files");
+const get_cli_options_1 = require("../../utils/get-cli-options");
+let childProcess;
+async function* runAndroidExecutor(options, context) {
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    (0, chmod_android_gradle_files_1.chmodAndroidGradlewFiles)((0, path_1.join)(context.root, projectRoot, 'android'));
+    const tasks = [runCliRunAndroid(context.root, projectRoot, options)];
+    if (options.mode !== 'Release') {
+        tasks.push((0, start_impl_1.runCliStart)(context.root, projectRoot, {
+            port: options.port,
+            resetCache: options.resetCache,
+            interactive: true,
+        }));
+    }
+    await Promise.all(tasks);
+    yield { success: true };
+}
+exports.default = runAndroidExecutor;
+function runCliRunAndroid(workspaceRoot, projectRoot, options) {
+    return new Promise((resolve, reject) => {
+        /**
+         * Call the react native cli with option `--no-packager`
+         * Not passing '--packager' due to cli will launch start command from the project root
+         */
+        childProcess = (0, child_process_1.fork)(require.resolve('react-native/cli.js'), ['run-android', ...createRunAndroidOptions(options), '--no-packager'], {
+            stdio: 'inherit',
+            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 createRunAndroidOptions(options) {
+    return (0, get_cli_options_1.getCliOptions)(options, startOptions, [
+        'appId',
+        'appIdSuffix',
+        'deviceId',
+    ]);
+}

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

@@ -0,0 +1,94 @@
+import { ExecutorContext } from '@nx/devkit';
+import { join, resolve as pathResolve } from 'path';
+import { ChildProcess, fork } from 'child_process';
+
+import { ReactNativeRunAndroidOptions } from './schema';
+import { runCliStart } from '../start/start.impl';
+import { chmodAndroidGradlewFiles } from '../../utils/chmod-android-gradle-files';
+import { getCliOptions } from '../../utils/get-cli-options';
+
+export interface ReactNativeRunAndroidOutput {
+  success: boolean;
+}
+
+let childProcess: ChildProcess;
+
+export default async function* runAndroidExecutor(
+  options: ReactNativeRunAndroidOptions,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativeRunAndroidOutput> {
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+  chmodAndroidGradlewFiles(join(context.root, projectRoot, 'android'));
+
+  const tasks = [runCliRunAndroid(context.root, projectRoot, options)];
+
+  if (options.mode !== 'Release') {
+    tasks.push(
+      runCliStart(context.root, projectRoot, {
+        port: options.port,
+        resetCache: options.resetCache,
+        interactive: true,
+      })
+    );
+  }
+
+  await Promise.all(tasks);
+
+  yield { success: true };
+}
+
+function runCliRunAndroid(
+  workspaceRoot: string,
+  projectRoot: string,
+  options: ReactNativeRunAndroidOptions
+): Promise<ChildProcess> {
+  return new Promise<ChildProcess>((resolve, reject) => {
+    /**
+     * Call the react native cli with option `--no-packager`
+     * Not passing '--packager' due to cli will launch start command from the project root
+     */
+    childProcess = fork(
+      require.resolve('react-native/cli.js'),
+      ['run-android', ...createRunAndroidOptions(options), '--no-packager'],
+      {
+        stdio: 'inherit',
+        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 createRunAndroidOptions(options: ReactNativeRunAndroidOptions) {
+  return getCliOptions<ReactNativeRunAndroidOptions>(options, startOptions, [
+    'appId',
+    'appIdSuffix',
+    'deviceId',
+  ]);
+}

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

@@ -0,0 +1,13 @@
+import { ReactNativeBuildAndroidOptions } from '../build-android/schema';
+import { ReactNativeStartOptions } from '../start/schema';
+
+// part of options from https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android/src/commands/runAndroid/index.ts
+export interface ReactNativeRunAndroidOptions
+  extends ReactNativeBuildAndroidOptions {
+  appId: string;
+  appIdSuffix: string;
+  mainActiviy: string;
+  deviceId: string;
+  listDevices?: boolean;
+  binaryPath?: string;
+}

package/src/executors/run-android/schema.json

@@ -0,0 +1,100 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativeRunAndroid",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Run Android application",
+  "description": "Run Android target options.",
+  "type": "object",
+  "presets": [
+    {
+      "name": "Run Android for the current device architecture",
+      "keys": ["activeArchOnly"]
+    },
+    {
+      "name": "Lists all available Android devices and simulators",
+      "keys": ["listDevices"]
+    },
+    {
+      "name": "Run Android without metro cache",
+      "keys": ["resetCache"]
+    }
+  ],
+  "properties": {
+    "appId": {
+      "type": "string",
+      "description": "Specify an `applicationId` to launch after build. If not specified, `package` from `AndroidManifest.xml` will be used."
+    },
+    "appIdSuffix": {
+      "type": "string",
+      "description": "Specify an `applicationIdSuffix` to launch after build."
+    },
+    "mainActivity": {
+      "type": "string",
+      "description": "Name of the activity to start.",
+      "default": "MainActivity"
+    },
+    "deviceId": {
+      "type": "string",
+      "description": "Builds your app and starts it on a specific device/simulator with the given device id (listed by running `adb devices` on the command line)."
+    },
+    "listDevices": {
+      "type": "boolean",
+      "description": "Lists all available Android devices and simulators and let you choose one to run the app"
+    },
+    "binaryPath": {
+      "type": "string",
+      "description": "Path relative to project root where pre-built .apk binary lives."
+    },
+    "mode": {
+      "type": "string",
+      "description": "Specify your app's build variant",
+      "default": "debug",
+      "examples": ["debug", "release"],
+      "x-priority": "important"
+    },
+    "port": {
+      "type": "number",
+      "description": "The port where the packager server is listening on.",
+      "default": 8081
+    },
+    "tasks": {
+      "oneOf": [
+        { "type": "array", "items": { "type": "string" } },
+        { "type": "string" }
+      ],
+      "description": "Run custom Gradle tasks. By default it's \"assembleDebug\". Will override passed mode and variant arguments.",
+      "examples": [
+        "assembleDebug",
+        "assembleRelease",
+        "bundleDebug",
+        "bundleRelease",
+        "installDebug",
+        "installRelease"
+      ]
+    },
+    "activeArchOnly": {
+      "type": "boolean",
+      "description": "Build native libraries only for the current device architecture for debug builds.",
+      "default": false
+    },
+    "extraParams": {
+      "oneOf": [
+        { "type": "array", "items": { "type": "string" } },
+        { "type": "string" }
+      ],
+      "description": "Custom params passed to gradle build command"
+    },
+    "interactive": {
+      "type": "boolean",
+      "description": "Explicitly select build type and flavour to use before running a build"
+    },
+    "resetCache": {
+      "type": "boolean",
+      "description": "Resets metro cache.",
+      "default": false
+    }
+  },
+  "examplesFile": "../../../docs/run-android-examples.md"
+}

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

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

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

@@ -0,0 +1,65 @@
+"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 start_impl_1 = require("../start/start.impl");
+const get_cli_options_1 = require("../../utils/get-cli-options");
+async function* runIosExecutor(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;
+    const tasks = [runCliRunIOS(context.root, projectRoot, options)];
+    if (options.mode !== 'Release') {
+        tasks.push((0, start_impl_1.runCliStart)(context.root, projectRoot, {
+            port: options.port,
+            resetCache: options.resetCache,
+            interactive: true,
+        }));
+    }
+    await Promise.all(tasks);
+    yield { success: true };
+}
+exports.default = runIosExecutor;
+function runCliRunIOS(workspaceRoot, projectRoot, options) {
+    return new Promise((resolve, reject) => {
+        /**
+         * Call the react native cli with option `--no-packager`
+         * Not passing '--packager' due to cli will launch start command from the project root
+         */
+        const childProcess = (0, child_process_1.fork)(require.resolve('react-native/cli.js'), ['run-ios', ...createRunIOSOptions(options), '--no-packager'], {
+            stdio: 'inherit',
+            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 createRunIOSOptions(options) {
+    return (0, get_cli_options_1.getCliOptions)(options, startOptions, [
+        'buildFolder',
+    ]);
+}

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

@@ -0,0 +1,92 @@
+import { ExecutorContext, GeneratorCallback, workspaceRoot } from '@nx/devkit';
+import { resolve as pathResolve } from 'path';
+import { ChildProcess, fork } from 'child_process';
+import { platform } from 'os';
+
+import { runCliStart } from '../start/start.impl';
+import { getCliOptions } from '../../utils/get-cli-options';
+
+import { ReactNativeRunIosOptions } from './schema';
+export interface ReactNativeRunIosOutput {
+  success: boolean;
+}
+
+export default async function* runIosExecutor(
+  options: ReactNativeRunIosOptions,
+  context: ExecutorContext
+): AsyncGenerator<ReactNativeRunIosOutput> {
+  if (platform() !== 'darwin') {
+    throw new Error(`The run-ios build requires Mac to run`);
+  }
+  const projectRoot =
+    context.projectsConfigurations.projects[context.projectName].root;
+
+  const tasks = [runCliRunIOS(context.root, projectRoot, options)];
+
+  if (options.mode !== 'Release') {
+    tasks.push(
+      runCliStart(context.root, projectRoot, {
+        port: options.port,
+        resetCache: options.resetCache,
+        interactive: true,
+      })
+    );
+  }
+
+  await Promise.all(tasks);
+
+  yield { success: true };
+}
+
+function runCliRunIOS(
+  workspaceRoot: string,
+  projectRoot: string,
+  options: ReactNativeRunIosOptions
+): Promise<ChildProcess> {
+  return new Promise<ChildProcess>((resolve, reject) => {
+    /**
+     * Call the react native cli with option `--no-packager`
+     * Not passing '--packager' due to cli will launch start command from the project root
+     */
+    const childProcess = fork(
+      require.resolve('react-native/cli.js'),
+      ['run-ios', ...createRunIOSOptions(options), '--no-packager'],
+      {
+        stdio: 'inherit',
+        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 createRunIOSOptions(options: ReactNativeRunIosOptions) {
+  return getCliOptions<ReactNativeRunIosOptions>(options, startOptions, [
+    'buildFolder',
+  ]);
+}

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

@@ -0,0 +1,7 @@
+import { ReactNativeBuildIosOptions } from '../build-ios/schema';
+import { ReactNativeStartOptions } from '../start/schema';
+
+// part of options form https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios/src/commands/runIOS/index.ts
+export interface ReactNativeRunIosOptions extends ReactNativeBuildIosOptions {
+  binaryPath?: string;
+}

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

@@ -0,0 +1,96 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativeRunIos",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Run iOS application",
+  "description": "Run iOS target options.",
+  "type": "object",
+  "presets": [
+    {
+      "name": "Run iOS on a simulator",
+      "keys": ["simulator"]
+    },
+    {
+      "name": "Run iOS on a device",
+      "keys": ["device"]
+    },
+    {
+      "name": "Run iOS on 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.",
+      "buildFolder": "./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
+    },
+    "binaryPath": {
+      "type": "string",
+      "description": "Path relative to project root where pre-built .app binary lives."
+    }
+  },
+  "examplesFile": "../../../docs/run-ios-examples.md"
+}

package/src/executors/start/lib/is-packager-running.d.ts

@@ -0,0 +1 @@
+export declare function isPackagerRunning(packagerPort: number): Promise<'running' | 'not_running' | 'unrecognized'>;

package/src/executors/start/lib/is-packager-running.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackagerRunning = void 0;
+const node_fetch_1 = require("node-fetch");
+async function isPackagerRunning(packagerPort) {
+    try {
+        const resp = await (0, node_fetch_1.default)(`http://localhost:${packagerPort}/status`);
+        const data = await resp.text();
+        return data === 'packager-status:running' ? 'running' : 'unrecognized';
+    }
+    catch {
+        return 'not_running';
+    }
+}
+exports.isPackagerRunning = isPackagerRunning;

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

@@ -0,0 +1,7 @@
+// options from https://github.com/facebook/react-native/blob/main/packages/community-cli-plugin/src/commands/start/index.js
+
+export interface ReactNativeStartOptions {
+  port: number;
+  resetCache: boolean; // default is false
+  interactive: boolean; // default is true
+}

package/src/executors/start/schema.json

@@ -0,0 +1,28 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "cli": "nx",
+  "$id": "NxReactNativeStart",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Packager Server for React Native",
+  "description": "Packager Server target options.",
+  "type": "object",
+  "properties": {
+    "port": {
+      "type": "number",
+      "description": "The port to listen on.",
+      "default": 8081
+    },
+    "resetCache": {
+      "type": "boolean",
+      "description": "Resets metro cache.",
+      "default": false
+    },
+    "interactive": {
+      "type": "boolean",
+      "description": "Run packager server in interactive mode.",
+      "default": true
+    }
+  },
+  "examplesFile": "../../../docs/start-examples.md"
+}

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

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import { ExecutorContext } from '@nx/devkit';
+import { ChildProcess } from 'child_process';
+import { ReactNativeStartOptions } from './schema';
+export interface ReactNativeStartOutput {
+    port?: number;
+    success: boolean;
+}
+export default function startExecutor(options: ReactNativeStartOptions, context: ExecutorContext): AsyncGenerator<ReactNativeStartOutput>;
+export declare function runCliStart(workspaceRoot: string, projectRoot: string, options: ReactNativeStartOptions): Promise<ChildProcess>;