@nx/react-native:bundle

JS Bundle target options.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

project.json:

{
  "name": "mobile",
  //...
  "targets": {
    //...
    "bundle-ios": {
      "executor": "@nx/react-native:bundle",
      "outputs": ["{projectRoot}/build"],
      "options": {
        "entryFile": "src/main.tsx",
        "platform": "ios",
        "bundleOutput": "dist/apps/mobile/ios/main.jsbundle"
      }
    },
    "bundle-android": {
      "executor": "@nx/react-native:bundle",
      "options": {
        "entryFile": "src/main.tsx",
        "platform": "android",
        "bundleOutput": "dist/apps/mobile/android/main.jsbundle"
      }
    }
  }
}

nx run mobile:bundle-ios
nx run mobile:bundle-android

Examples

The sourcemapOutput option allows you to specify the path of the source map relative to app folder:

    "bundle-ios": {
      "executor": "@nx/react-native:bundle",
      "options": {
        "entryFile": "src/main.tsx",
        "platform": "ios",
        "bundleOutput": "dist/apps/mobile/ios/main.jsbundle",
        "sourcemapOutput": "../../dist/apps/mobile/ios/main.map",
      }
    },
    "bundle-android": {
      "executor": "@nx/react-native:bundle",
      "options": {
        "entryFile": "src/main.tsx",
        "platform": "android",
        "bundleOutput": "dist/apps/mobile/android/main.jsbundle",
        "sourcemapOutput": "../../dist/apps/mobile/android/main.map",
      }
    }

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Examples

These buttons show the config object for specific common tasks.

Options

bundleOutput

Required

string

The output path of the generated files.

entryFile

Required

string

The entry file relative to project root.

platform

pRequired

string

Accepted values: ios, android

Platform to build for.

assetsDest

string

Directory name where to store assets referenced in the bundle.

dev

boolean

Default: true

Generate a development build.

minify

boolean

Allows overriding whether bundle is minified.

maxWorkers

number

The number of workers we should parallelize the transformer on.

resetCache

boolean

Default: false

Removes cached files.

readGlobalCache

boolean

Default: false

Try to fetch transformed JS code from the global cache, if configured.

sourcemapOutput

string

File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map.

sourcemapSourcesRoot

string

Path to make sourcemaps sources entries relative to, ex. /root/dir.

sourcemapUseAbsolutePath

boolean

Default: false

Report SourceMapURL using its full path.

transformer

string

Specify a custom transformer to be used.