prefer attaching docstring to the statement

Author: shadr

queries/gdscript.scm

@@ -192,7 +192,10 @@
   (comment)
   (region_start)
   (region_end)
-  (annotation)] @allow_blank_line_before)
+  (annotation)
+  (function_definition)
+  (class_definition)
+  (constructor_definition)] @allow_blank_line_before)
 
 (setget) @prepend_indent_start @append_indent_end
 (setget ":" @prepend_antispace)

src/formatter.rs

@@ -166,7 +166,7 @@ impl Formatter {
         // - must contain at least one new line character between `extends_name` and optional doc comment
         // - may contain multiple doc comment lines that starts with `##` and ends with a new line character
         let re = RegexBuilder::new(
-            r#"(?P<extends_line>^extends )(?P<extends_name>([a-zA-Z0-9]+|".*?"))\n+(?P<doc>(?:^##.*\n)*)\n*(?P<EOF>\z)?"#,
+            r#"(?P<extends_line>^extends )(?P<extends_name>([a-zA-Z0-9]+|".*?"))\n+((?P<doc>(?:^##.*\n)+)(?:\z|\n))?\n*(?P<EOF>\z)?"#,
         )
         .multi_line(true)
         .build()

tests/expected/class_doc_comment.gd

@@ -1,31 +1,48 @@
-class_name Player
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
+## Blankline after docstring
 ##
 ## The description of script
 
-class_name Player
+var a = 10
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
+## Blankline before and after docstring
 ##
 ## The description of script
 
-class_name Player
+var a = 10
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
+
+## Blankline before docstring
 ##
-## The description of script
+## The description of a variable
+var a = 10
+extends CharacterBody2D
 
+## No blankline around docstring
+##
+## The description of a variable
 var a = 10
-class_name Player
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
+
+## Blanklink before function docstring
+##
+## The description of a variable
+func foo():
+	pass
+extends CharacterBody2D
+## Blankline between docstring and function definition
 ##
-## The description of script
+## The description of a variable
+
+func foo():
+	pass
+extends CharacterBody2D
 
 var a = 10
-class_name Player
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
 
 var a = 10
+extends CharacterBody2D
+## Docstring at the end of file
+##
+## The description of script

tests/input/class_doc_comment.gd

@@ -1,27 +1,47 @@
-class_name Player extends CharacterBody2D
-
-## A brief description of the class's role and functionality.
-##
-## The description of script
-class_name Player extends CharacterBody2D
-## A brief description of the class's role and functionality.
+extends CharacterBody2D
+## Blankline after docstring
 ##
 ## The description of script
-class_name Player extends CharacterBody2D
-## A brief description of the class's role and functionality.
+
+var a = 10
+extends CharacterBody2D
+
+## Blankline before and after docstring
 ##
 ## The description of script
 
 var a = 10
-class_name Player
 extends CharacterBody2D
 
-## A brief description of the class's role and functionality.
+## Blankline before docstring
 ##
-## The description of script
+## The description of a variable
+var a = 10
+extends CharacterBody2D
+## No blankline around docstring
+##
+## The description of a variable
+var a = 10
+extends CharacterBody2D
+## Blanklink before function docstring
+##
+## The description of a variable
+func foo():
+	pass
+extends CharacterBody2D
+## Blankline between docstring and function definition
+##
+## The description of a variable
+
+func foo():
+	pass
+extends CharacterBody2D
 
 var a = 10
-class_name Player
 extends CharacterBody2D
-## A brief description of the class's role and functionality.
 var a = 10
+
+extends CharacterBody2D
+## Docstring at the end of file
+##
+## The description of script