762a5bbefa
- Move the debugging guides for VSCode and node-inspector into separate files. - Add instructions for using electron-inspector to the node-inspector guide. - Remove note in node-inspector guide about crashing when inspecting `process` (it was fixed a long time ago: https://github.com/nodejs/node-v0.x-archive/issues/8205)
34 lines
1 KiB
Markdown
34 lines
1 KiB
Markdown
# Debugging the Main Process in VSCode
|
|
|
|
### 1. Open an Electron project in VSCode.
|
|
|
|
```bash
|
|
$ git clone git@github.com:electron/electron-quick-start.git
|
|
$ code electron-quick-start
|
|
```
|
|
|
|
### 2. Add a file `.vscode/launch.json` with the following configuration:
|
|
|
|
```json
|
|
{
|
|
"version": "0.2.0",
|
|
"configurations": [
|
|
{
|
|
"name": "Debug Main Process",
|
|
"type": "node",
|
|
"request": "launch",
|
|
"cwd": "${workspaceRoot}",
|
|
"runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
|
|
"program": "${workspaceRoot}/main.js"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**Note:** For Windows, use `"${workspaceRoot}/node_modules/.bin/electron.cmd"` for `runtimeExecutable`.
|
|
|
|
### 3. Debugging
|
|
|
|
Set some breakpoints in `main.js`, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging). You should be able to hit the breakpoints.
|
|
|
|
Here is a pre-configured project that you can download and directly debug in VSCode: https://github.com/octref/vscode-electron-debug/tree/master/electron-quick-start
|