Plugin doesn't see gdformat installed in `/opt/homebrew/bin` (formerly "My GDScript file does not get formatted on save")

[beetrootpaul]

Hey, I just installed "Format on Save" and made my script wrongly formatted to see if the plugin works. Then I saved the script, but no change happened.

Context

So, to give you more context:

• I on macOS Sonoma 14.1.1 on the Apple M1 Max CPU
• I installed gdtoolkit in my iTerm2 in Zsh with pip3 install "gdtoolkit==4.*". When I run gdformat --version, I get gdformat 4.2.2 printed out
• I run Godot v4.2.1.stable.official [b09f793f5]
• I downloaded the plugin within Godot and chose to not "Ignore asset root" (but the same lack of formatting was happening when I clicked the otherwise)
• I modified the script to look unformatted (see code pasted below)
• I press Cmd+S to save, no formatting happens
• But when I run gdformat manually, it formats OK (I run gdformat day23/day_23_part_1.gd from inside godot folder of my repo)

Source code: https://github.com/beetrootpaul/advent-of-code-2023/tree/godot-format-on-save-issue -> folder godot -> script day23/day_23_part_1.gd (note the script is supposed to read day23/example1_in.txt which is ignored in the repo; you can put any txt file there)

My unformatted script:

extends Node2D
func _ready()   :
	var filePath       = "res://day23/example1_in.txt"
	#var filePath = "res://day23/puzzle1_in.txt"

	var input =        FileAccess.open(filePath, FileAccess.READ).get_as_text()
	print_debug(input)
	var lines = input.split("\n")







func       _process(delta):
	pass

Script as formatted by gdformat day23/day_23_part_1.gd outside the Godot / plugin:

extends Node2D


func _ready():
	var filePath = "res://day23/example1_in.txt"
	#var filePath = "res://day23/puzzle1_in.txt"

	var input = FileAccess.open(filePath, FileAccess.READ).get_as_text()
	print_debug(input)
	var lines = input.split("\n")


func _process(delta):
	pass

How to debug?

I wonder if it is something with my gdtoolkit installation or some macOS related issues 🤔 Is there a way in Godot (I am new to the engine) to debug "Format on save" plugin? Can I for example add some print_debug statements to it and see its output somewhere?

Screenshots

The plugin I installed:

gdformat version:

[beetrootpaul]

I also wonder if it is a bad sign if plugin download did not modify anything in the project itself, like writing down the plugin is there and should be used 🤔 I do not know how plugins work in Godot, I am just guessing based on my experiences with other tools. Also, I was trying Godot's Git plugin (without success as well 😞 ) and it in fact did modified some project file with an entry about plugin's existence.

You can see the code which changed when I installed "Format on save" in this commit: beetrootpaul/advent-of-code-2023@577ab91

[beetrootpaul]

I found a checkbox to enable the plugin in project settings. Enabled it (added it as a commit to my repo). Sadly, still no formatting happens.

[beetrootpaul]

OK, so now I see my print_debug statements and what I can tell so far about var exit_code = OS.execute("gdformat", [filepath]):

• when I run gdformat followed by content of filepath in my default macOS Terminal.app, it formats OK
• but inside the plugin, exit_code is 127

[beetrootpaul]

Seems like plugin cannot see gdformat, since this code:

var output: Array[String] = []
var exit_code = OS.execute("gdformat", [filepath], output, true)
print_debug(output)

resulted with

["sh: gdformat: command not found\n"]

[beetrootpaul]

Apparently the gdformat I run is located at /opt/homebrew/bin/gdformat. I guess executables from Homebrew are available on path of the current user only and, again I guess, Godot has no access to it.

[beetrootpaul]

I got it working 🙂 It's great that I can just edit plugin's source code in Godot, therefore here are my changes:

beetrootpaul/advent-of-code-2023@d0e7fd9

I just added a full path to gdformat valid for my env. This issue can be probably closed, I suppose.

BTW what do you think about adding this to your plugin, so it might help other ppl with seeing the error in logs?

👉 https://github.com/beetrootpaul/advent-of-code-2023/blob/d0e7fd94a01815f327a875ec49673a8023c779e6/godot/addons/format_on_save/format_on_save.gd#L45-L47

[lovelistudios]

I got it working 🙂 It's great that I can just edit plugin's source code in Godot, therefore here are my changes:

beetrootpaul/advent-of-code-2023@d0e7fd9

I just added a full path to gdformat valid for my env. This issue can be probably closed, I suppose.

BTW what do you think about adding this to your plugin, so it might help other ppl with seeing the error in logs?

👉 https://github.com/beetrootpaul/advent-of-code-2023/blob/d0e7fd94a01815f327a875ec49673a8023c779e6/godot/addons/format_on_save/format_on_save.gd#L45-L47

Thank you @beetrootpaul ! I ran into the same issue, and your changes worked perfectly!