Formater breaks on some coderegions

[Mewlkor]

Code regions inside functions can cause the formater to not indent correctly. When the coderegion is not indented to the "correct" indentation level it moves all code after that to the indentation level of the coderegion. This breaks even more should the coderegion be inside a if/for or similar indentaion.

Its a bit hard to discribe but this is a MRP for the issue. Since coderegion tags are just comments this is perfectly valid gdscript.

extends Node

func _ready() -> void:
	var some_var = 1
	var some_var2 = 2
	
#region unused code
	#var some_var = 1
	#var some_var2 = 2
#endregion
	print(some_var * some_var2)
	print("This should not be indeted")

func test():
	var some_var = 1
	var some_var2 = 2
	if true:
#region unused code
	#var some_var = 1
	#var some_var2 = 2
#endregion
		print(some_var * some_var2)
		print("This should not be indeted")

[NathanLovato]

In the built-in GDScript code editor, code regions are not actually GDScript code. They are handled by special code in the editor. More generally, the official GDScript parser does not read comments or regions at all as far as I know, it just discards them.

However, with the technology we use here, they have to be parsed for us to have access to them and format them. Also in this technology the indentation of different elements is encoded in the parsed element and dedented region labels by default end up closing the function.

They could be parsed as being part of the function, like comments are, and you'll end up with this:

func _ready() -> void:
	var some_var = 1
	var some_var2 = 2
	
	#region unused code
	#var some_var = 1
	#var some_var2 = 2
	#endregion
	print(some_var * some_var2)
	print("This should not be indeted")

That's the best we could get as far as I know. We could not preserve regions as you have them at the root indentation level in the middle of a function. What do you think?

This will take changes to the GDScript parser.

[Mewlkor]

This would be an improvement. At least the code doesn't break anymore.

[NathanLovato]

Actually same root issue as #252: PrestonKnopp/tree-sitter-gdscript#85

Note for self: the parser should faithfully preserve indentation levels, then now the formatter was rewritten, we can completely ignore regions during formatting/always output them as-is and never touch their indentation in the output; basically ignore them, just like GDScript actually does in Godot.