The background color of linted lines disappear if the script is edited

[guilhemmgt]

Description

• Using GDScript formatter 0.18.2 with Godot 4.6 on Windows
• On linting a file, problematic lines are colored in red or yellow to indicate a linter error or warning. These colors disappear within 1-2 seconds of editing the script in Godot script editor (even without saving the file).

Reproduce

• Write a script with a linter issue :

func _init() -> void:
	print("hello")
	pass # <- this produces a linter warning (unnecessary-pass)

• Lint it (Ctrl+S or Format > Lint Current Script). The pass line is now colored in yellow.
• Edit it (you can just add a new line, or edit the comment).

Expected behaviour

• The pass line coloration do not change.

Observed behaviour

• The pass line coloration disappear after 1-2 seconds.

Additional informations

This behaviour can be indirectly triggered by saving the script, because saving the script can trigger the formatting and edit the script.

Also: Godot seems to redraw the script editor if the script is edited, then left unedited for 1-2 seconds. I believe this is the cause of this behaviour.

[guilhemmgt]

I experimented by calling set_line_background_color anytime code_edit.draw is emited. Here is the result :

gdquest-connect-draw.mp4

There still is a flickering when the script editor is redrawned (?). That is weird, because the Godot warning coloring do not flicker. Honestly I do not exactly know what is going on here.

[guilhemmgt]

I believe set_line_background_color just sets a property, and do not draw anything directly. That may be why there is a flickering. So I experimented by drawing with draw_rect directly anytime code_edit.draw is emited. Here is the result :

gdquest-rect.mp4

There is no flickering anymore so that's great. However, this method is far more hacky and is less reliable.

I can make a pull request based on my first suggestion, and hopefully someone will find a way to fix the flickering (but I believe we can live with it).

[NathanLovato]

Thank you very much for taking the time to look into this! There was this other issue that just got solved because there was this problem with gutter icons and the fact that basically the script editor is not designed for you to modify it.

I'll link to it so you can see the end of the conversation for reference: #169

I am in favor of removing the line highlighting and more generally not trying to modify the script editor because I expect that we will have regressions over time and that is going to bring some maintenance burden.

This whole project is just a temporary solution until GDScript has an actual official formatter, with the goal to give you a formatter that works fine enough for as little pint and maintenance cost as possible (because the day the official formatter is completed, this will be archived).

I very much appreciate your work and effort and if you would like this feature and you're eager to contribute and maintain it, I don't mind integrating it in the add-on. But just so you know because of my workload and what I explained above, I would not want to maintain it myself and otherwise be in favor of removing the feature.

Please let me know how you'd like to proceed!

[NathanLovato]

Thank you very much for taking the time to look into this! There was this other issue that just got solved because there was this problem with gutter icons and the fact that basically the script editor is not designed for you to modify it.

I'll link to it so you can see the end of the conversation for reference: #169

I am in favor of removing the line highlighting and more generally not trying to modify the script editor because I expect that we will have regressions over time and that is going to bring some maintenance burden.

This whole project is just a temporary solution until GDScript has an actual official formatter, with the goal to give you a formatter that works fine enough for as little pint and maintenance cost as possible (because the day the official formatter is completed, this will be archived).

I very much appreciate your work and effort and if you would like this feature and you're eager to contribute and maintain it, I don't mind integrating it in the add-on. But just so you know because of my workload and what I explained above, I would not want to maintain it myself and otherwise be in favor of removing the feature.

Please let me know how you'd like to proceed!