fix: don't pull first module entry into comment

Safe-DS · Jul 4, 2023 · 2a1f91f · 2a1f91f
1 parent 5fb3c57
commit 2a1f91f
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 5 deletions.
diff --git a/DSL/src/language-server/formatting/safe-ds-formatter.ts b/DSL/src/language-server/formatting/safe-ds-formatter.ts
@@ -1,4 +1,4 @@
-import { AbstractFormatter, AstNode, Formatting } from 'langium';
+import {AbstractFormatter, AstNode, CstNode, findCommentNode, Formatting, isAstNode} from 'langium';
 import * as ast from '../generated/ast';
 import { SdsImport, SdsImportAlias, SdsModule } from '../generated/ast';
 import { annotationCallsOrEmpty, typeArgumentsOrEmpty } from '../helpers/astShortcuts';
@@ -191,15 +191,26 @@ export class SafeDSFormatter extends AbstractFormatter {
         // Annotations
         annotations.forEach((value, index) => {
             if (index === 0) {
-                formatter.node(value).prepend(noSpace());
+                if (this.hasComment(value)) {
+                    formatter.node(value).prepend(newLine());
+                } else {
+                    formatter.node(value).prepend(noSpace());
+                }
             } else {
                 formatter.node(value).prepend(newLines(1));
             }
         });
 
         // Package
         if (annotations.length === 0) {
-            formatter.keyword('package').prepend(noSpace());
+            const packageKeyword = formatter.keyword('package');
+            const cstNodes = packageKeyword.nodes
+
+            if (cstNodes.length > 0 && this.hasComment(cstNodes[0])) {
+                packageKeyword.prepend(newLine());
+            } else {
+                packageKeyword.prepend(noSpace());
+            }
         } else {
             formatter.keyword('package').prepend(newLines(2));
         }
@@ -210,7 +221,11 @@ export class SafeDSFormatter extends AbstractFormatter {
         imports.forEach((value, index) => {
             if (index === 0) {
                 if (annotations.length === 0 && !name) {
-                    formatter.node(value).prepend(noSpace());
+                    if (this.hasComment(value)) {
+                        formatter.node(value).prepend(newLine());
+                    } else {
+                        formatter.node(value).prepend(noSpace());
+                    }
                 } else {
                     formatter.node(value).prepend(newLines(2));
                 }
@@ -223,7 +238,11 @@ export class SafeDSFormatter extends AbstractFormatter {
         members.forEach((value, index) => {
             if (index === 0) {
                 if (annotations.length === 0 && !name && imports.length === 0) {
-                    formatter.node(value).prepend(noSpace());
+                    if (this.hasComment(value)) {
+                        formatter.node(value).prepend(newLine());
+                    } else {
+                        formatter.node(value).prepend(noSpace());
+                    }
                 } else {
                     const valueAnnotations = annotationCallsOrEmpty(value);
                     if (valueAnnotations.length > 0) {
@@ -871,4 +890,32 @@ export class SafeDSFormatter extends AbstractFormatter {
 
         formatter.keyword(':').prepend(noSpace()).append(oneSpace());
     }
+
+    // -----------------------------------------------------------------------------
+    // Helpers
+    // -----------------------------------------------------------------------------
+
+    /**
+     * Returns whether the given node has a comment associated with it.
+     *
+     * @param node The node to check.
+     */
+    private hasComment(node: AstNode | CstNode | undefined): boolean {
+        return Boolean(this.getCommentNode(node));
+    }
+
+    /**
+     * Returns the comment associated with the given node.
+     *
+     * @param node The node to get the comment for.
+     */
+    private getCommentNode(node: AstNode | CstNode | undefined): CstNode | undefined {
+        const commentNames = ["ML_COMMENT", "SL_COMMENT"]
+
+        if (isAstNode(node)) {
+            return findCommentNode(node.$cstNode, commentNames)
+        } else {
+            return findCommentNode(node, commentNames)
+        }
+    }
 }
diff --git a/DSL/tests/resources/formatting/comments/before declarations.sdstest b/DSL/tests/resources/formatting/comments/before declarations.sdstest
@@ -0,0 +1,8 @@
+// test
+
+class C
+
+// -----------------------------------------------------------------------------
+
+// test
+class C
diff --git a/DSL/tests/resources/formatting/comments/before imports.sdstest b/DSL/tests/resources/formatting/comments/before imports.sdstest
@@ -0,0 +1,8 @@
+// test
+
+import test
+
+// -----------------------------------------------------------------------------
+
+// test
+import test
diff --git a/DSL/tests/resources/formatting/comments/before module annotations.sdstest b/DSL/tests/resources/formatting/comments/before module annotations.sdstest
@@ -0,0 +1,8 @@
+// test
+
+@Annotation
+
+// -----------------------------------------------------------------------------
+
+// test
+@Annotation
diff --git a/DSL/tests/resources/formatting/comments/before module name.sdstest b/DSL/tests/resources/formatting/comments/before module name.sdstest
@@ -0,0 +1,8 @@
+// test
+
+package test
+
+// -----------------------------------------------------------------------------
+
+// test
+package test