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

Merge pull request #4004 from lukeapage/patch-3

Browse source 
Add info on how to debug from 0.30 onwards
This commit is contained in:
Cheng Zhao 2016-01-06 20:37:27 +08:00
commit aefddc0146
1 changed files with 31 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/tutorial/debugging-main-process.md
View file

@ -23,13 +23,30 @@ __Note:__ Electron doesn't currently work very well
with node-inspector, and the main process will crash if you inspect the
`process` object under node-inspector's console.
### 1. Start the [node-inspector][node-inspector] server
### 1. Make sure you have [node-gyp required tools][node-gyp-required-tools] installed
### 2. Install [node-inspector][node-inspector]
```bash
$ node-inspector
$ npm i node-inspector
```
### 2. Enable debug mode for Electron
### 3. Install a patched version of `node-pre-gyp`
```bash
$ npm i git+https://git@github.com/enlight/node-pre-gyp.git#detect-electron-runtime-in-find
```
### 4. Recompile the `node-inspector` `v8` modules for electron (change the target to your electron version number)
```bash
$ node_modules/.bin/node-pre-gyp --target=0.36.2 --runtime=electron --fallback-to-build --directory node_modules/v8-debug/ --dist-url=https://atom.io/download/atom-shell reinstall
$ node_modules/.bin/node-pre-gyp --target=0.36.2 --runtime=electron --fallback-to-build --directory node_modules/v8-profiler/ --dist-url=https://atom.io/download/atom-shell reinstall
```
See also [How to install native modules](how-to-install-native-modules).
### 5. Enable debug mode for Electron
You can either start Electron with a debug flag like:
@ -43,8 +60,17 @@ or, to pause your script on the first line:
$ electron --debug-brk=5858 your/app
```
### 3. Load the debugger UI
### 5. Start the [node-inspector][node-inspector] server using electron
Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser.
```bash
$ ATOM_SHELL_INTERNAL_RUN_AS_NODE=1 path/to/electron.exe node_modules/node-inspector/bin/inspector.js
```
### 6. Load the debugger UI
Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser. You may have to click pause if starting with debug-brk to see the entry line.
[node-inspector]: https://github.com/node-inspector/node-inspector
[node-gyp-required-tools]: https://github.com/nodejs/node-gyp#installation
[how-to-install-native-modules]: using-native-node-modules.md#how-to-install-native-modules