Proposal: Integrate or Support External GDScript Formatters in Godot-IDE

[kyrosle]

Summary

Godot 4.5 has improved the script editing experience but still lacks a built-in code formatter. To unify code style and improve readability, I propose integrating or supporting external GDScript formatters in Godot-IDE.

Candidate solutions (simple comparison)

• gdtoolkit（gdformat）

  • Advantages: old-fashioned tools, stability, easy installation of pip, uniform style.
  • Disadvantages: Python dependency, high integration cost; slow update, occasional syntax corner issues; few configuration items.

• GDQuest's Tree-Sitter Formatter

  • Advantages: Rust implementation, fast; support for organizing according to the official style, with indentation; multi-platform binary, low integration threshold; active projects.
  • Weaknesses: Still being refined, some syntax omissions; custom rules require knowledge of Tree/Sitter queries.

Want to ask for advice

1. Integration method: Which one is more suitable to support first? Or support both and choose for the user?
2. Dependencies and Compatibility: Is it possible to call external executables directly? Is it necessary to provide path/parameter configuration in the plugin?
3. Experience: Supports automatic formatting when commands/shortcuts/saves, which is more commonly used? Do you need "select area format only" and change preview?

My initial idea (minimal implementation)

• Add the "Format Document" action to the editor.
• The optional formatter and executable file path in the settings provide basic parameters (such as indentation, length).
• Optional "Auto-format when saving" (off by default).
• When an error occurs, a prompt is given without damaging the file content.

[CodeNameTwister]

This repository allows formatting without external dependencies:
simple_gdscript_formatter

First, take a look at that repository. If it meets your expectations, you'll have a base code for continue or code references to begin with you custom code.

If you use part of the code in that repository, remember to credit the author.

Finally, two things are worth noting:

1. For users, the simplest option is always the best.

2. If it's possible and convenient to implement features in GDScript, it's better to use GDScript.

If some functions can't be implemented with GDScript, the GDExtension should be used.

In this case, it seems there is a hero without a cape who has worked in the gdscript format without external dependencies.

[kyrosle]

I have an idea, is it possible to integrate the formatting tool for this extra command, develop path and arg

[CodeNameTwister]

Yeah, you can experiment and modify the plugin as you like.

Examples of my experiments to add functionality are in:

• Macro-N: Selection of region code.
• Tab in top bar on editor script.
• Shortcuts.

The one I haven't used is the command palette. Here it is.

Command Palette

    script_editor = EditorInterface.get_script_editor()
    command_palette = editor_interface.get_command_palette()
    
    # add commands

    command_palette.add_command(
        "Command Name",
       "path_of_command", # Example "script_text_editor/command_name"
        custom_func_callback
    )

    # For Exit
    command_palette.remove_command("path_of_command")

Tab in top bar on editor script. example: