2.6 KiB
How to debug BoostNote (Electron app)
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).
Debug with Google Chrome developer Tools
Boostnote is an Electron app so it's based on Chromium; developers can use Developer Tools just like Google Chrome.
You can toggle the Developer Tools like this:
The Developer Tools will look like this:
When errors occur, the error messages are displayed at the console.
Debugging
For example, you can use the debugger to set a breakpoint in the code like this:
This is just an illustrative example, you should find a way to debug which fits your style.
References
Debug with Visual Studio Code
-
Install Debugger for Chrome plugin for Visual Studio Code. Then restart it.
-
Pressing Shift+Command+B or running ** Run Build Task** from the global Terminal menu, then pick the task named Build Boostnote.
-
When above task is running, open Debug view in Activity Bar on the side of VS Code or use shortcut Shift+Command+D.
-
Select the configuration named Boostnote All from the Debug configuration, then click the green arrow button or press F5.
-
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.
References