Debug plugins with a log file

• Mar 3, 2023 - 09:08

We cant use console.log anymore, so i needed a tool to display log messages.
For that i created a component named DebugTools.

Usage :
1)add the component in the plugin directory (documents/musescore4/plugins/mplugin)
2)Add the reference part in your main plugin.
3)Use the methods
This was written for MS4 but could be easily adapted to other versions.

I use that tools also to dump different objects (segment, element ,..) but this is another story !

Attachment	Size
DebugTools1.PNG	58.26 KB
DebugTools2.PNG	50.19 KB
Modele.PNG	26.24 KB

Comments

elsewhere

• Mar 3, 2023 - 10:59

Please share the qml file

dominiqueverriere

• Mar 4, 2023 - 06:44

That's done
https://musescore.org/en/project/debugtools-using-log-file-debug-plugins

elsewhere

• Mar 4, 2023 - 07:33

Many Thanks

parkingb

• Mar 7, 2023 - 22:06

Nice one. Thanks for sharing it. Helpful for porting MS3 plugin's to MS4.

parkingb

• Mar 7, 2023 - 22:28

Little suggestion. The console object has other interesting log methods such as trace, warn and error.
This could be nice to have similar functions in you Item.
That way the info written to the file could be prefixed with the level of the debug (similar to the PatternLayout of Log4j):

[TRACE] Culpa occaecati rerum optio qui. 
Et doloremque voluptas et eligendi aperiam. 
[WARN] Fugiat molestiae voluptas qui voluptatem aperiam.
[ERROR] Et aut distinctio officiis. Ut consequatur quaerat et quisquam.

dominiqueverriere

• Mar 8, 2023 - 07:01

Yes very good idea, i m still writing these tools, i could share the appends i did (exceptions management, stack trace, dump segments and elements)
It will take some time as i m really in the begin of investigations of these tools.

parkingb

• Mar 8, 2023 - 09:52

The only part I'm doubtful it will work is using this approach for logging in separated ".js" files.
I put most of my plugin code in external javascript files that I can reuse across all my plugin(*)
I wonder if I could manage to access that debugTools item from those javascript libraries...
I'll have a try.

(*): That I call with qml statements such as
import "selectionhelper.js" as SelHelper
and then calls such as
var chords = SelHelper.getChordsFromCursor(curScore)