Breakdown comment blocks with new lines

This also keeps comment lines within comment blocks with their leading
comment markers in tact

Author: adammcarter

Sources/SwiftSyntax/Trivia.swift

@@ -46,10 +46,7 @@ public struct Trivia: Sendable {
   ///
   /// Each element in the array is the trimmed contents of a line comment, or, in the case of a multi-line comment a trimmed, concatenated single string.
   public var commentValues: [String] {
-    [
-      sanitizedLineCommentValues,
-      sanitizedBlockCommentValues,
-    ].flatMap { $0 }
+    sanitizedBlockCommentValues
   }
 
   /// The length of all the pieces in this ``Trivia``.
@@ -227,43 +224,49 @@ extension RawTriviaPiece: CustomDebugStringConvertible {
 }
 
 private extension Trivia {
-  var sanitizedLineCommentValues: [String] {
-    compactMap {
-      switch $0 {
-      case .lineComment(let text), .docLineComment(let text):
-        String(sanitizingLineComment(text))
-
-      default:
-        nil
-      }
-    }
-  }
-
-  func sanitizingLineComment(_ text: String) -> Substring {
-    text.trimmingPrefix("/ ")
-  }
-
   var sanitizedBlockCommentValues: [String] {
+    // TODO: adammcarter - make new hashable struct to identify pieces instead of relying on indexes to remove later on...
+
     var lines = [String]()
-    var substrings = [Substring]()
-    var foundTerminator = false
+    var substrings = [String]()
 
-    for piece in self {
+    var foundStartOfCodeBlock = false
+    var foundEndOfCodeBlock = false
+    var isInCodeBlock: Bool { foundStartOfCodeBlock && foundEndOfCodeBlock == false }
+
+    for piece in pieces {
       switch piece {
-      case .blockComment(let text), .docBlockComment(let text):
-        let sanitized = text.trimmingCharacters(in: "/* ")
+      case .blockComment(let text),
+        .docBlockComment(let text):
+        foundStartOfCodeBlock = text.trimmingPrefix("\n").hasPrefix("/*")
+        foundEndOfCodeBlock = text.trimmingSuffix("\n").hasSuffix("*/")
+
+        let sanitized =
+          text
+          .split(separator: "\n")
+          .map { $0.trimmingCharacters(in: "/*").trimmingCharacters(in: " ") }
+          .filter { $0.isEmpty == false }
+          .joined(separator: " ")
 
         if substrings.isEmpty || sanitized.isEmpty == false {
           substrings.append(sanitized)
         }
 
-        foundTerminator = text.hasSuffix("*/")
+      case .lineComment(let text),
+        .docLineComment(let text):
+        if isInCodeBlock {
+          if substrings.isEmpty || text.isEmpty == false {
+            substrings.append(text)
+          }
+        } else {
+          lines.append(String(text.trimmingPrefix("/ ")))
+        }
 
       default:
         break
       }
 
-      if foundTerminator, substrings.isEmpty == false {
+      if foundEndOfCodeBlock, substrings.isEmpty == false {
         lines.append(substrings.joined(separator: " "))
         substrings.removeAll()
       }

Sources/SwiftSyntax/Utils.swift

@@ -124,7 +124,7 @@ extension RawUnexpectedNodesSyntax {
 extension String {
   func trimmingCharacters(in charactersToTrim: any BidirectionalCollection<Character>) -> Substring {
     // TODO: adammcarter - this feels a bit dirty
-    self[startIndex...].trimmingPrefix(charactersToTrim).trimmingSuffix(charactersToTrim)
+    self[startIndex...].trimmingCharacters(in: charactersToTrim)
   }
 
   func trimmingPrefix(_ charactersToTrim: any BidirectionalCollection<Character>) -> Substring {
@@ -137,6 +137,10 @@ extension String {
 }
 
 extension Substring {
+  func trimmingCharacters(in charactersToTrim: any BidirectionalCollection<Character>) -> Substring {
+    trimmingPrefix(charactersToTrim).trimmingSuffix(charactersToTrim)
+  }
+
   func trimmingPrefix(_ charactersToTrim: any BidirectionalCollection<Character>) -> Self {
     dropFirst(countOfSequentialCharacters(charactersToTrim, in: self))
   }

Tests/SwiftSyntaxTest/TriviaTests.swift

@@ -214,6 +214,34 @@ class TriviaTests: XCTestCase {
       ]
     )
 
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .blockComment(
+          """
+          /*
+          Some block comment
+          spread on many lines
+          */
+          """
+        )
+      ]).commentValues,
+      ["Some block comment spread on many lines"]
+    )
+
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .blockComment(
+          """
+          /*
+          *  Some block comment
+          *  spread on many lines
+          */
+          """
+        )
+      ]).commentValues,
+      ["Some block comment spread on many lines"]
+    )
+
     // MARK: doc block comment
 
     XCTAssertEqual(
@@ -277,7 +305,89 @@ class TriviaTests: XCTestCase {
       ]
     )
 
-    // TODO: adammcarter - mixing trivia of lines and blocks
-    // TODO: adammcarter - newline chars in the prefix/suffix of code block too
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .docBlockComment(
+          """
+          /**
+          Some doc block comment
+          spread on many lines
+          */
+          """
+        )
+      ]).commentValues,
+      ["Some doc block comment spread on many lines"]
+    )
+
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .docBlockComment(
+          """
+          /**
+          *  Some doc block comment
+          *  spread on many lines
+          */
+          """
+        )
+      ]).commentValues,
+      ["Some doc block comment spread on many lines"]
+    )
+
+    // MARK: Mixing comment styles
+
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .docBlockComment(
+          """
+          /**
+          *  Some doc block comment
+          *  // spread on many lines
+          *  with a line comment
+          */
+          """
+        )
+      ]).commentValues,
+      ["Some doc block comment // spread on many lines with a line comment"]
+    )
+
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .docBlockComment("/** Some doc block comment"),
+        .docBlockComment("* spread on many lines */"),
+        .newlines(2),
+        .docLineComment("/// Some doc line comment"),
+        .docLineComment("// Some line comment"),
+        .newlines(2),
+        .spaces(4),
+        .blockComment("/* Some block comment"),
+        .blockComment("* spread on many lines */"),
+        .newlines(2),
+        .docBlockComment("/** Another doc block comment */"),
+      ]).commentValues,
+      [
+        "Some doc block comment spread on many lines",
+        "Some doc line comment",
+        "Some line comment",
+        "Some block comment spread on many lines",
+        "Another doc block comment",
+      ]
+    )
+
+    XCTAssertEqual(
+      Trivia(pieces: [
+        .docBlockComment("/* Some block comment"),
+        .docLineComment("// A line comment in a block"),
+        .docBlockComment("* spread on many lines */"),
+        .newlines(2),
+        .blockComment("/** Some doc block comment"),
+        .docLineComment("/// A doc line comment in a block"),
+        .blockComment("* spread on"),
+        .blockComment("* many lines */"),
+      ]).commentValues,
+      [
+        "Some block comment // A line comment in a block spread on many lines",
+        "Some doc block comment /// A doc line comment in a block spread on many lines",
+      ]
+    )
   }
 }