Skip to content

Commit ab46845

Browse files
hramosFacebook Github Bot 5
authored andcommitted
Accessing console logs
Summary: Instructions for accessing the output of a `console.log`. ![debugging](https://cloud.githubusercontent.com/assets/165856/16318119/7aff884e-3942-11e6-9a78-853aaba68308.png) Closes #8323 Differential Revision: D3480718 Pulled By: JoelMarcey fbshipit-source-id: 4185d2e730277b8ad986d3c8904420e7ae1ceb21
1 parent 82b99a1 commit ab46845

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

docs/Debugging.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,30 @@ next: testing
99

1010
## Accessing the In-App Developer Menu
1111

12-
You can access the developer menu by shaking your device or by selecting "Shake Gesture" inside the Hardware menu in the iOS Simulator. You can also use the `Command + D` keyboard shortcut when your app is running in the iPhone Simulator, or `Command + M` when running in an Android emulator.
12+
You can access the developer menu by shaking your device or by selecting "Shake Gesture" inside the Hardware menu in the iOS Simulator. You can also use the **`Command`**`` + **`D`** keyboard shortcut when your app is running in the iPhone Simulator, or **`Command`**`` + **`M`** when running in an Android emulator.
1313

1414
![](img/DeveloperMenu.png)
1515

1616
> The Developer Menu is disabled in release (production) builds.
1717
1818
## Reloading JavaScript
1919

20-
Selecting `Reload` from the Developer Menu will reload the JavaScript that powers your application. You can also press `Command + R` in the iOS Simulator, or press `R` twice on Android emulators.
20+
Instead of recompiling your app every time you make a change, you can reload your app's JavaScript code instantly. To do so, select "Reload" from the Developer Menu. You can also press **`Command`**`` + **`R`** in the iOS Simulator, or press **`R`** twice on Android emulators.
2121

22-
> If you are using a Dvorak/Colemak layout, use the `Command + P` keyboard shortcut to reload the simulator.
22+
> If the **`Command`**`` + **`R`** keyboard shortcut does not seem to reload the iOS Simulator, go to the Hardware menu, select Keyboard, and make sure that "Connect Hardware Keyboard" is checked.
2323
24-
You will need to rebuild your app for changes to take effect in certain situations:
24+
### Automatic reloading
2525

26-
* You have added new resources to your native app's bundle, such as an image in `Images.xcassets` on iOS or in `res/drawable` folder on Android.
27-
* You have modified native code (Objective-C/Swift on iOS or Java/C++ on Android).
26+
You can speed up your development times by having your app reload automatically any time your code changes. Automatic reloading can be enabled by selecting "Enable Live Reload" from the Developer Menu.
2827

29-
> If the `Command⌘ + R` keyboard shortcut does not seem to reload the iOS Simulator, go to the Hardware menu, select Keyboard, and make sure that "Connect Hardware Keyboard" is checked.
28+
You may even go a step further and keep your app running as new versions of your files are injected into the JavaScript bundle automatically by enabling [Hot Reloading](https://facebook.github.io/react-native/blog/2016/03/24/introducing-hot-reloading.html) from the Developer Menu. This will allow you to persist the app's state through reloads.
3029

31-
### Automatic reloading
30+
> There are some instances where hot reloading cannot be implemented perfectly. If you run into any issues, use a full reload to reset your app.
3231
33-
You may enable Live Reload to automatically trigger a reload whenever your JavaScript code changes.
32+
You will need to rebuild your app for changes to take effect in certain situations:
3433

35-
Live Reload is available on iOS via the Developer Menu. On Android, select "Dev Settings" from the Developer Menu and enable "Auto reload on JS change".
34+
* You have added new resources to your native app's bundle, such as an image in `Images.xcassets` on iOS or the `res/drawable` folder on Android.
35+
* You have modified native code (Objective-C/Swift on iOS or Java/C++ on Android).
3636

3737
## In-app Errors and Warnings
3838

@@ -52,41 +52,46 @@ YellowBoxes can be disabled during development by using `console.disableYellowBo
5252

5353
> RedBoxes and YellowBoxes are automatically disabled in release (production) builds.
5454
55-
## Accessing logs
55+
## Accessing console logs
5656

57-
Run `react-native log-ios` in a terminal to display the logs for an iOS app running on a device or a simulator.
57+
You can display the console logs for an iOS or Android app by using the following commands in a terminal while the app is running:
5858

59-
You can also view the iOS logs in Xcode: open your app in Xcode, then Build and Run your app on a device or the iPhone Simulator. The console should appear automatically after the app launches. If your app is failing to build, check the Issues Navigator in Xcode.
59+
```
60+
$ react-native log-ios
61+
$ react-native log-android
62+
```
6063

61-
Run `react-native log-android` in a terminal to display the logs for an Android app running on a device or an emulator.
64+
You may also access these through `Debug → Open System Log...` in the iOS Simulator or by running `adb logcat *:S ReactNative:V ReactNativeJS:V` in a terminal while an Android app is running on a device or emulator.
6265

6366
## Chrome Developer Tools
6467

65-
To debug the JavaScript code in Chrome, select `Debug JS Remotely` from the Developer Menu. This will open a new tab at [http://localhost:8081/debugger-ui](http://localhost:8081/debugger-ui).
68+
To debug the JavaScript code in Chrome, select "Debug JS Remotely" from the Developer Menu. This will open a new tab at [http://localhost:8081/debugger-ui](http://localhost:8081/debugger-ui).
6669

67-
In Chrome, press `Command + Option + I` or select `View``Developer``Developer Tools` to toggle the developer tools console. Enable [Pause On Caught Exceptions](http://stackoverflow.com/questions/2233339/javascript-is-there-a-way-to-get-chrome-to-break-on-all-errors/17324511#17324511) for a better debugging experience.
70+
Select `Tools → Developer Tools` from the Chrome Menu to open the [Developer Tools](https://developer.chrome.com/devtools). You may also access the DevTools using keyboard shortcuts (**`Command`**`` + **`Option`**`` + **`I`** on Mac, **`Ctrl`** + **`Shift`** + **`I`** on Windows). You may also want to enable [Pause On Caught Exceptions](http://stackoverflow.com/questions/2233339/javascript-is-there-a-way-to-get-chrome-to-break-on-all-errors/17324511#17324511) for a better debugging experience.
6871

6972
> It is [currently not possible](https://github.com/facebook/react-devtools/issues/229) to use the "React" tab in the Chrome Developer Tools to inspect app widgets. You can use Nuclide's "React Native Inspector" as a workaround.
7073
7174
### Debugging on a device with Chrome Developer Tools
7275

73-
On iOS devices, open the file [`RCTWebSocketExecutor.m`](https://github.com/facebook/react-native/blob/master/Libraries/WebSocket/RCTWebSocketExecutor.m) and change `localhost` to the IP address of your computer, then select `Debug JS Remotely` from the Developer Menu.
76+
On iOS devices, open the file [`RCTWebSocketExecutor.m`](https://github.com/facebook/react-native/blob/master/Libraries/WebSocket/RCTWebSocketExecutor.m) and change "localhost" to the IP address of your computer, then select "Debug JS Remotely" from the Developer Menu.
7477

7578
On Android 5.0+ devices connected via USB, you can use the [`adb` command line tool](http://developer.android.com/tools/help/adb.html) to setup port forwarding from the device to your computer:
7679

7780
`adb reverse tcp:8081 tcp:8081`
7881

79-
Alternatively, select `Dev Settings` from the Developer Menu, then update the `Debug server host for device` setting to match the IP address of your computer.
82+
Alternatively, select "Dev Settings" from the Developer Menu, then update the "Debug server host for device" setting to match the IP address of your computer.
8083

8184
> If you run into any issues, it may be possible that one of your Chrome extensions is interacting in unexpected ways with the debugger. Try disabling all of your extensions and re-enabling them one-by-one until you find the problematic extension.
8285
8386

8487
### Debugging using a custom JavaScript debugger
8588

86-
To use a custom JavaScript debugger in place of Chrome Developer Tools, set the `REACT_DEBUGGER` environment variable to a command that will start your custom debugger. You can then select `Debug JS Remotely` from the Developer Menu to start debugging.
89+
To use a custom JavaScript debugger in place of Chrome Developer Tools, set the `REACT_DEBUGGER` environment variable to a command that will start your custom debugger. You can then select "Debug JS Remotely" from the Developer Menu to start debugging.
90+
91+
The debugger will receive a list of all project roots, separated by a space. For example, if you set `REACT_DEBUGGER="node /path/to/launchDebugger.js --port 2345 --type ReactNative"`, then the command `node /path/to/launchDebugger.js --port 2345 --type ReactNative /path/to/reactNative/app` will be used to start your debugger.
8792

88-
> The debugger will receive a list of all project roots, separated by a space. For example, if you set `REACT_DEBUGGER="node /path/to/launchDebugger.js --port 2345 --type ReactNative"`, then the command `node /path/to/launchDebugger.js --port 2345 --type ReactNative /path/to/reactNative/app` will be used to start your debugger. Custom debugger commands executed this way should be short-lived processes, and they shouldn't produce more than 200 kilobytes of output.
93+
> Custom debugger commands executed this way should be short-lived processes, and they shouldn't produce more than 200 kilobytes of output.
8994
90-
## FPS (Frames per Second) Monitor
95+
## Performance Monitor
9196

92-
You can enable a FPS graph overlay in the Developer Menu in order to help you debug performance problems.
97+
You can enable a performance overlay to help you debug performance problems by selecting "Perf Monitor" in the Developer Menu.

0 commit comments

Comments
 (0)