Don’t show Add documentation refactoring for declarations that are not on a new line

Author: ahoppen

Sources/SourceKitLSP/Swift/CodeActions/AddDocumentation.swift

@@ -37,16 +37,20 @@ import SwiftSyntax
 public struct AddDocumentation: EditRefactoringProvider {
   @_spi(Testing)
   public static func textRefactor(syntax: DeclSyntax, in context: Void) -> [SourceEdit] {
-    let hasDocumentation = syntax.leadingTrivia.contains(where: { trivia in
+    let hasDocumentation = syntax.leadingTrivia.contains { trivia in
       switch trivia {
-      case .blockComment(_), .docBlockComment(_), .lineComment(_), .docLineComment(_):
+      case .blockComment, .docBlockComment, .lineComment, .docLineComment:
         return true
       default:
         return false
       }
-    })
+    }
+
+    // We consider nodes at the start of the source file at being on a new line
+    let isOnNewLine =
+      syntax.leadingTrivia.contains(where: \.isNewline) || syntax.previousToken(viewMode: .sourceAccurate) == nil
 
-    guard !hasDocumentation else {
+    guard !hasDocumentation && isOnNewLine else {
       return []
     }
 

Tests/SourceKitLSPTests/CodeActionTests.swift

@@ -909,10 +909,12 @@ final class CodeActionTests: XCTestCase {
     }
   }
 
-  func testAddDocumentationRefactorSingleParameter() async throws {
+  func testAddDocumentationRefactorNotAtStartOfFile() async throws {
     try await assertCodeActions(
       """
+      struct Foo {
         1️⃣func 2️⃣refactor(3️⃣syntax: 4️⃣Decl5️⃣Syntax)6️⃣ { }7️⃣
+      }
       """,
       ranges: [("1️⃣", "2️⃣"), ("1️⃣", "6️⃣"), ("1️⃣", "7️⃣")],
       exhaustive: false
@@ -942,6 +944,49 @@ final class CodeActionTests: XCTestCase {
     }
   }
 
+  func testAddDocumentationRefactorAtStartOfFile() async throws {
+    try await assertCodeActions(
+      """
+      1️⃣func 2️⃣refactor(3️⃣syntax: 4️⃣Decl5️⃣Syntax)6️⃣ { }7️⃣
+      """,
+      ranges: [("1️⃣", "2️⃣"), ("1️⃣", "6️⃣"), ("1️⃣", "7️⃣")],
+      exhaustive: false
+    ) { uri, positions in
+      [
+        CodeAction(
+          title: "Add documentation",
+          kind: .refactorInline,
+          diagnostics: nil,
+          edit: WorkspaceEdit(
+            changes: [
+              uri: [
+                TextEdit(
+                  range: Range(positions["1️⃣"]),
+                  newText: """
+                    /// A description
+                    /// - Parameter syntax:
+                    \("")
+                    """
+                )
+              ]
+            ]
+          ),
+          command: nil
+        )
+      ]
+    }
+  }
+
+  func testAddDocumentationDoesNotShowUpIfItIsNotOnItsOwnLine() async throws {
+    try await assertCodeActions(
+      """
+      var x = 1; var 1️⃣y = 2
+      """
+    ) { uri, positions in
+      []
+    }
+  }
+
   /// Retrieves the code action at a set of markers and asserts that it matches a list of expected code actions.
   ///
   /// - Parameters: