[Bug] Critical indentation error: Formatter breaks unindented comments scope of subsequent code blocks

[Dreak183]

Affected GDScript Formatter:
0.20.1

Description:
The GDScript formatter currently has a critical indentation bug that renders functional scripts non-functional.

The faulty behavior seems to affect all block-level indentations. It can be reliably reproduced whenever a block-starting statement (e.g., an if-statement, for-loop, or any other statement requiring subsequent indentation) is immediately followed by an unindented comment.

When an unindented comment is present after the block-starting code statement, the formatter incorrectly unindents the execution block that follows, snapping it back to the same indentation level as the parent if or for statement.
Causing prior non-existent errors to scripts upon safe.

Steps to Reproduce / Minimal Example

Saved / Functional Script (Before Formatting / also expected result after formatting):

func _if_test() -> void:
	if true:
	#if false:
		print("Execution Block for if statement - indented")

func _for_test() -> void:
	for i in range(10):
	#for i in range(5):
		print(i)

Result after auto formatting (Broken Script):

func _if_test() -> void:
	if true:
	#if false:
	print("Execution Block for if statement - indented")

func _for_test() -> void:
	for i in range(10):
	#for i in range(5):
	print(i)

Impact & Use Cases

This behavior inevitably breaks the script's scope and leads to parser errors. Depending on the size of the script, this could cause significant overhead to manually track down and fix the broken indentations.

Regardless of whether these comments are considered "incorrectly" indented by strict style conventions, there are realistic and practical use cases for placing them there. For example, keeping alternative conditions or loop ranges right below the active one for quick debugging and testing.

Proposed Solution

Comments should have no influence on the indentation logic of the subsequent code. The linter should ignore comments when determining the required indentation level for the execution blocks that follow them.

Related issues

If read correctly, there seem´s to be something else involved, but it relates to issue #190

Metadata

Severity

• Script Breaking formatter behavior
  GDScript Formatter Version
• 0.20.1
  Godot Editor / Version
• Godot 4.7
  IDE
• Godot 4.7 Editor | Script Editor

[NathanLovato]

It's an issue in the tree-sitter parser for GDScript itself upstream. The indentation of the comment affects the parsing/detection of the indentation of the following statement which ends up indented at the same level.

(source [0, 0] - [4, 0]
  (function_definition [0, 0] - [3, 54]
    name: (name [0, 5] - [0, 13])
    parameters: (parameters [0, 13] - [0, 15])
    return_type: (type [0, 19] - [0, 23]
      (identifier [0, 19] - [0, 23]))
    body: (body [0, 24] - [3, 54]
      (if_statement [1, 1] - [1, 9]
        condition: (true [1, 4] - [1, 8])
        body: (body [1, 9] - [1, 9]))
      (comment [2, 1] - [2, 11])
      (expression_statement [3, 2] - [3, 54]
        (call [3, 2] - [3, 54]
          (identifier [3, 2] - [3, 7])
          arguments: (arguments [3, 7] - [3, 54]
            (string [3, 8] - [3, 53])))))))

This is unrelated to #190

For now, as a workaround, if you create commented lines, you will want to indent them to be inside code blocks, or avoid keeping multiple temporary statements around your code (or, lastly, turn off format on save and format manually when your code is final, that'd be another option).