mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: Add chapter on debugging with node-inspector.

Browse source
This commit is contained in:
Cheng Zhao 2014-08-20 10:43:41 +08:00
parent 6e3b3fa5a2
commit fecc90e67c
1 changed files with 36 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
docs/tutorial/debugging-browser-process.md
View file

@ -5,11 +5,45 @@ The devtools of browser window can only debug the scripts of the web pages
the browser side (e.g. the browser process), atom-shell has provided the the browser side (e.g. the browser process), atom-shell has provided the
`--debug` and `--debug-brk` switches. `--debug` and `--debug-brk` switches.
## `--debug=[port]` ## Command line switches
### `--debug=[port]`
When this switch is used atom-shell would listen for V8 debugger protocol on When this switch is used atom-shell would listen for V8 debugger protocol on
`port`, the `port` is `5858` by default. `port`, the `port` is `5858` by default.
## `debug-brk=[port]` ### `debug-brk=[port]`
Like `--debug` but pauses the script on the first line. Like `--debug` but pauses the script on the first line.
## Use node-inspector for debugging
__Note:__ Atom Shell uses node v0.11.13, which currently doesn't work very well
with node-inspector, and the browser process would crash if you inspect the
`process` object under node-inspector's console.
### 1. Start the [node-inspector](node-inspector) server
```bash
$ node-inspector
```
### 2. Enable debug mode for atom-shell
You can either start atom-shell with a debug flag like:
```bash
$ atom-shell --debug your/app
```
or, to pause your script on the first line:
```bash
$ atom-shell --debug-brk your/app
```
### 3. Load the debugger UI
Open http://127.0.0.1:8080/debug?port=5858 in the Chrome browser.
[node-inspector](https://github.com/node-inspector/node-inspector)