GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/vscode-react-native

Public

mirrored from https://github.com/microsoft/vscode-react-nativeAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
1.1.0

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

README.md

667lines · modecode

RawDownload
Latest commit unavailable.
1# React Native Tools
2
3[![Build Status](https://dev.azure.com/vscode-webdiag-extensions/VS%20Code%20WebDiag%20extensions/_apis/build/status/%5BUnit%20tests%5D%20vscode-react-native%20%5Bmaster%5D?branchName=master)](https://dev.azure.com/vscode-webdiag-extensions/VS%20Code%20WebDiag%20extensions/_build/latest?definitionId=60&branchName=master)
4
5Stable:
6![Stable version](https://vsmarketplacebadge.apphb.com/version-short/msjsdiag.vscode-react-native.svg)
7![VS Marketplace rating](https://vsmarketplacebadge.apphb.com/rating-star/msjsdiag.vscode-react-native.svg)
8
9Preview:
10![VS Marketplace version](https://vsmarketplacebadge.apphb.com/version-short/msjsdiag.vscode-react-native-preview.svg)
11![VS Marketplace rating](https://vsmarketplacebadge.apphb.com/rating-star/msjsdiag.vscode-react-native-preview.svg)
12
13
14## React Native Tools Preview
15The extension has a [nightly version](https://marketplace.visualstudio.com/items?itemName=msjsdiag.vscode-react-native-preview) which is released on a daily basis at 9 PM PST on each day that changes occur.
16To avoid conflicts, if both extensions are installed - the only stable version will be activated. So to use the preview version it is needed to disable or remove the stable version and reload VS Code.
17
18## About the extension
19
20This VS Code extension provides a development environment for React Native projects.
21Using this extension, you can **debug your code and quickly run `react-native` commands** from the command palette.
22
23![React Native features](images/react-features.gif)
24
25<!-- TABLE OF CONTENTS -->
26
27# Table of Contents
28
29- [React Native Tools Preview](#react-native-tools-preview)
30- [About the extension](#about-the-extension)
31- [Getting started](#getting-started)
32- [React Native commands in the Command Palette](#react-native-commands-in-the-command-palette)
33- [Debugging React Native applications](#debugging-react-native-applications)
34 - [Hermes (Android) applications](#hermes-android)
35 - [iOS applications](#ios-applications)
36 - [iOS devices](#ios-devices)
37 - [Custom scheme for iOS apps](#custom-scheme-for-ios-apps)
38 - [iOS direct debugging](#iOS-direct-debugging)
39 - [Expo applications](#expo-applications)
40 - [Configuring Expo](#configuring-expo)
41 - [Windows applications](#react-native-for-windows)
42 - [macOS applications](#react-native-for-macos)
43 - [TypeScript and Haul based applications](#typescript-and-haul)
44 - [Debugger configuration properties](#debugger-configuration-properties)
45- [Customization](#customization)
46 - [Logging](#logging)
47 - [Build APK and generate bundle](#build-apk-and-generate-bundle)
48 - [Specifying custom arguments for `react-native run-*` command](#specifying-custom-arguments-for-react-native-run--command)
49 - [Setting up the React Native packager](#setting-up-the-react-native-packager)
50 - [Change project root](#change-project-root)
51- [Developing inside a Docker Container](#developing-inside-a-docker-container)
52- [Contributing](#contributing)
53- [Known Issues](#known-issues)
54
55# Getting started
56
57Before going any further make sure that you:
58
59- [have a working React Native environment](https://reactnative.dev/docs/environment-setup).
60- are using [VS Code](https://code.visualstudio.com) and have [installed this extension from the Marketplace](https://marketplace.visualstudio.com/items?itemName=msjsdiag.vscode-react-native).
61- have your React Native project root folder open in VS Code.
62
63Please notice that the extension uses `.vscode/.react` directory at the project root to store intermediate files required for debugging. Although these files usually get removed after debug session ends, you may want to add this directory to your project's `.gitignore` file.
64
65# React Native commands in the Command Palette
66
67In the Command Palette, type `React Native` and choose a command.
68
69![React Native commands](images/command-palette.png)
70
71The **Run Android** command triggers `react-native run-android` and starts your app for Android.
72
73The **Run iOS** command similarly triggers `react-native run-ios` and starts your app in the iOS simulator (e.g. iPhone 6).
74
75The **Packager** commands allow you to start/stop the [**Metro Bundler**](https://github.com/facebook/metro-bundler) (formerly React Packager).
76
77The full list of commands is:
78
79| Name | Description |
80| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81| Launch Android Emulator | Prompts you to select the name of the available emulator and launch it. If only one emulator is installed in the system, it will be selected automatically |
82| Run Android on Emulator | Run an Android application on Emulator. Launch order: check target platform support, load run arguments, start Packager, run app in all connected emulators |
83| Run Android on Device | Run an Android application on Device. Launch order: check target platform support, load run arguments, start Packager, run app in all connected devices |
84| Run iOS on Simulator | Run an iOS application on Simulator. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected emulator |
85| Run iOS on Device | Run an iOS application on Device. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected device |
86| Run Expo | Run Exponent application. Launch order: login to exponent, load run arguments, start Packager, run app |
87| Start Packager | Start Packager in context project workspace folder |
88| Stop Packager | Stop Packager |
89| Restart Packager | Restart Packager |
90| Publish To Expo | Publish to Exponent Host. Launch order: login to exponent, execute `Run Expo` command, then publish app to host |
91| Show Dev Menu | Show development menu for running aplication on iOS or Android device or emulator |
92| ReloadApp | Reload an application |
93| Run Element Inspector | Load development tools for inspect application UI elements |
94
95# Debugging React Native applications
96
97To start debugging create a new debug configuration for your ReactNative app in your `.vscode/launch.json`. Adding a new configuration can be done by opening your `launch.json` file and clicking on `Add Configuration...` button and choosing a relevant debug configuration. All available debug configurations for ReactNative can be accessed by typing in _ReactNative_ and picking one from the list populated by Intellisense as shown in the image below.
98
99![Add React Native debug configuration](images/add-debug-configuration.gif)
100
101In case you haven't created the `.vscode/launch.json` file yet, you can add a whole default debug configuration set. To do that click the debug icon ![Choose React Native debugger](images/debug-view-icon.png) in the View bar, and then click the configuration (gear) icon ![Configure-gear](images/configure-gear-icon.png), then choose the React Native debug environment.
102
103![Choose React Native debugger](images/choose-debugger.png)
104
105VS Code will generate a `launch.json` in your project with some default configuration settings as shown below. You can safely close this file, choose the appropriate configuration in the Configuration dropdown, and then press F5 (or click _Green Arrow_ ![Configure-gear](images/debug-icon.png) button) to start debugging your app in VS Code.
106
107![React Native launch targets](images/debug-targets.png)
108
109Once app is loaded and running, [open the developer menu](https://reactnative.dev/docs/debugging#accessing-the-in-app-developer-menu) inside your application and enable remote debugging by clicking on `Debug JS Remotely` button.
110
111![React Native enable remote debug](images/enable-remote-debug.png)
112
113The extension allows you to debug multiple devices and configurations, please read the following sections for more information for your particular use case.
114
115## Hermes (Android)
116
117Hermes is the new JavaScript engine optimized for running React Native apps on Android. It improves app performance and decreases app size.
118
119Click [here](https://reactnative.dev/docs/hermes) to learn more about Hermes.
120
121Debugging apps with Hermes enabled is currently experimental. Please, see [this issue](https://github.com/microsoft/vscode-react-native/issues/1073) for current known issues on Hermes support.
122
123To debug while using Hermes engine, please choose one of the following debug configurations:
124
125- React Native Direct: Debug Android Hermes - Experimental
126
127```json
128{
129 "name": "Debug Android Hermes - Experimental",
130 "cwd": "${workspaceFolder}",
131 "type": "reactnativedirect",
132 "request": "launch",
133 "platform": "android"
134}
135```
136
137- "React Native Direct: Attach to the React Native Hermes - Experimental
138
139```json
140{
141 "name": "Attach to the React Native Hermes - Experimental",
142 "cwd": "${workspaceFolder}",
143 "type": "reactnativedirect",
144 "request": "attach"
145}
146```
147## iOS applications
148
149### iOS devices
150
151Debugging on an iOS device requires following manual steps:
152
153- Install [ios-deploy](https://www.npmjs.com/package/ios-deploy) `npm install -g ios-deploy`.
154- Install a valid iOS development certificate.
155- In your project's `launch.json` file set `target` to `device`. If you need to specify the exact device to run, you can set `target` to `device=<iOS_device_name>`, or you can also use `runArguments` property to specify a particular device to run on in case multiple devices are connected (e.g. `"runArguments": [ "--device", "My iPhone" ]`)
156- Choose the **Debug iOS** option from the "Configuration" dropdown and press F5.
157- Shake the device to open the development menu and select "Debug JS Remotely".
158
159### Custom scheme for iOS apps
160
161If you want to use a custom scheme for your application you can either pass it as part of the `runArguments` parameter arguments, or set the `scheme` configuration parameter as shown below:
162
163```js
164"runArguments": ["--scheme", "customScheme", ...]
165// or
166"runArguments": ["--scheme=customScheme", ...]
167// or
168"scheme" : "customScheme"
169```
170
171Please be aware, specifying the scheme value as a part of the `runArguments` parameter arguments will override the `scheme` configuration parameter value, if it set.
172
173### iOS direct debugging
174
175The extension provides experimental support of iOS direct debugging. See more info here: [react-native-community/discussions-and-proposals#40](https://github.com/react-native-community/discussions-and-proposals/issues/40), [react-native-community/discussions-and-proposals#206](https://github.com/react-native-community/discussions-and-proposals/issues/206)
176
177To be able to debug an iOS app directly, you need to instal [ios-webkit-debug-proxy](https://github.com/google/ios-webkit-debug-proxy):
178
179- Install [HomeBrew](https://brew.sh) on your Mac.
180- Open a Terminal and run `brew install ideviceinstaller ios-webkit-debug-proxy`
181
182You can use the following debug scenarios to debug iOS apps directly:
183
184- React Native Direct: Debug Direct iOS - Experimental
185
186```json
187 "name": "Debug Direct iOS - Experimental",
188 "cwd": "${workspaceFolder}",
189 "type": "reactnativedirect",
190 "request": "launch",
191 "platform": "ios",
192 "port": 9221
193```
194
195- React Native Direct: Attach to the React Native iOS - Experimental
196
197```json
198 "name": "Attach to the React Native iOS - Experimental",
199 "cwd": "${workspaceFolder}",
200 "type": "reactnativedirect",
201 "request": "attach",
202 "platform": "ios",
203 "port": 9221
204```
205
206## Expo applications
207
208To debug a project created using Expo or the `create-react-native-app` task, you can use embedded support for Expo.
209
210Prepare your environment by following the [Expo CLI Quickstart instruction](https://reactnative.dev/docs/environment-setup).
211For correct work with Expo this extension **`requires Android SDK`**.
212So also pay attention to the `React Native CLI Quickstart` tab, where you can find the Android SDK installation guide:
213
214- Install the [Expo app](https://getexponent.com/) on the target device or emulator
215- Ensure that the `Android SDK` is installed on your computer (You may install it using the [`React Native CLI Quickstart` guide](https://reactnative.dev/docs/environment-setup))
216- Ensure that the `expo-cli` is installed globally (`npm install -g expo-cli`)
217
218You can verify that everything is working correctly and that the environment is ready for use with the `npx react-native doctor` command.
219
220To start debugging in Expo follow these steps:
221
2221. Open your project in VS Code with this extension installed.
2231. Create a debug configuration (as described in [Debugging React Native applications](#debugging-react-native-applications)), select `Debug in Exponent` in the debug drop-down menu, and start debugging
2241. Wait while some dependencies are configured - the extension will install [`Expo Development Library(@expo/xdl)`](https://www.npmjs.com/package/@expo/xdl) when this feature is used for the first time.
2251. If you have not used Exponent on this system before, you will be prompted for an Exponent username and password.
226 Exponent account allows you to use Expo cloud services. More info about how it works is available [here](https://docs.expo.io/versions/latest/workflow/how-expo-works/).
227 If you have not created an Exponent account, then specifying a new username and password will create one.
228 Note that there is no e-mail associated with the account, and no way to recover a forgotten password.
229 If you don't want to create an Exponent account, you can specify `expoHostType` parameter in your debug configuration to make Expo work locally (via LAN or on localhost).
2301. 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.
2311. Once the app is loaded and running, [open the developer menu](https://reactnative.dev/docs/debugging#accessing-the-in-app-developer-menu) and enable remote debugging by clicking on `Debug JS Remotely` button.
232
233 ![React Native developer menu](./images/enable-remote-debug.png)
234
235 From here you can run and debug the app as normal.
236
237### Configuring Expo
238
239The extension supports running through Exponent not just the applications created with Expo but even pure React Native applications (in that case you need to add `expo` package to `node_modules` in order to make it work with Expo: `npm install expo --save-dev`. In either cases it uses `app.json` configuration file in the root of the project.
240
241If you are running `Debug in Exponent` configuration or any of pallette commands like `Run in Exponent`, `Publish to Exponent` then this file will be created automatically if absent or updated with the following basic configuration section:
242
243```json
244{
245 "expo": {
246 "slug": "MyApp", // Project slug
247 "name": "MyApp", // Project name
248 "sdkVersion": "31.0.0", // Expo SDK version
249 "entryPoint": ".vscode\\exponentIndex.js" // Entrypoint for the project
250 },
251 "name": "MyApp" // Project name
252}
253```
254
255Full list of configuration parameters for `expo` section in `app.json` may be found on [official Expo documentation page](https://docs.expo.io/versions/latest/workflow/configuration).
256
257For running **pure React Native app**, the extension, creates and uses `.vscode/exponentIndex.js` which points to the app entrypoint (`index.js` or `index.android.js` or `index.ios.js`) file.
258
259If you want to change your app entrypoint (for example, from `index.js` to `index.android.js`), delete `.vscode/exponentIndex.js` and then restart your debugging session.
260
261**NOTE**: The extension caches the version of the exponent SDK used by your project. This is helpful 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 if it is supported it should work. If it does not please open an issue.
262
263## React Native for Windows
264
265You can debug UWP and WPF React Native for Windows applications by changing the `platform` in your `launch.json` configuration:
266
267- For `UWP` use `windows`:
268
269 ```json
270 {
271 "name": "Debug UWP",
272 "cwd": "${workspaceFolder}",
273 "type": "reactnative",
274 "request": "launch",
275 "platform": "windows"
276 }
277 ```
278
279- For `WPF` use `wpf`:
280
281 ```json
282 {
283 "name": "Debug WPF",
284 "cwd": "${workspaceFolder}",
285 "type": "reactnative",
286 "request": "launch",
287 "platform": "wpf"
288 }
289 ```
290
291 You can find more information on how to setup your application to work with Windows in [React Native for Windows Getting started instruction](https://microsoft.github.io/react-native-windows/docs/getting-started)
292
293## React Native for macOS
294
295You can debug React Native for macOS applications by changing the `platform` in your `launch.json` configuration to `macos`:
296
297 ```json
298 {
299 "name": "Debug macOS",
300 "cwd": "${workspaceFolder}",
301 "type": "reactnative",
302 "request": "launch",
303 "platform": "macos"
304 }
305 ```
306
307 You can find more information on how to setup your application to work with macOS in [React Native for macOS Getting started instruction](https://microsoft.github.io/react-native-windows/docs/rnm-getting-started)
308
309## TypeScript and Haul
310
311### Sourcemaps
312
313The debugger uses sourcemaps to let you debug with your original sources, but sometimes the sourcemaps aren't generated properly and overrides are needed. In the config we support `sourceMapPathOverrides`, a mapping of source paths from the sourcemap, to the locations of these sources on disk. Useful when the sourcemap isn't accurate or can't be fixed in the build process.
314
315The left hand side of the mapping is a pattern that can contain a wildcard, and will be tested against the `sourceRoot` + `sources` entry in the source map. If it matches, the source file will be resolved to the path on the right hand side, which should be an absolute path to the source file on disk.
316
317Below there are some examples of how sourcemaps could be resolved in different scenarios:
318
319```javascript
320// webRoot = /Users/me/project
321"sourceMapPathOverrides": {
322 "webpack:///./~/*": "${webRoot}/node_modules/*", // Example: "webpack:///./~/querystring/index.js" -> "/Users/me/project/node_modules/querystring/index.js"
323 "webpack:///./*": "${webRoot}/*", // Example: "webpack:///./src/app.js" -> "/Users/me/project/src/app.js",
324 "webpack:///*": "*", // Example: "webpack:///project/app.ts" -> "/project/app.ts"
325 "webpack:///src/*": "${webRoot}/*" // Example: "webpack:///src/app.js" -> "/Users/me/project/app.js"
326}
327```
328
329### Haul debugging
330
331The extension provides functional to attach to [Haul packager](https://callstack.github.io/haul/) based applications. You can use the `Attach to packager` scenario to attach to a Haul based app and debug it. For now launch scenarios aren't supported. You can find more info in [the issue](https://github.com/microsoft/vscode-react-native/issues/883).
332
333You can prepare your React Native application to work with `Haul` by following the [`Haul Getting started` guide](https://github.com/callstack/haul#getting-started).
334
335If you use the [legacy version](https://github.com/callstack/haul/tree/legacy) of `Haul` as your React Native bundler instead of the default [Metro](https://facebook.github.io/metro/), it could be required to add `sourceMapPathOverrides` to the `launch.json` file.
336
337For example:
338
339```json
340{
341 // Other configurations
342 "sourceMapPathOverrides": {
343 "webpack:///./~/*": "${workspaceRoot}/node_modules/*",
344 "webpack:///./*": "${workspaceRoot}/*",
345 "webpack:///*": "*"
346 }
347}
348```
349
350## Debugger configuration properties
351
352The following is a list of all the configuration properties the debugger accepts in `launch.json`:
353
354| Name | Description | Type | Defaults |
355| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | --------------------------------------------- |
356| `cwd` | The path to the project root folder | `string` | `${workspaceFolder}` |
357| `sourceMaps` | Whether to use JavaScript source maps to map the generated bundled code back to its original sources | `boolean` | `true` |
358| `sourceMapPathOverrides` | A set of mappings for rewriting the locations of source files from what the source map says, to their locations on disk. See [Sourcemaps](#sourcemaps) for details | `object` | n/a |
359| `enableDebug` | Whether to enable debug mode. If set to "false", an application will be launched without debugging | `boolean` | `true` |
360| `trace` | Logging level in debugger process. May be useful for diagnostics. If set to "Trace" all debugger process logs will be available in `Debug Console` output window | `string` | `log` |
361| `address` | TCP/IP address of packager to attach to for debugging | `string` | `localhost` |
362| `port` | Port of packager to attach to for debugging | `string` | `8081` |
363| `remoteRoot` | The source root of the remote host | `string` | `null` |
364| `localRoot` | The local source root that corresponds to the 'remoteRoot' | `string` | `${workspaceFolder}` |
365| `skipFiles` | An array of file or folder names, or glob patterns, to skip when debugging | `array` | `[]` |
366| `debuggerWorkerUrlPath` | Path to the app debugger worker to override. For example, if debugger tries to attach to http://localhost:8081/debugger-ui/debuggerWorker.js and you get 404 error from packager output then you may want to change debuggerWorkerUrlPath to another value suitable for your packager (\"debugger-ui\" will be replaced with the value you provide) | `string` | `debugger-ui/` |
367| `platform` | The platform to target. Possible values: `android`, `ios`, `exponent`, `windows`, `wpf` | `string` | n/a |
368| `target` | Target to run on. Possible values: `simulator`, `device`, `device=<iOS device name>`, [`<Android emulator/device id>`](https://github.com/react-native-community/cli/blob/master/docs/commands.md#--deviceid-string), `<Android emulator name>`, `<iOS simulator name>`, `<iOS simulator id>`. If the value is `simulator` then the quick pick window will be expanded with the names of the available virtual devices, then the target value in `launch.json` will be changed to the name of the selected virtual device. If you have only one virtual device available, it will be selected automatically. | `string` | `simulator` |
369| `logCatArguments` | Arguments to be used for LogCat (The LogCat output will appear on an Output Channel). It can be an array such as: `[":S", "ReactNative:V", "ReactNativeJS:V"]` | `array` | `["*:S", "ReactNative:V", "ReactNativeJS:V"]` |
370| `runArguments` | Run arguments to be passed to `react-native run-<platform>` command (override all other configuration params) | `array` | n/a |
371| `launchActivity` | The Android activity to be launched for debugging, e.g. it specifies [`--main-activity`](https://github.com/react-native-community/cli/blob/master/docs/commands.md#--main-activity-string) parameter in `react-native` run arguments | `string` | `MainActivity` |
372| `expoHostType` | The connection type to be used on Expo debugging to communicate with a device or an emulator. Possible values: <ul><li>`tunnel` - allows to deploy and debug an application by means of Expo cloud services</li><li>`lan` - allows to deploy and install an application via your LAN</li><li>`local` - allows to debug an application on an emulator or an Android device without network connection</li></ul> | `string` | `tunnel` |
373| `env` | Environment variables passed to the debugger and `react-native run-<platform>` command | `object` | `{}` |
374| `envFile` | Absolute path to a file containing environment variable definitions | `string` | `${workspaceFolder}/.env` |
375| `variant` | A variant to be passed to `react-native run-android`, e.g. use `devDebug` to specify `--variant=devDebug` | `string` | n/a |
376| `scheme` | A scheme name to be passed to `react-native run-ios`, e.g. `devDebug` to specify `--scheme=devDebug` | `string` | n/a |
377| `productName` | iOS bundle display name e.g. `AwesomeProject` value means that the extension will search for `AwesomeProject.app` bundle | `string` | n/a |
378
379# Customization
380
381The extension can be further customized for other React Native scenarios. These are the most common:
382
383## Logging
384
385The extension logging is divided by several output channels:
386* React Native - the main extension channel which collects outputs from React Native Packager and shows critical errors in the extension
387* These channels are spawned only when the specific launch scenario is executed:
388 * React Native: Run Android
389 * LogCat monitor(to get LogCat output from Android device, can be filtered by debug configuration settings)
390 * React Native: Run iOS
391 * React Native: Run macOS
392 * React Native: Run exponent
393* Debug Console which is used to receive application logs and logs generated by the debug adapter (`console.log` and other `std` outputs from the app)
394* Extension debugger verbose logs (these logs are shown up only if the `trace: "verbose"` option is enabled in debug scenarios)
395 * React Native Chrome Proxy - shows what runs in and out to the debugger and application
396 * Debug Console becomes more informative and contains some debugging information from the debug adapter
397 * Global extension errors are controlled by VS Code and printed in VS Code Developer Tools
398
399There are also some global extension technical logs that might be exposed to the output. To see them set the following properties:
400
401```json
402{
403 "react-native-tools": {
404 "logLevel": "Trace"
405 }
406}
407```
408
409`logLevel` can be `None` (no logs), `Error`, `Warning`, `Info`, `Debug`, `Trace` (all logs). Default is `Info`.
410
411## Build APK and generate bundle
412
413You can add VSCode tasks to build an `.apk` file and generate iOS/Android bundles.
414
415The following is an example of a `tasks.json` for `react-native init` projects.
416Place it in the `.vscode` folder in your project to use it:
417
418```json
419{
420 "version": "2.0.0",
421 "presentation": {
422 "reveal": "always",
423 "panel": "new"
424 },
425 "tasks": [
426 {
427 "taskName": "Build APK Debug",
428 "group": "build",
429 "type": "shell",
430 "windows": {
431 "command": "cd android; if($?) {./gradlew assembleDebug}"
432 },
433 "linux": {
434 "command": "cd android && ./gradlew assembleDebug"
435 }
436 },
437 {
438 "taskName": "Build APK Release",
439 "group": "build",
440 "type": "shell",
441 "windows": {
442 "command": "cd android; if($?) {./gradlew assembleRelease}"
443 },
444 "linux": {
445 "command": "cd android && ./gradlew assembleRelease"
446 }
447 },
448 {
449 "taskName": "Generate Android Bundle",
450 "group": "build",
451 "type": "shell",
452 "command": "react-native bundle --platform android --dev false --entry-file index.js --bundle-output android/main.jsbundle"
453 },
454 {
455 "taskName": "Generate iOS Bundle",
456 "group": "build",
457 "type": "shell",
458 "command": "react-native bundle --platform ios --dev false --entry-file index.js --bundle-output ios/main.jsbundle"
459 }
460 ]
461}
462```
463
464To learn more about `tasks` in VSCode read [the official documentation](https://code.visualstudio.com/docs/editor/tasks).
465
466Visit [generating Signed APK](https://reactnative.dev/docs/signed-apk-android.html) to learn more about this subject.
467
468## Specifying custom arguments for `react-native run-*` command
469
470Using custom run arguments for `react-native run-<platform>`:
471**NOTE:** This overrides all other configuration parameters.
472
473```json
474{
475 "react-native.android.runArguments.simulator": [
476 "--appFolder",
477 "/Users/test/AwesomeProject/android/app",
478 "--deviceId",
479 "emulator-5555"
480 ],
481 "react-native.ios.runArguments.device": [
482 "--project-path",
483 "ios",
484 "--device",
485 "Max's iPhone"
486 ]
487}
488```
489
490**NOTE:** You can get the list of installed simulator devices by:
491
492iOS devices (macOS only):
493
494```
495xcrun simctl list --json devices
496```
497
498Android devices:
499
500```
501adb devices
502```
503
504**NOTE:** If you want to run the application on an iOS device, make sure you have `ios-deploy` installed globally.
505
506`npm install -g ios-deploy`
507
508## Setting up the react-native packager
509
510To use a custom port for the `react-native` packager:
511
512```json
513{
514 "react-native": {
515 "packager": {
516 "port": portNumber
517 }
518 }
519}
520```
521
522If you change this port, then for iOS device and simulator scenarios you will have to modify the native code files. [Instructions here](https://blog.binoy.io/running-react-native-on-a-different-port-7deb43887cd4).
523
524If you use Android, you need to change the debug server by:
525
5261. `CTRL+M`(`CMD+M`) in the emulator
5272. Go to `Dev Settings`
5283. Debug server host for device => enter `localhost:<yourPortNumber>`.
5294. Reload application (press `R` twice)
5305. (Hermes only) Hermes engine listens port 8081 for debugging by default, to change it you might need to modify your [`metro.config.js` file adding `"port": portNumber` argument in there to the server settings](https://facebook.github.io/metro/docs/configuration/#port).
531
532```js
533// Example of metro.config.js
534module.exports = {
535 server: {
536 port: 9091,
537 },
538};
539```
540
541<details>
542<summary>Port setup instruction</summary>
543
544![image](images/select-dev-menu.png)
545
546![image](images/dev-menu-setup-custom-host.png)
547
548![image](images/custom-host-and-port.png)
549
550</details>
551
552**NOTE:** Some aspects of React Native hard-code the port to the default as specified in [this issue](https://github.com/facebook/react-native/issues/9145).
553
554### Custom environment variables
555
556Extension supports passing custom environment variables to the React Native Packager process context. To add custom variables you can create `.env` file in the root folder of your project and add needed environment variables in the following format:
557
558```
559
560Variable1_name=Variable1_value
561Variable2_name=Variable2_value
562
563```
564
565Variables that are declared in this `.env` file can override the original environment variables from `process.env` of the Packager process.
566
567It is possible to transfer environment variables (via `env` and `envFile` arguments in `launch.json`) from the `launch` or `attach` debug scenarios to the Packager. If these variables are defined, then they will be used, otherwise the `.env` file is used.
568
569## Change project root
570
571To specify a subfolder in which the react-native project is located, set `react-native-tools.projectRoot`. You can use either an absolute or relative path here:
572
573```json
574{
575 "react-native-tools": {
576 "projectRoot": "./your/react-native/project"
577 }
578}
579```
580
581# Developing inside a Docker Container
582
583The extension supports [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview) features on Linux. Please follow the [VS Code official documentation](https://code.visualstudio.com/docs/remote/containers) to setup your environment to use a remote development approach.
584
585You can use [official React Native Docker image](https://hub.docker.com/r/reactnativecommunity/react-native-android) provided by the [react-native-community](https://github.com/react-native-community/docker-android).
586
587Here are the steps to run React Native debugging inside a Docker Container on a real Android device:
588
5891. Open Command Palette and run the following command
590 ```
591 Remote-Containers: Add Development Container Configuration Files...
592 ```
593 Then select `Existing Dockerfile` to create `.devcontainer/devcontainer.json` configuration file.
5941. Сreate Dockerfile extending [reactnativecommunity/react-native-android image](https://hub.docker.com/r/reactnativecommunity/react-native-android). For example you can use the following Dockerfile:
595
596 ```
597 FROM reactnativecommunity/react-native-android:latest
598
599 RUN npm install -g expo-cli react-native-cli
600 ```
601
6021. Configure your `devcontainer.json` file as needed. Below is a sample configuration:
603
604 ```json
605 {
606 "name": "React Native Android Container",
607
608 // Sets the run context to one level up instead of the .devcontainer folder.
609 "context": "..",
610
611 // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
612 "dockerFile": "Dockerfile",
613
614 // The optional 'runArgs' property can be used to specify additional runtime arguments.
615 "runArgs": [
616 "--privileged", // give all capabilities to a container, in other words, the container can then do almost everything that the host can do
617 "--net",
618 "host", // forwarding all host machine ports
619 "-v",
620 "/dev/bus/usb:/dev/bus/usb" // mount connected USB devices to a container
621 ],
622
623 "settings": {
624 // This will ignore your local shell user setting for Linux since shells like zsh are typically
625 // not in base container images. You can also update this to an specific shell to ensure VS Code
626 // uses the right one for terminals and tasks. For example, /bin/bash (or /bin/ash for Alpine).
627 "terminal.integrated.shell.linux": null
628 },
629
630 // Add the IDs of extensions you want installed when the container is created in the array below.
631 "extensions": ["msjsdiag.vscode-react-native"]
632 }
633 ```
634
6351. Open Command Palette and run the following command `Remote-Containers: Open Folder in Container` to reopen your project in a container
6361. Connect your device via USB and start debugging the same way as on local machine.
637
638Currently the above scenario doesn't work on macOS and Windows. Docker Container implementation on these OS uses Virtual Machine tools which may have problems with USB forwarding for mobile devices.
639
640# Contributing
641
642Please see our [contributing guide](CONTRIBUTING.md) for more information.
643
644# Known Issues
645
646Here is the list of common known issues you may experience while using the extension:
647
648| Issue | Description |
649| ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
650| Debugger doesn't stop at breakpoints | Breakpoints require sourcemaps to be correctly configured. If you are using TypeScript, then make sure to follow the `Getting started` section for how to ensure sourcemaps are correctly set up. Also, similar issues may occur on React Native version `0.58.*` in some special cases (see [#928](https://github.com/microsoft/vscode-react-native/issues/928), [#907](https://github.com/microsoft/vscode-react-native/issues/907)), bumping dependencies versions of `react` and `react-native` package to the more recent ones should resolve these. |
651| 'adb: command not found' | If you receive an error `adb: command not found`, you need to update your system Path to include the location of your _ADB_ executable.The _ADB_ executable file is located in a subdirectory along with your other Android SDK files. |
652| Targeting iPhone 6 doesn't work | There was a known issue with React Native ([#5850](https://github.com/facebook/react-native/issues/5850)) but it was fixed. Please upgrade your version of React Native. |
653| Can't communicate with socket pipe | (Linux only) If you have two workspaces open that only differ in casing, the extension will fail to communicate effectively. |
654| "Add configuration" button doesn't work when trying to add debug configuration to `launch.json` | You have to add some json configuration to `launch.json` manually. Please, see ([#985](https://github.com/microsoft/vscode-react-native/issues/985)). |
655| Error `None of these files exist: * .vscode/exponentIndex` appears when running React Native apps via Expo | On some project configurations (mostly on macOS) there could be problems with running RN app via Expo for the first time. You can resolve this by explicitly adding `module.exports.watchFolders = ['.vscode'];` to your Metro config. This will help Metro bundler to find the custom entry point generated by the extension needed to work with Expo. For details you can see the issue ([#1327](https://github.com/microsoft/vscode-react-native/issues/1327)). |
656
657[Known-Issues](https://github.com/microsoft/vscode-react-native/issues?q=is%3Aissue+label%3Aknown-issues) provides a complete list of active and resolved issues.
658
659# Telemetry reporting
660
661VS Code React Native extension collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://www.visualstudio.com/en-us/dn948229) to learn more.
662
663If you don’t wish to send usage data to Microsoft, edit `VSCodeTelemetrySettings.json` file at `~/.vscode-react-native` and add `optIn:false`.
664
665# Code of conduct
666
667This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
668