Godot add-on: Add support for formatting built-in sripts

[NicholasBolen]

Currently, attempting to format/re-order on a built-in script causes errors.

Would love to see support for this, though I'm unsure how challenging it might be to implement.

[NathanLovato]

It's most likely possible, and probably not too hard given Godot's API. I'll leave it up as something for potential contributors to pick up if they'd like.

[T3kla]

First time using Godot here! After finding out that Godot does not have an auto-formatter, I downloaded this one and then stumbled upon this problem.

Got the thing working for .tscn except the ResourceSaver.save(script) part activating when auto-save is on, since it assumes the file is a script and it's not. Will solve soon.

My issue is that I don't understand the format structure and I don't know which formats I have to support (important because they have some internal differences apparently). I found that there are .tscn, .scn, .tres and .res. I understand that some are text and some are binary, but I can not find an official list of formats and what do they do.

As far as I know, they both use the node system so I don't immediately understand the difference, and I don't if I'm missing additional types. I also don't understand the purpose of allowing .res or .scn inside the editor since the documentation states that they exists just for optimizing builds, so they should not even be visible for devs.

Anyway, I'm working on it. Will only work for .tscn and .tres tho!

[NathanLovato]

@T3kla Thank you for looking into this! I'd say you can restrict the feature to just TSCN files, which stands for text scene files. Those should be the ones normally where people would largely use the built-in script feature. As far as I know, built-in scripts are a feature of scenes.

If you need a hand at any point, don't hesitate to open a draft pull request. I haven't looked into how to make this work. I suppose you have to:

• Get access to the script code within the loaded/open scene.
• Format it and replace the script code in memory.
• Tell Godot to save the entire scene (which includes the script).

Perhaps the last step is not necessary, but basically you just have to make sure that it preserves the formatted code.

I don't know if there is a user-facing API to make that easy. Scenes, once loaded in memory, work as a sort of big dictionary that bundles all kinds of information about the scene. And one way to access the scene data and its sub-resources, like the script, is walking through this dictionary. But perhaps you can get the actual script resource directly from the script editor through the editor plugin API.

PS: I hope you'll excuse the reply delay. I've been busy with helping Godot on the 4.6 release page and then updating our entire curriculum to 4.6. I have timeframes where I'm available and other timeframes when I'm not to work on these open source projects.

[T3kla]

Thanks for the info! I had some times constrains on my side too and had to drop learning Godot for the time being. I will return to this early March tho.