xref: /expo/docs/pages/config-plugins/plugins-and-mods.mdx (revision fabbd5d2)

---
title: Plugins and mods
description: Learn about what are plugins and mods when creating a config plugin.
---

import { YesIcon, NoIcon, WarningIcon } from '~/ui/components/DocIcons';
import { Collapsible } from '~/ui/components/Collapsible';
import { BoxLink } from '~/ui/components/BoxLink';
import { FileTree } from '~/ui/components/FileTree';

Plugins are **synchronous** functions that accept an [`ExpoConfig`](/versions/latest/config/app/) and return a modified [`ExpoConfig`](/versions/latest/config/app/).

- Plugins should be named using the following convention: `with<Plugin Functionality>`, for example, `withFacebook`.
- Plugins should be synchronous and their return value should be serializable, except for any `mods` that are added.
- Optionally, a second argument can be passed to the plugin to configure it.
- `plugins` are always invoked when the config is read by the `expo/config` method `getConfig`. However, the `mods` are only invoked during the "syncing" phase of `npx expo prebuild`.

## Create a plugin

Here is an example of the most basic config plugin:

```js
const withNothing = config => config;
```

Say you wanted to create a plugin that added custom values to **Info.plist** in an iOS project:

```js my-plugin.js
const withMySDK = (config, { apiKey }) => {
  /* @info Ensure the objects exist */
  if (!config.ios) {
    /* @end */
    config.ios = {};
  }
  if (!config.ios.infoPlist) {
    config.ios.infoPlist = {};
  }

  /* @info Append the API Key */
  config.ios.infoPlist['MY_CUSTOM_NATIVE_IOS_API_KEY'] = apiKey;
  /* @end */

  return config;
};

module.exports.withMySDK = withMySDK;
```

To use the plugin, import it and wrap the config:

```js app.config.js
const { withMySDK } = require('./my-plugin');

/* @info Create a config */
const config = {
  /* @end */
  name: 'my app',
};

/* @info Apply the plugin */
module.exports = withMySDK(config, { apiKey: 'X-XXX-XXX' });
/* @end */
```

## Import a plugin

You may want to create a plugin in a different file, here's how:

