GDScript, code commenting behavior is probably incorrect

[0x01011970]

Code commenting behavior is probably incorrect in .gd files

See this scenario :

func _ready() -> void:
	align_stuff()
	pass

Commenting the second line (using hotkey ctrl + /) gives :

func _ready() -> void:
#	align_stuff()
	pass

The # is at the beginning of the line and not at the beginning of the text.

PyCharm (for Python) and Godot Editor put the # character at the beginning of the text :

func _ready() -> void:
	#align_stuff()
	pass

This may be the root cause of the issue we are experiencing with auto formatting : #362

Since the # character is at the very beginning of the line, the auto formatter probably thinks the indentation is wrong, and adds unnecessary/invalid tabs to commented lines.

[van800]

Rider 2025.2 Nightly builds already have auto-indentation disabled, so it would less smart, but at least would not do unexpected things.

[actforjason]

Ivan Šachov (@van800) Hi. The consensus about comments is to align to the indentation of the code rather than at the beginning of the line. Otherwise it will cause confusion with other softwares.

func _ready() -> void:
#	align_stuff()
	pass

👇

func _ready() -> void:
	# align_stuff()
	pass

[van800]

Jason (@actforjason) Please follow the RIDER-136861
it makes sense that we don't need a full formatter for this case to be done.

If you want to look at yourself, please let me know.

Maybe it is just

gdscript.formatter.settings.GdLanguageCodeStyleSettingsProvider#customizeDefaults

change to

    override fun customizeDefaults(commonSettings: CommonCodeStyleSettings, indentOptions: CommonCodeStyleSettings.IndentOptions) {
        indentOptions.USE_TAB_CHARACTER = true
        commonSettings.LINE_COMMENT_AT_FIRST_COLUMN = false
        commonSettings.BLOCK_COMMENT_AT_FIRST_COLUMN = false
        super.customizeDefaults(commonSettings, indentOptions)
    }

https://github.com/JetBrains/godot-support/blob/master/CONTRIBUTING.md

[actforjason]

Is there no workflow for building jar plug-ins? That would be more convenient.

[van800]

There is a build, but no publish of the result
https://github.com/JetBrains/godot-support/blob/master/.github/workflows/ci.yml#L49

[actforjason]

change to

    override fun customizeDefaults(commonSettings: CommonCodeStyleSettings, indentOptions: CommonCodeStyleSettings.IndentOptions) {
        indentOptions.USE_TAB_CHARACTER = true
        commonSettings.LINE_COMMENT_AT_FIRST_COLUMN = false
        commonSettings.BLOCK_COMMENT_AT_FIRST_COLUMN = false
        super.customizeDefaults(commonSettings, indentOptions)
    }

I built the rider-gdscript plug-in and replaced the built-in one (Local\Programs\Rider\plugins\rider-gdscript) with it. After restarting, the original behavior is still there.

[van800]

I see, no immediate idea at the moment.