|
1 |
| -# How to debug Boostnote (Electron app) |
2 |
| -This page is also available in [Japanese](https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), [Korean](https://github.com/BoostIO/Boostnote/blob/master/docs/ko/debug.md), [Russain](https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), [Simplified Chinese](https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md), [French](https://github.com/BoostIO/Boostnote/blob/master/docs/fr/debug.md) and [German](https://github.com/BoostIO/Boostnote/blob/master/docs/de/debug.md). |
| 1 | +# How to debug BoostNote (Electron app) |
3 | 2 |
|
| 3 | +This page is also available in [Japanese](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/jp/debug.md), [Korean](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/ko/debug.md), [Russain](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/ru/debug.md), [Simplified Chinese](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/zh_CN/debug.md), [French](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/fr/debug.md) and [German](#)(https://github.com/BoostIO/Boostnote/blob/master/docs/de/debug.md). |
| 4 | + |
| 5 | +## Debug with Google Chrome developer Tools |
4 | 6 | Boostnote is an Electron app so it's based on Chromium; developers can use `Developer Tools` just like Google Chrome.
|
5 | 7 |
|
6 | 8 | You can toggle the `Developer Tools` like this:
|
7 |
| - |
| 9 | +(https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png) |
8 | 10 |
|
9 | 11 | The `Developer Tools` will look like this:
|
10 |
| - |
| 12 | +(https://cloud.githubusercontent.com/assets/11307908/24343545/eff9f3a6-127b-11e7-94cf-cb67bfda634a.png) |
11 | 13 |
|
12 | 14 | When errors occur, the error messages are displayed at the `console`.
|
13 | 15 |
|
14 |
| -## Debugging |
| 16 | +### Debugging |
15 | 17 | For example, you can use the `debugger` to set a breakpoint in the code like this:
|
16 | 18 |
|
17 |
| - |
| 19 | +(https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png) |
18 | 20 |
|
19 | 21 | This is just an illustrative example, you should find a way to debug which fits your style.
|
20 | 22 |
|
21 |
| -## References |
| 23 | +### References |
22 | 24 | * [Official document of Google Chrome about debugging](https://developer.chrome.com/devtools)
|
| 25 | + |
| 26 | +## Debug with Visual Studio Code |
| 27 | + |
| 28 | +1. Install **[Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome "Install Debugger for Chrome")** plugin for Visual Studio Code. Then restart it. |
| 29 | +2. Pressing **Shift+Command+B** or running ** Run Build Task** from the global **Terminal** menu, then pick the task named **Build Boostnote**. |
| 30 | +3. When above task is running, open **Debug view** in **Activity Bar** on the side of VS Code or use shortcut **Shift+Command+D**. |
| 31 | +4. Select the configuration named **Boostnote All** from the **Debug configuration**, then click the green arrow button or press **F5**. |
| 32 | +5. Now you should find **Boostnote** is running. You will see two process is running, one named **Boostnote Main**,other named **Boostnote Renderer**. Now you can set **debug breakpoint** in vscode. If you find **breakpoints** is unverified, you need to switch process. |
| 33 | + |
| 34 | + ### References |
| 35 | + * [Electron application debugging](https://electronjs.org/docs/tutorial/application-debugging) |
| 36 | + * [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) |
0 commit comments