fix: Fixes description indenting & commenting

NeedleInAJayStack · NeedleInAJayStack · commit 55bac29e14c6 · 2025-12-30T23:00:20.000-07:00
diff --git a/Sources/GraphQLGeneratorCore/Generator/SchemaGenerator.swift b/Sources/GraphQLGeneratorCore/Generator/SchemaGenerator.swift
@@ -269,7 +269,7 @@ package struct SchemaGenerator {
             output += """
             ,
                 description: \"\"\"
-                \(description)
+                \(description.indent(1, includeFirst: false))
                 \"\"\"
             """
         }
@@ -311,15 +311,15 @@ package struct SchemaGenerator {
                 output += """
                 ,
                             description: \"\"\"
-                            \(description)
+                            \(description.indent(3, includeFirst: false))
                             \"\"\"
                 """
             }
             if let deprecationReason = field.deprecationReason {
                 output += """
                 ,
                             deprecationReason: \"\"\"
-                            \(deprecationReason)
+                            \(deprecationReason.indent(3, includeFirst: false))
                             \"\"\"
                 """
             }
@@ -351,7 +351,7 @@ package struct SchemaGenerator {
             output += """
             ,
                 description: \"\"\"
-                \(description)
+                \(description.indent(1, includeFirst: false))
                 \"\"\",
             """
         }
@@ -432,7 +432,7 @@ package struct SchemaGenerator {
             output += """
             ,
                 description: \"\"\"
-                \(description)
+                \(description.indent(1, includeFirst: false))
                 \"\"\"
             """
         }