- The root file can be any JS file or a file named **app.plugin.js** in the root of a Node module.
- The file should export a function that satisfies the [`ConfigPlugin`](https://github.com/expo/expo-cli/blob/3a0ef962a27525a0fe4b7e5567fb7b3fb18ec786/packages/config-plugins/src/Plugin.types.ts#L76) type.
- Plugins should be transpiled for Node environments ahead of time!
  - They should support the versions of Node that [Expo supports](/get-started/installation/#requirements) (LTS).
  - No `import/export` keywords, use `module.exports` in the shipped plugin file.
  - Expo only transpiles the user's initial `app.config` file, anything more would require a bundler which would add too many "opinions" for a config file.

Consider the following example that changes the config name:

<FileTree
  files={[
    ['app.config.js', 'Expo config'],
    ['my-plugin.js', 'Custom Config Plugin file'],
  ]}
/>

```js my-plugin.js
module.exports = function withPrefixedName(config, prefix) {
  // Modify the config
  config.name = prefix + '-' + config.name;
  // Return the results
  return config;
};
```

```js app.config.js
{
  "name": "my-app",
  "plugins": [["./my-plugin", "custom"]]
}
```

It evaluates to the following JSON config:

```json Evaluated config JSON
{
  "name": /* @info */ "custom-my-app" /* @end */,
  "plugins": [["./my-plugin", "custom"]]
}
```

## Chain plugins

Once you add a few plugins, your **app.config.js** code can become difficult to read and manipulate. To combat this, `expo/config-plugins` provides a `withPlugins` function which can be used to chain plugins together and execute them in order.

```js app.config.js
/// Create a config
const config = {
  name: 'my app',
};

// ❌ Hard to read
withDelta(withFoo(withBar(config, 'input 1'), 'input 2'), 'input 3');

// ✅ Easy to read
import { withPlugins } from 'expo/config-plugins';

withPlugins(config, [
  [withBar, 'input 1'],
  [withFoo, 'input 2'],
  // When no input is required, you can just pass the method...
  withDelta,
]);
```

<Collapsible summary="Using SDK 46 or lower?">

For SDK 46 and lower, import the `@expo/config-plugins` package directly. This is installed automatically by the `expo` package, but not re-exported as it is in SDK 47 and higher.

```js app.config.js
const { withPlugins } = require('@expo/config-plugins');
```

</Collapsible>

To support JSON configs, we also added the `plugins` array which just uses `withPlugins` under the hood.
Here is the same config as above, but even simpler:

```js app.config.js
export default {
  name: 'my app',
  plugins: [
    [withBar, 'input 1'],
    [withFoo, 'input 2'],
    [withDelta, 'input 3'],
  ],
};
```

## What are mods

A modifier (mod for short) is an async function that accepts a config and a data object, then manipulates and returns both as an object.

Mods are added to the `mods` object of the app config. The `mods` object is different from the rest of the app config because it doesn't get serialized
after the initial reading, which means you can use it to perform actions _during_ code generation.
If possible, you should attempt to use basic plugins instead of mods, as they're simpler to work with.

- `mods` are omitted from the manifest and **cannot** be accessed via `Updates.manifest`. Mods exist for the sole purpose of modifying native project files during code generation!
- `mods` can be used to read and write files safely during the `npx expo prebuild` command. This is how Expo CLI modifies the **Info.plist**, entitlements, xcproj, etc...
- `mods` are platform-specific and should always be added to a platform-specific object:

```js app.config.js
module.exports = {
  name: 'my-app',
  mods: {
    ios: {
      /* iOS mods... */
    },
    android: {
      /* Android mods... */
    },
  },
};
```

## How mods work

- The config is read using [`getPrebuildConfig`](https://github.com/expo/expo-cli/blob/43a6162edd646b550c1b7eae6039daf1aaec4fb0/packages/prebuild-config/src/getPrebuildConfig.ts#L12) from `@expo/prebuild-config`.
- All of the core functionality supported by Expo is added via plugins in `withIosExpoPlugins`. This is stuff like name, version, icons, locales, etc.
- The config is passed to the compiler `compileModsAsync`
- The compiler adds base mods that are responsible for reading data (like **Info.plist**), executing a named mod (like `mods.ios.infoPlist`), then writing the results to the file system.
- The compiler iterates over all the mods and asynchronously evaluates them, providing some base props like the `projectRoot`.
  - After each mod, error handling asserts if the mod chain was corrupted by an invalid mod.

{/* TODO: Move to a section about mod compiler */}

### Default mods

The following default mods are provided by the mod compiler for common file manipulation.

> Dangerous modifications rely on regular expressions (regex) to modify application code, which may cause the build to break.
> Regex mods are also difficult to version, and therefore should be used sparingly.
> Always opt towards using application code to modify application code, that is, [Expo Modules](https://github.com/expo/expo/tree/main/packages/expo-modules-core) native API.

| Android mod                       |    Dangerous    | Description                                                                                               |
| --------------------------------- | :-------------: | --------------------------------------------------------------------------------------------------------- |
| `mods.android.manifest`           |        -        | Modify the **android/app/src/main/AndroidManifest.xml** as JSON (parsed with [`xml2js`][xml2js]).         |
| `mods.android.strings`            |        -        | Modify the **android/app/src/main/res/values/strings.xml** as JSON (parsed with [`xml2js`][xml2js]).      |
| `mods.android.colors`             |        -        | Modify the **android/app/src/main/res/values/colors.xml** as JSON (parsed with [`xml2js`][xml2js]).       |
| `mods.android.colorsNight`        |        -        | Modify the **android/app/src/main/res/values-night/colors.xml** as JSON (parsed with [`xml2js`][xml2js]). |
| `mods.android.styles`             |        -        | Modify the **android/app/src/main/res/values/styles.xml** as JSON (parsed with [`xml2js`][xml2js]).       |
| `mods.android.gradleProperties`   |        -        | Modify the **android/gradle.properties** as a `Properties.PropertiesItem[]`.                              |
| `mods.android.mainActivity`       | <WarningIcon /> | Modify the **android/app/src/main/&lt;package&gt;/MainActivity.java** as a string.                        |
| `mods.android.mainApplication`    | <WarningIcon /> | Modify the **android/app/src/main/&lt;package&gt;/MainApplication.java** as a string.                     |
| `mods.android.appBuildGradle`     | <WarningIcon /> | Modify the **android/app/build.gradle** as a string.                                                      |
| `mods.android.projectBuildGradle` | <WarningIcon /> | Modify the **android/build.gradle** as a string.                                                          |
| `mods.android.settingsGradle`     | <WarningIcon /> | Modify the **android/settings.gradle** as a string.                                                       |

| iOS mod                      |    Dangerous    | Description                                                                                                                         |
| ---------------------------- | :-------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
| `mods.ios.infoPlist`         |        -        | Modify the **ios/&lt;name&gt;/Info.plist** as JSON (parsed with [`@expo/plist`][expo-plist]).                                       |
| `mods.ios.entitlements`      |        -        | Modify the **ios/&lt;name&gt;/&lt;product-name&gt;.entitlements** as JSON (parsed with [`@expo/plist`][expo-plist]).                |
| `mods.ios.expoPlist`         |        -        | Modify the **ios/&lt;ame&gt;/Expo.plist** as JSON (Expo updates config for iOS) (parsed with [`@expo/plist`][expo-plist]).          |
| `mods.ios.xcodeproj`         |        -        | Modify the **ios/&lt;name&gt;.xcodeproj** as an `XcodeProject` object (parsed with [`xcode`](https://www.npmjs.com/package/xcode)). |
| `mods.ios.podfileProperties` |        -        | Modify the **ios/Podfile.properties.json** as JSON.                                                                                 |
| `mods.ios.appDelegate`       | <WarningIcon /> | Modify the **ios/&lt;name&gt;/AppDelegate.m** as a string.                                                                          |

After the mods are resolved, the contents of each mod will be written to disk. Custom default mods can be added to support new native files.
For example, you can create a mod to support the `GoogleServices-Info.plist`, and pass it to other mods.

### Mod plugins

Mods are responsible for a lot of tasks, so they can be pretty difficult to understand at first.
If you're developing a feature that requires mods, it's best not to interact with them directly.

Instead you should use the helper mods provided by `expo/config-plugins`:

#### Android

| Android mod                       | Mod plugin               |    Dangerous    |
| --------------------------------- | ------------------------ | :-------------: |
| `mods.android.manifest`           | `withAndroidManifest`    |        -        |
| `mods.android.strings`            | `withStringsXml`         |        -        |
| `mods.android.colors`             | `withAndroidColors`      |        -        |
| `mods.android.colorsNight`        | `withAndroidColorsNight` |        -        |
| `mods.android.styles`             | `withAndroidStyles`      |        -        |
| `mods.android.gradleProperties`   | `withGradleProperties`   |        -        |
| `mods.android.mainActivity`       | `withMainActivity`       | <WarningIcon /> |
| `mods.android.mainApplication`    | `withMainApplication`    | <WarningIcon /> |
| `mods.android.appBuildGradle`     | `withAppBuildGradle`     | <WarningIcon /> |
| `mods.android.projectBuildGradle` | `withProjectBuildGradle` | <WarningIcon /> |
| `mods.android.settingsGradle`     | `withSettingsGradle`     | <WarningIcon /> |

#### iOS

| iOS mod                      | Mod plugin              |    Dangerous    |
| ---------------------------- | ----------------------- | :-------------: |
| `mods.ios.infoPlist`         | `withInfoPlist`         |        -        |
| `mods.ios.entitlements`      | `withEntitlementsPlist` |        -        |
| `mods.ios.expoPlist`         | `withExpoPlist`         |        -        |
| `mods.ios.xcodeproj`         | `withXcodeProject`      |        -        |
| `mods.ios.podfileProperties` | `withPodfileProperties` |        -        |
| `mods.ios.appDelegate`       | `withAppDelegate`       | <WarningIcon /> |

A mod plugin gets passed a `config` object with additional properties `modResults` and `modRequest` added to it.

- `modResults`: The object to modify and return. The type depends on the mod that's being used.
- `modRequest`: Additional properties supplied by the mod compiler.
  - `projectRoot: string`: Project root directory for the universal app.
  - `platformProjectRoot: string`: Project root for the specific platform.
  - `modName: string`: Name of the mod.
  - `platform: ModPlatform`: Name of the platform used in the mods config.
  - `projectName?: string`: (iOS only) The path component used for querying project files. ex. `projectRoot/ios/[projectName]/`

## Create a mod

Say you wanted to write a mod to update the Xcode Project's "product name":

```ts my-config-plugin.ts
import { ConfigPlugin, withXcodeProject } from 'expo/config-plugins';

const withCustomProductName: ConfigPlugin = (config, customName) => {
  return withXcodeProject(
    config,
    async (
      /* @info <b>{ modResults, modRequest }</b> */ config
      /* @end */
    ) => {
      const xcodeProject = config.modResults;
      xcodeProject.productName = customName;

      return config;
    }
  );
};

// �� Usage:

/// Create a config
const config = {
  name: 'my app',
};

/// Use the plugin
export default withCustomProductName(config, 'new_name');
```

<Collapsible summary="Using SDK 46 or lower?">

For SDK 46 and lower, import the `@expo/config-plugins` package directly. This is installed automatically by the `expo` package, but not re-exported as it is in SDK 47 and higher.

```js
const { ConfigPlugin, withXcodeProject } = require('@expo/config-plugins');
```

</Collapsible>

### Experimental functionality

Some parts of the mod system aren't fully fleshed out, these parts use `withDangerousMod` to read/write data without a base mod.
These methods essentially act as their own base mod and cannot be extended.
Icons, for example, currently use the dangerous mod to perform a single generation step with no ability to customize the results.

```js my-config-plugin.js
export const withIcons = config => {
  return withDangerousMod(config, [
    'ios',
    async config => {
      /* @info No modifications are made to the config */
      await setIconsAsync(config, config.modRequest.projectRoot);
      /* @end */
      return config;
    },
  ]);
};
```

Be careful using `withDangerousMod` as it is subject to change in the future.
The order with which it gets executed is not reliable either.
Currently, dangerous mods run first before all other modifiers, this is because we use dangerous mods internally for large file system refactoring like when the package name changes.

## Plugin module resolution

The strings passed to the `plugins` array can be resolved in a few different ways.

> Any resolution pattern that isn't specified below is unexpected behavior, and subject to breaking changes.

### Project file

You can quickly create a plugin in your project and use it in your config.

<FileTree
  files={[
    ['app.config.js', <code>import "./my-config-plugin"</code>],
    [
      'my-config-plugin.js',
      <>
        <YesIcon /> Imported from config
      </>,
    ],
  ]}
/>

In this example, the config plugin file contains a bare minimum function:

```js my-config-plugin.js
module.exports = config => config;
```

### app.plugin.js

Sometimes you want your package to export React components and also support a plugin. To do this, multiple entry points need to be used because the transpilation (Babel preset) may be different.
If an **app.plugin.js** file is present in the root of a Node module's folder, it'll be used instead of the package's `main` file.

<FileTree
  files={[
    ['app.config.js', <code>import "expo-splash-screen"</code>],
    ['node_modules/expo-splash-screen', 'Node module'],
    ['node_modules/expo-splash-screen/package.json', <code>"main": "./build/index.js"</code>],
    [
      'node_modules/expo-splash-screen/app.plugin.js',
      <>
        <YesIcon /> Entry file for custom plugins
      </>,
    ],
    [
      'node_modules/expo-splash-screen/build/index.js',
      <>
        <NoIcon /> Skipped in favor of <code>app.plugin.js</code>
      </>,
    ],
  ]}
/>

```js node_modules/expo-splash-screen/app.plugin.js
module.exports = config => config;
```

### Node module default file

A config plugin in a node module (without an **app.plugin.js**) will use the `main` file defined in the **package.json**.

<FileTree
  files={[
    ['app.config.js', <code>import "expo-splash-screen"</code>],

    ['node_modules/expo-splash-screen', 'Node module'],
    ['node_modules/expo-splash-screen/package.json', <code>"main": "./build/index.js"</code>],
    [
      'node_modules/expo-splash-screen/build/index.js',
      <>
        <YesIcon /> Node resolve to this file
      </>,
    ],

]}
/>

### Project folder

This is different to how Config Plugins in Node modules work because **app.plugin.js** won't be resolved by default in a directory. You'll have to manually specify `./my-config-plugin/app.plugin.js` to use it, otherwise **index.js** in the directory will be used.

<FileTree
  files={[
    ['app.config.js', <code>import "./my-config-plugin"</code>],
    [
      'my-config-plugin/index.js',
      <>
        <YesIcon /> Config Plugin
      </>,
    ],
    [
      'my-config-plugin/app.plugin.js',
      <>
        <NoIcon /> Skipped outside of a node module
      </>,
    ],
  ]}
/>

### Module internals

> **error** Avoid importing module internals.

If a file inside a Node module is directly imported, then the module's root **app.plugin.js** resolution will be skipped. This is referred to as "reaching inside a package" and is considered **bad form**.
We support this to make testing, and plugin authoring easier, but we don't expect library authors to expose their plugins like this as a public API.

<FileTree
  files={[
    ['app.config.js', <code>import "expo-splash-screen/build/index.js"</code>],
    ['node_modules/expo-splash-screen/package.json', <code>"main": "./build/index.js"</code>],
    [
      'node_modules/expo-splash-screen/app.plugin.js',
      <>
        <NoIcon /> Ignored due to direct import
      </>,
    ],
    [
      'node_modules/expo-splash-screen/build/index.js',
      <>
        <YesIcon /> <code>expo-splash-screen/build/index.js</code>
      </>,
    ],
  ]}
/>

### Raw functions

Expo config objects also support passing functions as-is to the `plugins` array. This is useful for testing, or if you want to use a plugin without creating a file.

```js app.config.js
const withCustom = (config, props) => config;

const config = {
  plugins: [
    [
      withCustom,
      {
        /* props */
      },
    ],
    /* @info Without props */
    withCustom,
    /* @end */
  ],
};
```

One caveat to using functions instead of strings is that serialization will replace the function with the function's name. This keeps **manifests** (kinda like the **index.html** for your app) working as expected.

Here is what the serialized config would look like:

```json
{
  "plugins": [["withCustom", {}], "withCustom"]
}
```

## Why app.plugin.js for plugins

Config resolution searches for a file named **app.plugin.js** first when a Node module ID is provided as a plugin.
This is because Node environments are often different to iOS, Android, or web JS environments and therefore require different transpilation presets (ex: `module.exports` instead of `import/export`).

Because of this reasoning, the root of a Node module is searched instead of right next to the **index.js**.
Imagine you had a TypeScript Node module where the transpiled main file was located at **build/index.js**,
if app config plugin resolution searched for **build/app.plugin.js** you'd lose the ability to transpile the file differently.

## Next step

<BoxLink
  title="Development and debugging"
  description="Learn about development best practices and debugging techniques for app config plugins."
  href="/config-plugins/development-and-debugging"
/>

[xml2js]: https://www.npmjs.com/package/xml2js
[expo-plist]: https://www.npmjs.com/package/@expo/plist