Combine @abstract annotation with class/class_name/func line

Author: TranquilMarmot

gdtoolkit/formatter/annotation.py

@@ -111,6 +111,16 @@
 ]
 
 
+def is_abstract_annotation_for_statement(statement: Tree, next_statement: Tree) -> bool:
+    """Check if this is an @abstract annotation that should be combined with the next statement."""
+    if statement.data != "annotation":
+        return False
+    name = statement.children[0].value
+    if name != "abstract":
+        return False
+    return next_statement.data in ["abstract_func_def", "classname_stmt", "class_def"]
+
+
 def is_non_standalone_annotation(statement: Tree) -> bool:
     if statement.data != "annotation":
         return False
@@ -136,9 +146,26 @@ def prepend_annotations_to_formatted_line(
     single_line_length = (
         context.indent + len(annotations_string) + len(whitelineless_line)
     )
-    standalone_formatting_enforced = whitelineless_line.startswith(
-        "func"
-    ) or whitelineless_line.startswith("static func")
+    # Check if this is an abstract function or class_name annotation
+    is_abstract_func = (
+        len(context.annotations) == 1 and
+        context.annotations[0].children[0].value == "abstract" and
+        whitelineless_line.startswith("func")
+    )
+    is_abstract_class_name = (
+        len(context.annotations) == 1 and
+        context.annotations[0].children[0].value == "abstract" and
+        whitelineless_line.startswith("class_name")
+    )
+    is_abstract_class = (
+        len(context.annotations) == 1 and
+        context.annotations[0].children[0].value == "abstract" and
+        whitelineless_line.startswith("class ")
+    )
+    standalone_formatting_enforced = (
+        whitelineless_line.startswith("func") or 
+        whitelineless_line.startswith("static func")
+    ) and not is_abstract_func and not is_abstract_class_name
     if (
         not _annotations_have_standalone_comments(
             context.annotations, context.standalone_comments, line_to_prepend_to[0]

gdtoolkit/formatter/block.py

@@ -14,6 +14,7 @@
 from .annotation import (
     is_non_standalone_annotation,
     prepend_annotations_to_formatted_line,
+    is_abstract_annotation_for_statement,
 )
 
 
@@ -26,8 +27,15 @@ def format_block(
     previous_statement_name = None
     formatted_lines = []  # type: FormattedLines
     previously_processed_line_number = context.previously_processed_line_number
-    for statement in statements:
-        if is_non_standalone_annotation(statement):
+    for i, statement in enumerate(statements):
+        # Check if this is an abstract annotation followed by an abstract function or class_name
+        next_statement = statements[i + 1] if i + 1 < len(statements) else None
+        is_abstract_for_statement = (
+            next_statement is not None and
+            is_abstract_annotation_for_statement(statement, next_statement)
+        )
+        
+        if is_non_standalone_annotation(statement) or is_abstract_for_statement:
             context.annotations.append(statement)
             is_first_annotation = len(context.annotations) == 1
             if not is_first_annotation:
@@ -47,7 +55,7 @@ def format_block(
                 blank_lines, statement.data, surrounding_empty_lines_table
             )
         is_first_annotation = len(context.annotations) == 1
-        if is_non_standalone_annotation(statement) and is_first_annotation:
+        if (is_non_standalone_annotation(statement) or is_abstract_for_statement) and is_first_annotation:
             formatted_lines += blank_lines
             continue
         if len(context.annotations) == 0:

tests/formatter/input-output-pairs/abstract_functions.in.gd

@@ -1,12 +1,22 @@
-@abstract class_name BaseClass
+@abstract
+class_name BaseClass
 
-@abstract func simple_abstract()
+@abstract
+class TestClass:
+	@abstract
+	func test_func()
 
-@abstract func abstract_with_params(param1: String, param2: int)
+@abstract
+func simple_abstract()
 
-@abstract func abstract_with_return_type() -> String
+@abstract
+func abstract_with_params(param1: String, param2: int)
 
-@abstract func abstract_with_params_and_return(input: String) -> int
+@abstract
+func abstract_with_return_type() -> String
+
+@abstract
+func abstract_with_params_and_return(input: String) -> int
 
 func concrete_method():
 	pass

tests/formatter/input-output-pairs/abstract_functions.out.gd

@@ -1,17 +1,16 @@
-@abstract
-class_name BaseClass
+@abstract class_name BaseClass
 
-@abstract
-func simple_abstract()
+@abstract class TestClass:
+	@abstract func test_func()
 
-@abstract
-func abstract_with_params(param1: String, param2: int)
 
-@abstract
-func abstract_with_return_type() -> String
+@abstract func simple_abstract()
 
-@abstract
-func abstract_with_params_and_return(input: String) -> int
+@abstract func abstract_with_params(param1: String, param2: int)
+
+@abstract func abstract_with_return_type() -> String
+
+@abstract func abstract_with_params_and_return(input: String) -> int
 
 
 func concrete_method():