Keep trailing doc comment spaces in IDL serializer

Closes smithy-lang#2115
AndrewFossAWS · Jan 26, 2024 · e671ac9 · e671ac9
1 parent dc2ae9e
commit e671ac9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/smithy-model/src/main/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.java b/smithy-model/src/main/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.java
@@ -532,9 +532,13 @@ private void serializeTraits(Map<ShapeId, Trait> traits, TraitFeature... traitFe
 
         private void serializeDocumentation(String documentation) {
             // The documentation trait has a special syntax, which we always want to use.
-            codeWriter.setNewlinePrefix("/// ")
+            codeWriter
+                    .pushState()
+                    // See https://github.com/smithy-lang/smithy/issues/2115
+                    .trimTrailingSpaces(false)
+                    .setNewlinePrefix("/// ")
                     .write(documentation.replace("$", "$$"))
-                    .setNewlinePrefix("");
+                    .popState();
         }
 
         private void serializeTrait(Trait trait) {

diff --git a/...software/amazon/smithy/model/shapes/idl-serialization/cases/trailing-space-in-docs.smithy b/...software/amazon/smithy/model/shapes/idl-serialization/cases/trailing-space-in-docs.smithy
@@ -0,0 +1,9 @@
+$version: "2.0"
+
+namespace com.example
+
+/// This line has trailing spaces  
+/// This line does not have trailing spaces
+/// This line has one trailing space 
+/// Addresses https://github.com/smithy-lang/smithy/issues/2115
+string TestString