forked from obsidian-tasks-group/obsidian-tasks
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
contrib: Add a page about debugging and performance tools
Credit: @Fevol
- Loading branch information
1 parent
f79220f
commit 75900e6
Showing
4 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,16 @@ | ||
# Debugging | ||
|
||
<span class="related-pages">#debugging</span> | ||
|
||
## Future Plans | ||
|
||
This section is intended to document how to place debugger breakpoints in the Tasks code, so that the behaviour can be inspected at run-time. | ||
|
||
## Current Content | ||
|
||
- [[Console logging facilities in Tasks]] | ||
- About the Tasks plugin's logging mechanism. | ||
- [[How do I enable hidden debugging and visualisation facilities]] | ||
- Enabling some debug rendering options in Tasks. | ||
- [[Debugging and Performance tools]] | ||
- Excellent guidance on debugging and profiling plugins. |
6 changes: 6 additions & 0 deletions
6
contributing/Debugging/Console logging facilities in Tasks.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
publish: true | ||
--- | ||
|
||
# Debugging and Performance tools | ||
|
||
<span class="related-pages">#debugging</span> | ||
|
||
## Useful resources for debugging Obsidian plugins | ||
|
||
From user Fevol in [Discord](https://discord.com/channels/686053708261228577/840286264964022302/1171115922266800188): | ||
|
||
> [!Quote] | ||
> The link below gives a short introduction to the debugging tools and code performance analyis tools available in Obsidian. It teaches you: | ||
> | ||
> Debugging: | ||
> | ||
> - [how to debug your code with the debugger tool](https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42#debugging-your-code) | ||
> | ||
> Performance: | ||
> | ||
> - [how to time the execution of your code](https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42#timing-your-code) | ||
> - [how to create flame charts](https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42#flame-charts-firechart_with_upwards_trend) | ||
> - [how to interpret flame charts to evaluate performance](https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42#interpreting-your-flame-chart) | ||
> | ||
> (Suggestions, PR's, etc. are very welcome) [https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42](https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42 "https://gist.github.com/Fevol/b672865d61e54ac6f61e7c88aa05ba42") |
2 changes: 2 additions & 0 deletions
2
...ting/Debugging/How do I enable hidden debugging and visualisation facilities.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters