microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
README.md
94lines · modecode
| 1 | # React Native Tools |
| 2 | [](https://travis-ci.org/Microsoft/vscode-react-native) |
| 3 | |
| 4 | This extension provides a development environment for React Native projects. |
| 5 | Using this extension, you can debug your code, quickly run `react-native` commands from the command palette, and use IntelliSense to browse objects, functions and parameters for React Native APIs. |
| 6 | |
| 7 |  |
| 8 | |
| 9 | ## Getting started |
| 10 | |
| 11 | * [Install VS Code](https://code.visualstudio.com). |
| 12 | * [Install the extension](https://code.visualstudio.com/docs/editor/extension-gallery) in VS Code: |
| 13 | 1. Press `Ctrl + Shift + X` (`Cmd + Shift + X` on macOS), wait a moment while the list of available extensions is populated |
| 14 | 2. Type `react-native` and install **React Native Tools** |
| 15 | 3. For more guidance view [VS Code Extension Gallery](https://code.visualstudio.com/docs/editor/extension-gallery) |
| 16 | * If you haven't already, install React Native: |
| 17 | 1. Run `npm install -g react-native-cli` to install React Native CLI |
| 18 | 2. Set up React Native using the steps detailed on the React Native [getting started documentation ](https://facebook.github.io/react-native/docs/getting-started.html) |
| 19 | * Open your React Native project root folder in VS Code. |
| 20 | |
| 21 | Please 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. |
| 22 | |
| 23 | ## Debugging React Native applications |
| 24 | |
| 25 | Click the debug icon  in the View bar, and then click the configuration (gear) icon , then choose the React Native debug environment. |
| 26 | |
| 27 |  |
| 28 | |
| 29 | VS 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_  button) to start debugging your app in VS Code. |
| 30 | |
| 31 |  |
| 32 | |
| 33 | You can debug your app on an Android emulator, Android device or iOS simulator. This extension provides [experimental support](doc/debugging.md#debugging-on-ios-device) for iOS devices. |
| 34 | |
| 35 | More information about debugging using VS Code can be found in this [guide](https://code.visualstudio.com/docs/editor/debugging). |
| 36 | |
| 37 | See [Setting up debug environment](doc/debugging.md) for more details. |
| 38 | |
| 39 | ## Using React Native commands in the Command Palette |
| 40 | |
| 41 | In the Command Palette, type `React Native` and choose a command. |
| 42 | |
| 43 |  |
| 44 | |
| 45 | The **Run Android** command triggers `react-native run-android` and starts your app for Android. |
| 46 | |
| 47 | The **Run iOS** command similarly triggers `react-native run-ios` and starts your app in the iOS simulator (iPhone 6). |
| 48 | |
| 49 | The **Packager** commands allow you to start/stop the [**Metro Bundler**](https://github.com/facebook/metro-bundler) (formerly React Packager). |
| 50 | |
| 51 | ## Using IntelliSense |
| 52 | |
| 53 | IntelliSense helps you discover objects, functions, and parameters in React Native. |
| 54 | |
| 55 |  |
| 56 | |
| 57 | IntelliSense is enabled automatically once you open the project in VS Code, so no additional action is required. Notice that in order to set it up, the extension might create a `jsconfig.json` file (if no such file exists) in the project root with `allowJs: true` to allow TypeScript to process JavaScript files. |
| 58 | |
| 59 | See also [Setting up Flowtype for IntelliSense](doc/intellisense.md) for more advanced setup. |
| 60 | |
| 61 | ## Using Expo |
| 62 | |
| 63 | We support using exponentjs to run, debug and publish applications. For more information on exponent, see [here](https://docs.getexponent.com/). |
| 64 | |
| 65 | For more details about configuring and debugging Expo applications see [Expo docs](doc/expo.md) |
| 66 | |
| 67 | ## Build APK and Generate Bundle |
| 68 | |
| 69 | You can add VSCode tasks to build an .apk file and generate iOS/Android bundles. See [here](doc/tasks.md) for more info. |
| 70 | |
| 71 | ## Contributing |
| 72 | |
| 73 | Please see our [contributing guide](CONTRIBUTING.md) for more information |
| 74 | |
| 75 | ## Known Issues |
| 76 | |
| 77 | Here is the list of common known issues you may experience while using the extension: |
| 78 | |
| 79 | Issue | Description |
| 80 | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| 81 | 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. |
| 82 | '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. |
| 83 | 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. |
| 84 | Can't comunicate with socket pipe | (Linux only) If you have two workspaces open that only differ in casing, the extension will fail to comunicate effectively. |
| 85 | |
| 86 | [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. |
| 87 | |
| 88 | ## Telemetry reporting |
| 89 | VS 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. |
| 90 | |
| 91 | If you don’t wish to send usage data to Microsoft, edit `VSCodeTelemetrySettings.json` file at `~/.vscode-react-native` and add `optIn:false`. |
| 92 | |
| 93 | ## Code of conduct |
| 94 | This 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. |
| 95 | |