microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
doc/expo.md
48lines · modecode
| 1 | ## Debugging Expo applications |
| 2 | |
| 3 | To debug a project created using Expo or the create-react-native-app task, you can use embedded support for Expo. |
| 4 | |
| 5 | Your environment must meet the following prerequisites: |
| 6 | |
| 7 | - Install the [Expo app](https://getexponent.com/) on the target device or emulator |
| 8 | - Ensure that the react-native-cli is installed globally (`npm install -g react-native-cli`) |
| 9 | |
| 10 | To start debugging in Expo follow these steps: |
| 11 | |
| 12 | 1. Open your project in VS Code with this extension installed. |
| 13 | 2. Create a debug configuration (as described in [Debugging React Native applications](../README.md#debugging-react-native-applications)), select `Debug in Exponent` in the debug drop-down menu, and start debugging |
| 14 | 4. Wait while some dependencies are configured - the extension will install `xde` and `@expo/ngrok` when this feature is used for the first time. |
| 15 | 5. If you have not used exponent on this system before, you will be prompted for an exponent username and password. |
| 16 | If you have not created an exponent account, then specifying a new username and password will create one. |
| 17 | Note that there is no e-mail associated with the account, and no way to recover a forgotten password. |
| 18 | 6. Once the packager starts, the extension will open a separate tab with QR code to scan from the Exponent app. Once you do so, the Exponent app will connect to the packager and begin running your app. |
| 19 | |
| 20 | From here you can run and debug the app as normal. |
| 21 | |
| 22 | ## Configuring Expo |
| 23 | |
| 24 | When you use Exponent for the first time in VS Code (either to run, debug or publish) you will notice that we created a couple of files for you. This files are: `.vscode/exponentIndex.js`, `.vscode/vscodeExponent.json` and `exp.json`. |
| 25 | |
| 26 | Under your `.vscode/` directory there will be a `vscodeExponent.json` file; this file has the settings used to setup exponent correctly in VS Code. |
| 27 | |
| 28 | ``` |
| 29 | { |
| 30 | "entryPointFilename": "" // File under the project root that is used as an entrypoint. We look for index.ios.js or index.android.js |
| 31 | "entryPointComponent": "" // Name of the main component used in your entrypoint. By default it's the same name as your app |
| 32 | "createOrOverwriteExpJson": false // If true we will create and overwrite exp.json everytime. If you need a custom exp.json ensure this is false. |
| 33 | } |
| 34 | ``` |
| 35 | |
| 36 | The extension attempts to guess some default settings, but you may need to change them to suit your configuration. |
| 37 | If we guessed the filename or component wrong, or you want to try out different entrypoints, feel free to modify `.vscode/vscodeExponent.json` to try out the appropriate settings for your environment. |
| 38 | |
| 39 | When running under Exponent, your application will start via `.vscode/exponentIndex.js` will reference the `entryPointFilename` from `vscodeExponent.json`. |
| 40 | If you change your application's entry point (e.g. changing from `index.ios.js` to `index.android.js`), delete or update `.vscode/exponentIndex.js` for it to take effect. |
| 41 | |
| 42 | If you are an experienced exponent user, or you want to customize your `exp.json` set `createOrOverwriteExpJson` to `false` in `.vscode/vscodeExponent.json`. This will let you have your own version of `exp.json` without overwritting it each time we run something. |
| 43 | |
| 44 | ## FAQ |
| 45 | |
| 46 | **Q: I was working with a React Native version and after debugging in exponent I decided to update it, why is exponent not updating automatically?** |
| 47 | |
| 48 | The extension caches the version of the exponent SDK used by your project. This is helpfull since we don't want to install the SDK each time you run exponent. If you want the extension to update the SDK version based on your React Native version, just restart VS Code and we should be able to do it if it's supported. |
| 49 | |