@@ -505,20 +505,20 @@ package struct SchemaGenerator {
 
         var output = """
         let \(varName) = try GraphQLUnionType(
-            name: "\(type.name)",
+            name: "\(type.name)"
         """
 
         if let description = type.description {
             output += """
-
+            ,
                 description: \"\"\"
-                \(description)
-                \"\"\",
+                \(description.indent(1, includeFirst: false))
+                \"\"\"
             """
         }
 
         output += """
-
+        ,
             types: [
         """
         for type in try type.types() {
@@ -612,7 +612,7 @@ package struct SchemaGenerator {
             output += """
             ,
                 description: \"\"\"
-                \(description)
+                \(description.indent(1, includeFirst: false))
                 \"\"\"
             """
         }
@@ -621,7 +621,7 @@ package struct SchemaGenerator {
             output += """
             ,
                 deprecationReason: \"\"\"
-                \(deprecationReason)
+                \(deprecationReason.indent(1, includeFirst: false))
                 \"\"\"
             """
         }
@@ -644,7 +644,7 @@ package struct SchemaGenerator {
                     output += """
                     ,
                                 description: \"\"\"
-                                \(description)
+                                \(description.indent(3, includeFirst: false))
                                 \"\"\"
                     """
                 }
diff --git a/Sources/GraphQLGeneratorCore/Generator/TypeGenerator.swift b/Sources/GraphQLGeneratorCore/Generator/TypeGenerator.swift
@@ -83,7 +83,7 @@ package struct TypeGenerator {
             if let description = type.description {
                 output += """
 
-                /// \(description)
+                \(description.docComment())
                 """
             }
             let swiftTypeName = try swiftTypeDeclaration(for: type, nameGenerator: nameGenerator)
@@ -163,7 +163,7 @@ package struct TypeGenerator {
         if let description = type.description {
             output += """
 
-            /// \(description)
+            \(description.docComment())
             """
         }
 
@@ -178,7 +178,7 @@ package struct TypeGenerator {
             if let description = value.description {
                 output += """
 
-                    /// \(description)
+                    \(description.docComment().indent(1, includeFirst: false))
                 """
             }
             // Use safe name generator for case names
@@ -204,7 +204,7 @@ package struct TypeGenerator {
         if let description = type.description {
             output += """
 
-            /// \(description)
+            \(description.docComment())
             """
         }
 
@@ -217,7 +217,7 @@ package struct TypeGenerator {
             if let description = field.description {
                 output += """
 
-                    /// \(description)
+                    \(description.docComment().indent(1, includeFirst: false))
                 """
             }
 
@@ -245,7 +245,7 @@ package struct TypeGenerator {
         if let description = type.description {
             output += """
 
-            /// \(description)
+            \(description.docComment())
             """
         }
 
@@ -265,7 +265,7 @@ package struct TypeGenerator {
             if let description = field.description {
                 output += """
 
-                    /// \(description)
+                    \(description.docComment().indent(1, includeFirst: false))
                 """
             }
 
@@ -309,7 +309,7 @@ package struct TypeGenerator {
         if let description = type.description {
             output += """
 
-            /// \(description)
+            \(description.docComment())
             """
         }
 
@@ -333,7 +333,7 @@ package struct TypeGenerator {
             if let description = field.description {
                 output += """
 
-                    /// \(description)
+                    \(description.docComment().indent(1, includeFirst: false))
                 """
             }
 
@@ -379,7 +379,7 @@ package struct TypeGenerator {
         if let description = type.description {
             output += """
 
-            /// \(description)
+            \(description.docComment())
             """
         }
 
@@ -395,7 +395,7 @@ package struct TypeGenerator {
             if let description = field.description {
                 output += """
 
-                    /// \(description)
+                    \(description.docComment().indent(1, includeFirst: false))
                 """
             }
 
diff --git a/Sources/GraphQLGeneratorCore/Utilities/indent.swift b/Sources/GraphQLGeneratorCore/Utilities/indent.swift
@@ -1,12 +1,20 @@
 extension String {
     func indent(_ num: Int, includeFirst: Bool = true) -> String {
         let indent = String(repeating: "    ", count: num)
+        return prefixLines(with: indent, includeFirst: includeFirst)
+    }
+
+    func docComment() -> String {
+        return prefixLines(with: "/// ", includeFirst: true)
+    }
+
+    private func prefixLines(with prefix: any StringProtocol, includeFirst: Bool) -> String {
         var firstLine = true
         return split(separator: "\n").map { line in
             var result = line
             if !line.isEmpty {
                 if !firstLine || includeFirst {
-                    result = indent + line
+                    result = prefix + line
                 }
             }
             firstLine = false

Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ package struct SchemaGenerator {`
`269`	`269`	`output += """`
`270`	`270`	`,`
`271`	`271`	`description: \"\"\"`
`272`		`- \(description)`
	`272`	`+ \(description.indent(1, includeFirst: false))`
`273`	`273`	`\"\"\"`
`274`	`274`	`"""`
`275`	`275`	`}`
`@@ -311,15 +311,15 @@ package struct SchemaGenerator {`
`311`	`311`	`output += """`
`312`	`312`	`,`
`313`	`313`	`description: \"\"\"`
`314`		`- \(description)`
	`314`	`+ \(description.indent(3, includeFirst: false))`
`315`	`315`	`\"\"\"`
`316`	`316`	`"""`
`317`	`317`	`}`
`318`	`318`	`if let deprecationReason = field.deprecationReason {`
`319`	`319`	`output += """`
`320`	`320`	`,`
`321`	`321`	`deprecationReason: \"\"\"`
`322`		`- \(deprecationReason)`
	`322`	`+ \(deprecationReason.indent(3, includeFirst: false))`
`323`	`323`	`\"\"\"`
`324`	`324`	`"""`
`325`	`325`	`}`
`@@ -351,7 +351,7 @@ package struct SchemaGenerator {`
`351`	`351`	`output += """`
`352`	`352`	`,`
`353`	`353`	`description: \"\"\"`
`354`		`- \(description)`
	`354`	`+ \(description.indent(1, includeFirst: false))`
`355`	`355`	`\"\"\",`
`356`	`356`	`"""`
`357`	`357`	`}`
`@@ -432,7 +432,7 @@ package struct SchemaGenerator {`
`432`	`432`	`output += """`
`433`	`433`	`,`
`434`	`434`	`description: \"\"\"`
`435`		`- \(description)`
	`435`	`+ \(description.indent(1, includeFirst: false))`
`436`	`436`	`\"\"\"`
`437`	`437`	`"""`
`438`	`438`	`}`
`@@ -505,20 +505,20 @@ package struct SchemaGenerator {`
`505`	`505`
`506`	`506`	`var output = """`
`507`	`507`	`let \(varName) = try GraphQLUnionType(`
`508`		`- name: "\(type.name)",`
	`508`	`+ name: "\(type.name)"`
`509`	`509`	`"""`
`510`	`510`
`511`	`511`	`if let description = type.description {`
`512`	`512`	`output += """`
`513`		`-`
	`513`	`+ ,`
`514`	`514`	`description: \"\"\"`
`515`		`- \(description)`
`516`		`- \"\"\",`
	`515`	`+ \(description.indent(1, includeFirst: false))`
	`516`	`+ \"\"\"`
`517`	`517`	`"""`
`518`	`518`	`}`
`519`	`519`
`520`	`520`	`output += """`
`521`		`-`
	`521`	`+ ,`
`522`	`522`	`types: [`
`523`	`523`	`"""`
`524`	`524`	`for type in try type.types() {`
`@@ -612,7 +612,7 @@ package struct SchemaGenerator {`
`612`	`612`	`output += """`
`613`	`613`	`,`
`614`	`614`	`description: \"\"\"`
`615`		`- \(description)`
	`615`	`+ \(description.indent(1, includeFirst: false))`
`616`	`616`	`\"\"\"`
`617`	`617`	`"""`
`618`	`618`	`}`
`@@ -621,7 +621,7 @@ package struct SchemaGenerator {`
`621`	`621`	`output += """`
`622`	`622`	`,`
`623`	`623`	`deprecationReason: \"\"\"`
`624`		`- \(deprecationReason)`
	`624`	`+ \(deprecationReason.indent(1, includeFirst: false))`
`625`	`625`	`\"\"\"`
`626`	`626`	`"""`
`627`	`627`	`}`
`@@ -644,7 +644,7 @@ package struct SchemaGenerator {`
`644`	`644`	`output += """`
`645`	`645`	`,`
`646`	`646`	`description: \"\"\"`
`647`		`- \(description)`
	`647`	`+ \(description.indent(3, includeFirst: false))`
`648`	`648`	`\"\"\"`
`649`	`649`	`"""`
`650`	`650`	`}`