expo-community-flipper

# expo-community-flipper Flipper Support for Expo Apps <= SDK 47 > 🎉 As of Expo 48, Flipper support is available via the official build-properties plugin, with a simpler interface and proper support! [read the docs](https://docs.expo.dev/versions/latest/sdk/build-properties/) [announcement](https://twitter.com/jakobo/status/1629531998262837249?s=20) > If you're running into issues with the official build-properties plugin, [check for an existing issue](https://github.com/expo/expo/issues?q=flipper+label%3A"Development+Builds") > ⚠️ (SDK 46, 47) Please see [this issue](https://github.com/jakobo/expo-community-flipper/issues/27) about known compatibility issues with other plugins. <hr /> > The remainder of this README applies to installing expo-community-flipper for SDK 47 and earlier. # Usage (Quick Guide) **1.** Install this module: `yarn add expo-community-flipper` **2.** Add `expo-community-flipper` configuration to the `plugins` section of your `app.json`, as per the examples below. You have the option to specify the version of Flipper, though the one built in with React Native is (usually) sufficient. If you don't specify anything, `expo-community-flipper` will default to the version of Flipper bundled with the version of React Native you're currently using. # Configuration ```ts type FlipperOptions = | undefined // take the default options for the entire plugin | string // sets <root>.version and takes defaults for all nested options | { version?: string; // sets the flipper version to build against (defaults to undefined, uses react-native bundled version) ios?: | boolean // sets <root>.ios.enabled and takes defaults for all nested options | { enabled: boolean; // enable flipper for iOS (default true) stripUseFrameworks?: boolean; // strip instances of use_frameworks from the Podfile (default false) }; android?: | boolean // sets <root>.android.enabled and takes defaults for all nested options | { enabled: boolean; // enable flipper for Android (default true) }; }; ``` Configuration of this plugin is done in `app.json`. all configurations are optional with defaults designed to minimize the chances of your build breaking. ```json { "expo": { "..." "plugins": [ "expo-community-flipper" ] } } // or configured (See FlipperOptions above): { "expo": { "..." "plugins": [ ["expo-community-flipper", FlipperOptions] ] } } ``` ## Disabling Flipper in CI (>= 45.1.0) 🛠️ 47.0.1 expo-community-flipper now supports the standard `ENV['NO_FLIPPER'] == 1` flag to disable flipper. You may also simply omit this plugin via `app.config.js` when building a production version of your app, as Flipper is not enabled by default. > 📜 Prior to 47.0.1, Flipper was disabled using `ENV['FLIPPER_DISABLE'] == "1"`. This is still supported, but deprecated in favor of the emerging standard from the react-native team. In production, Flipper is automatically disabled by the react-native framework, but see [this issue](https://github.com/jakobo/expo-community-flipper/issues/49) regarding a possible regression in upstream react-native/flipper. # Windows Users + Hermes > As of right now, using Windows with the Hermes engine requires you to run your app inside of a WSL environment. [The tracked issue is here](https://github.com/jakobo/expo-community-flipper/issues/4) and if you have a `Podfile`, please let me know. It's likely an upstream issue, but we're continuing to look at build artifacts in case we spot something that may resolve this issue. # Versions Starting with Expo SDK 46, Flipper manages its own compatibility layer (though it can be upgraded by specifying a version of Flipper that you want). Prior to SDK 46, we recommended running Flipper @ `0.123.0` as it had the widest range of compatibility with devices and simulators. This package follows [expo's policy for the deprecation of old SDKs](https://docs.expo.dev/workflow/upgrading-expo-sdk-walkthrough/). It's **MAJOR** version tracks against the Expo SDK version, making it easy to spot compatibility differences in your package.json file. # Testing An `/example` directory is built with `expo init example` for each major SDK release with a default `eas.json` file. The plugin is directly linked using expo's filepath support for config plugins. You can run `expo prebuild` in the directory to verify the plugin is modifying build files appropriately. **example eas.json** ```json { "cli": { "version": ">= 0.35.0" }, "build": { "example": { "releaseChannel": "default", "channel": "default" } } } ``` **example app.json** ```json { "expo": { "...": "... standard app.json entries ...", "plugins": [["./../build/withFlipper", "0.158.0"]] } } ``` # References - This code is based on the [Flipper Getting Started Guide](https://fbflipper.com/docs/getting-started/react-native/) - [Expo Config Plugins](https://docs.expo.dev/guides/config-plugins/) - [Using the latest Flipper SDK](https://fbflipper.com/docs/getting-started/react-native/#using-the-latest-flipper-sdk) - [React Native Community's Typescript Template](https://github.com/react-native-community/react-native-template-typescript/tree/main/template) ## Contributors ✨  [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)  Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):    <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://codedrift.com"><img src="https://avatars.githubusercontent.com/u/1795?v=4?s=100" width="100px;" alt="Jakob Heuser"/> Jakob Heuser</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=jakobo" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://twitter.com/gregfenton"><img src="https://avatars.githubusercontent.com/u/4407559?v=4?s=100" width="100px;" alt="gregfenton"/> gregfenton</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=gregfenton" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="http://aronberezkin.com"><img src="https://avatars.githubusercontent.com/u/32416348?v=4?s=100" width="100px;" alt="AronBe"/> AronBe</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=AronBe" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="http://raymondlam.midori.io"><img src="https://avatars.githubusercontent.com/u/1154044?v=4?s=100" width="100px;" alt="rlam3"/> rlam3</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=rlam3" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://recollectr.io"><img src="https://avatars.githubusercontent.com/u/6835891?v=4?s=100" width="100px;" alt="Slapbox"/> Slapbox</a> <a href="https://github.com/jakobo/expo-community-flipper/issues?q=author%3ASlapbox" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://isjustawesome.com"><img src="https://avatars.githubusercontent.com/u/689204?v=4?s=100" width="100px;" alt="Jeremy Gollehon"/> Jeremy Gollehon</a> <a href="https://github.com/jakobo/expo-community-flipper/issues?q=author%3AGollyJer" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/nkalinov"><img src="https://avatars.githubusercontent.com/u/2777825?v=4?s=100" width="100px;" alt="Nikola Kalinov"/> Nikola Kalinov</a> <a href="https://github.com/jakobo/expo-community-flipper/issues?q=author%3Ankalinov" title="Bug reports">🐛</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://twitter.com/kudochien"><img src="https://avatars.githubusercontent.com/u/46429?v=4?s=100" width="100px;" alt="Kudo Chien"/> Kudo Chien</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=Kudo" title="Documentation">📖</a> <a href="#question-Kudo" title="Answering Questions">💬</a> <a href="https://github.com/jakobo/expo-community-flipper/commits?author=Kudo" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/maxenceg"><img src="https://avatars.githubusercontent.com/u/38657323?v=4?s=100" width="100px;" alt="Maxence Gilliot"/> Maxence Gilliot</a> <a href="#question-maxenceg" title="Answering Questions">💬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Drew-Gerber"><img src="https://avatars.githubusercontent.com/u/118285913?v=4?s=100" width="100px;" alt="Andrew Gerber"/> Andrew Gerber</a> <a href="https://github.com/jakobo/expo-community-flipper/issues?q=author%3ADrew-Gerber" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/PimButton"><img src="https://avatars.githubusercontent.com/u/7047181?v=4?s=100" width="100px;" alt="Pim Knops"/> Pim Knops</a> <a href="https://github.com/jakobo/expo-community-flipper/issues?q=author%3APimButton" title="Bug reports">🐛</a></td> </tr> </tbody> </table>    This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!