Skip to content

Commit

Permalink
Update documentation for current new feature (#1976)
Browse files Browse the repository at this point in the history
  • Loading branch information
@EzioLi01
EzioLi01 committed Jun 15, 2023
1 parent 6577398 commit 3486c4f
Showing 1 changed file with 28 additions and 24 deletions.
52 changes: 28 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,30 +90,33 @@ The **Packager** commands allow you to start/stop the [**Metro Bundler**](https:

The full list of commands is:

| Name | Command ID | Description |
| ------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Launch Android Emulator | `reactNative.launchAndroidSimulator` | Prompts you to select the name of the available Android emulator and launch it. If only one emulator is installed in the system, it will be selected automatically |
| Launch iOS Simulator | `reactNative.launchIOSSimulator` | Prompts you to select the available system version of the iOS simulator, then select the simulator name for the selected system and launch it. If only one simulator is installed in the system, it will be selected automatically |
| Run Android on Emulator | `reactNative.runAndroidSimulator` | Run an Android application on Emulator. Launch order: check target platform support, load run arguments, start Packager, run app on the selected emulator. Make sure the `emulator` utility is added to `PATH` |
| Run Android on Device | `reactNative.runAndroidDevice` | Run an Android application on Device. Launch order: check target platform support, load run arguments, start Packager, run app in all connected devices |
| Run iOS on Simulator | `reactNative.runIosSimulator` | Run an iOS application on Simulator. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected emulator |
| Run iOS on Device | `reactNative.runIosDevice` | Run an iOS application on Device. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected device |
| Run Expo | `reactNative.runExponent` | Run an Exponent application. Launch order: login to exponent, load run arguments, start Packager, run app |
| Run Windows | `reactNative.runWindows` | Run a RNW application. Launch order: check target platform support, load run arguments, start Packager, run app |
| Run MacOS | `reactNative.runMacOS` | Run a RNmacOS application. Launch order: check target platform support, load run arguments, start Packager, run app |
| Start Packager | `reactNative.startPackager` | Start Packager in context project workspace folder |
| Stop Packager | `reactNative.stopPackager` | Stop Packager |
| Restart Packager | `reactNative.restartPackager` | Restart Packager and clear the Packager's cache |
| Publish To Expo | `reactNative.publishToExpHost` | Publish to Exponent Host. Launch order: login to exponent, execute `Run Expo` command, then publish app to host |
| Show Dev Menu | `reactNative.showDevMenu` | Show development menu for running aplication on iOS or Android device or emulator |
| ReloadApp | `reactNative.reloadApp` | Reload an application |
| Run Element Inspector | `reactNative.runInspector` | Load development tools for inspect application UI elements |
| Stop Element Inspector | `reactNative.stopInspector` | Stop development tools for inspect application UI elements |
| Run React Native LogCat Monitor | `reactNative.startLogCatMonitor` | Creates a LogCat Monitor for the chosen online Android device to see the device LogCat logs. Default filtering arguments: ["*:S", "ReactNative:V", "ReactNativeJS:V"]. [How to configure filtering.](#configure-an-Android-LogCat-Monitor) |
| Stop React Native LogCat Monitor | `reactNative.stopLogCatMonitor` | Stops an existing LogCat Monitor and removes its output channel |
| Run Network Inspector | `reactNative.startNetworkInspector` | Run [Network inspector](#network-inspector) |
| Stop Network Inspector | `reactNative.stopNetworkInspector` | Stop [Network inspector](#network-inspector) |
| Check development environment configuration | `reactNative.testDevEnvironment` | Checks your development environment for common problems |
| Name | Command ID | Description |
| --------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Launch Android Emulator | `reactNative.launchAndroidSimulator` | Prompts you to select the name of the available Android emulator and launch it. If only one emulator is installed in the system, it will be selected automatically |
| Launch iOS Simulator | `reactNative.launchIOSSimulator` | Prompts you to select the available system version of the iOS simulator, then select the simulator name for the selected system and launch it. If only one simulator is installed in the system, it will be selected automatically |
| Run Android on Emulator | `reactNative.runAndroidSimulator` | Run an Android application on Emulator. Launch order: check target platform support, load run arguments, start Packager, run app on the selected emulator. Make sure the `emulator` utility is added to `PATH` |
| Run Android on Device | `reactNative.runAndroidDevice` | Run an Android application on Device. Launch order: check target platform support, load run arguments, start Packager, run app in all connected devices |
| Run iOS on Simulator | `reactNative.runIosSimulator` | Run an iOS application on Simulator. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected emulator |
| Run iOS on Device | `reactNative.runIosDevice` | Run an iOS application on Device. Launch order: load run arguments, check target platform support, start Packager, run app in only one connected device |
| Run Expo | `reactNative.runExponent` | Run an Exponent application. Launch order: login to exponent, load run arguments, start Packager, run app |
| Run Windows | `reactNative.runWindows` | Run a RNW application. Launch order: check target platform support, load run arguments, start Packager, run app |
| Run MacOS | `reactNative.runMacOS` | Run a RNmacOS application. Launch order: check target platform support, load run arguments, start Packager, run app |
| Start Packager | `reactNative.startPackager` | Start Packager in context project workspace folder |
| Stop Packager | `reactNative.stopPackager` | Stop Packager |
| Restart Packager | `reactNative.restartPackager` | Restart Packager and clear the Packager's cache |
| Publish To Expo | `reactNative.publishToExpHost` | Publish to Exponent Host. Launch order: login to exponent, execute `Run Expo` command, then publish app to host |
| Show Dev Menu | `reactNative.showDevMenu` | Show development menu for running aplication on iOS or Android device or emulator |
| ReloadApp | `reactNative.reloadApp` | Reload an application |
| Run Element Inspector | `reactNative.runInspector` | Load development tools for inspect application UI elements |
| Stop Element Inspector | `reactNative.stopInspector` | Stop development tools for inspect application UI elements |
| Run React Native LogCat Monitor | `reactNative.startLogCatMonitor` | Creates a LogCat Monitor for the chosen online Android device to see the device LogCat logs. Default filtering arguments: ["*:S", "ReactNative:V", "ReactNativeJS:V"]. [How to configure filtering.](#configure-an-Android-LogCat-Monitor) |
| Stop React Native LogCat Monitor | `reactNative.stopLogCatMonitor` | Stops an existing LogCat Monitor and removes its output channel |
| Run Network Inspector | `reactNative.startNetworkInspector` | Run [Network inspector](#network-inspector) |
| Stop Network Inspector | `reactNative.stopNetworkInspector` | Stop [Network inspector](#network-inspector) |
| Check development environment configuration | `reactNative.testDevEnvironment` | Checks your development environment for common problems |
| Open the eas project in a web page | `reactNative.openEASProjectInWebPage` | Open EAS build in your EAS project portal |
| Open react native upgrade helper in web page | `reactNative.openRNUpgradeHelper` | Open an official project upgrade tools in browser, support RN, RN for Windows, RN for MacOS |
| Revert extension input in open package module | `reactNative.revertOpenModule` | Quickly revert some codes in Open Module which are changed by react-native-tools |

## Using commands in VS Code tasks

Expand Down Expand Up @@ -565,6 +568,7 @@ The following is a list of all the configuration properties the debugger accepts
| `variant` | A variant to be passed to `react-native run-android`, e.g. use `devDebug` to specify `--variant=devDebug` | `string` | n/a |
| `scheme` | A scheme name to be passed to `react-native run-ios`, e.g. `devDebug` to specify `--scheme=devDebug` | `string` | n/a |
| `productName` | iOS bundle display name e.g. `AwesomeProject` value means that the extension will search for `AwesomeProject.app` bundle | `string` | n/a |
| `jsDebugTrace` | Enable trace collection for depended extension `vscode-js-debug` | `boolean` | n/a |

# Customization

Expand Down

0 comments on commit 3486c4f

Please sign in to comment.