Generate multiline comments properly (Closes #11)

liamnichols · Sep 26, 2023 · 304c80d · 304c80d
1 parent afe7601
commit 304c80d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/Sources/StringGenerator/StringGenerator.swift b/Sources/StringGenerator/StringGenerator.swift
@@ -252,17 +252,16 @@ extension Resource {
     }
 
     var leadingTrivia: Trivia {
-        let commentTrivia: [TriviaPiece] = if let comment {
-            comment
-                .components(separatedBy: .newlines)
-                .map { TriviaPiece.docLineComment("/// \($0)") }
-        } else {
-            []
+        var trivia: Trivia = .newlines(2)
+
+        if let commentLines = comment?.components(separatedBy: .newlines), !commentLines.isEmpty {
+            for line in commentLines {
+                trivia = trivia.appending(Trivia.docLineComment("/// \(line)"))
+                trivia = trivia.appending(.newline)
+            }
         }
 
-        return .newlines(2)
-            .merging(Trivia(pieces: commentTrivia))
-            .merging(.newline)
+        return trivia
     }
 
     func statements(table: String, bundle: TokenSyntax) -> CodeBlockItemListSyntax {

diff --git a/Tests/LocalizationTests/StringGeneratorTests.swift b/Tests/LocalizationTests/StringGeneratorTests.swift
@@ -17,6 +17,20 @@ final class StringGeneratorTests: XCTestCase {
         XCTAssertNotNil(output)
     }
 
+    func testGenerateMultilineComment() {
+        let output = generate([
+            Resource(
+                key: "foo",
+                comment: "A comment\n\nA comment that covers many lines.",
+                identifier: "foo",
+                arguments: [],
+                defaultValue: [.string("FOO")]
+            )
+        ])
+
+        XCTAssertNotNil(output)
+    }
+
     private func generate(
         _ resources: [Resource],
         tableName: String = "Localizable",