Godot addon: Line numbers disappear after linting finds results

[jonathan-robertson]

Details

• Given a script file with linting violations (MAX-LINE-LENGTH in my case)
• When linting completes (via Format script menu, Command Palette, or on-save)
• Then line numbers in the left gutter of the script file disappear

Note

before linting

after linting

More Context

• GDQuest/GDScript-formatter is the only plugin I have installed in this project.
• installed under res://addons/GDQuest_GDScript_formatter
• version installed: 0.14.0 (according to AssetLib posting)
  • I believe I'm using the latest available edition of GDScript-formatter since I installed this plugin just today
    • 
  • Actual plugin version reported in the Project Settings entry still shows 0.1.0 due to plugin.cfg reflecting that text
• also, adjustments to linting settings I make, such as Lint Line Length and Lint Ignored Rules seem to be ignored, but checking the box Lint On Save does work
  • I'm not sure if that helps to provide more context on whether I have a bad version/install or not

Steps to reproduce

1. start with a gdscript file which has some long lines in it (or presumably.. any linter error but I haven't tested others)
   • 
2. run Lint GDSCript from the Command Palette (or just save the file if you have linting triggered on save)
   • 
3. cry just a little as your beautiful line numbers vanish
   • 

Temporary Workaround

Simply close and reopen your script file.

Unfortunately, switching script 'tabs' is not enough to resolve this issue.

[NathanLovato]

Thank you for the very detailed issue report. Godot does not support script editor plugins so what this plugin does actually hacks the editor and the add-on has to rebuild the state of the editor. There are probably settings that it is currently missing.

[TravisB1231]

Also seeing this in formatter v0.18.1 for Windows. I didn't see Jonathan mention this, so maybe this can provide more helpful context.

I linted a script that produced 14 found issues. I saw these 2 error messages per issue:

I also see that the issue list in the console output says "$issue_name on line 0 ($real_line_num) for every issue.

This is on Godot 4.5-stable for Windows.

[guilhemmgt]

Lint icons (the little (!) things) are rendered on gutter 2 (see plugin.gd):

## Which gutter lint icons are shown in.
## By default, gutter 0 is for breakpoints and 1 is for things like overrides.
const LINT_ICON_GUTTER := 2

As the comment states, gutter 0 and 1 are already taken.
But gutter 2 seems to be for line numbers, so they are erased.
Gutter 3 seems to be for the little "collapse arrows" next to functions.
And there does not seem to be any other gutters.
I do not know if it is possible to have breakpoints + overrides + collapse arrows + line numbers + lint icons at the same time...

Another temporary workaround is to disable lint icons by commenting out the code_edit.set_gutter_type line in plugin.gd.

@TravisB1231 This seems to be an unrelated issue specific to Windows : #199

[NathanLovato]

Thanks for looking into this. In that case, I'd say we might as well remove the lint icons and only keep the output and optionally the line highlighting if that works reliably. Generally speaking, the script editor is not really designed to support plugins or extensions, even if we hack them in. If something breaks the editor, we're better off removing it.

[NathanLovato]

I suppressed the icons for now based on your findings. For now, I just commented out the code to keep it around in case someone wants to look into restoring it or see if there's a way to make it work and if not I will delete it in a later version.

In Godot 4.6 I'm seeing a regression or another change that when we save the file, the linter highlight appears briefly, and then it seems the script editor updates its drawing and clears the linter highlights.

It seems there's a delay before it adds built-ins or signal connection icons and also indicates type safe lines. It's sort of debounced.

@TranquilMarmot may I ask you what you'd like on the linter side as you're the author? Do you use it in the Godot script editor via the addon? I don't have time to look into a workaround to get the highlights, etc. to update after this new debounced visual update of the script editor in Godot 4.6.

The CanvasItem.draw signal might be an option, though only if the ScriptEditor node itself redraws and emits the signal - otherwise the code would need to find whatever node is drawing the script editor or is emitting a layout change signal (if any), which gets brittle with Godot updates as anything unsupported by the plugin API can change anytime.

[TranquilMarmot]

I agree that the lint highlighting is very hacked in to the code editor and is going to be prone to breakages. We can remove it and consider adding it back if/when the Godot editor gets more proper extension support.

Personally, I use Zed to write GDScript and do linting in a pre-commit hook.

[NathanLovato]

Thank you for the feedback!

[NathanLovato]

Thank you for the feedback!