mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-24 10:27:10 +02:00
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
|
# Debugging Server project with vscode
|
||
|
|
|
||
|
|
Using a debugger sometimes is much easier than trying to just print things to understand a bug,
|
||
|
|
for the server project we have a configuration that makes it easy for everyone to run in debug mode inside vscode.
|
||
|
|
|
||
|
|
In the debug screen you can select "Server" and hit the play button to start the process.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Before running the server there is a task called `transpile-server` that runs `yarn tsc` to make sure that the
|
||
|
|
latest changes in the `package/server` are being executed.
|
||
|
|
|
||
|
|
https://github.com/laurent22/joplin/blob/4f37e6073ad549fe72206e2a125c27174b5d96a9/joplin.code-workspace#L360-L365
|
||
|
|
|
||
|
|
In a optimal solution we would be doing this `transpile-server` task in the `tasks.json` file
|
||
|
|
(inside the `tasks.json` we can use a `type` `npm` for the task that is more ergonomic)
|
||
|
|
|
||
|
|
If there are any new environment variables that need to be included before execution, there is a place where they can be added:
|
||
|
|
|
||
|
|
https://github.com/laurent22/joplin/blob/4f37e6073ad549fe72206e2a125c27174b5d96a9/joplin.code-workspace#L387-L391
|
||
|
|
|
||
|
|
Something that we could do to improve the experience is adding a build process to other projects that are used by the server project,
|
||
|
|
but this still can be done with other terminals open.
|
||
|
|
|
||
|
|
### Modifying the configuration:
|
||
|
|
|
||
|
|
To modify the configuration, for now, it is all in the `joplin.code-workspace` file, but if needed we could also break
|
||
|
|
the configuration into two files, one for the `launch.json` and other for the `tasks.json`.
|
||
|
|
|
||
|
|
|
||
|
|
### References:
|
||
|
|
[vscode debugger](https://code.visualstudio.com/docs/editor/debugging)
|
||
|
|
|
||
|
|
[Launch option to vscode workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_debugging)
|
||
|
|
|
||
|
|
[vscode tasks](https://code.visualstudio.com/docs/editor/tasks)
|
||
|
|
|
||
|
|
|
||
|
|
### More images:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|