@nx/react-native/src/executors/run-android/schema.json

The Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides: -Integration with libraries such as Jest, Detox, and Storybook. -Scaffolding for creating buildable libraries th

{
  "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"
}