Fix trailing doc comment conversion, update test case

smithy-lang · May 8, 2024 · c039f6f · c039f6f
1 parent 24c1ddd
commit c039f6f
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 4 deletions.
diff --git a/smithy-syntax/src/main/java/software/amazon/smithy/syntax/FixBadDocComments.java b/smithy-syntax/src/main/java/software/amazon/smithy/syntax/FixBadDocComments.java
@@ -82,6 +82,16 @@ public TokenTree apply(TokenTree tree) {
                     updateNestedChildren(br);
                 }
             }
+            // Fix any trailing doc comments in shape bodies
+            for (TreeCursor members : shapeStatements.findChildrenByType(TreeType.SHAPE_MEMBERS)) {
+                TreeCursor closeBrace = members.getLastChild();
+                if (closeBrace != null) {
+                    TreeCursor possibleTrailingWs = closeBrace.getPreviousSibling();
+                    if (possibleTrailingWs != null && possibleTrailingWs.getTree().getType() == TreeType.WS) {
+                        updateDirectChildren(possibleTrailingWs);
+                    }
+                }
+            }
         }
 
         return tree;

diff --git a/...urces/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.formatted.smithy b/...urces/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.formatted.smithy
@@ -35,7 +35,12 @@ structure Foo {
     // 17 (change)
     bar: String
 
-    /// 18 (TODO: handle this case somehow)
+    /// 17a (keep)
+    @length(min: 1)
+    baz: String = ""
+
+    /// 18 (TODO: Fix trailing comment after VALUE_ASSIGNMENT)
+
 }
 
 // 19 (change)
@@ -45,4 +50,10 @@ apply Foo @tags(["a"])
 list Baz {
     member: Integer
 }
-// 21 (change)
+
+structure Foo2 {
+    foo2: String
+
+    // 21 (change)
+}
+// 22 (change)
diff --git a/.../test/resources/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.smithy b/.../test/resources/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.smithy
@@ -35,7 +35,11 @@ structure Foo {
     /// 17 (change)
     bar: String
 
-    /// 18 (TODO: handle this case somehow)
+    /// 17a (keep)
+    @length(min: 1)
+    baz: String = ""
+
+    /// 18 (TODO: Fix trailing comment after VALUE_ASSIGNMENT)
 }
 
 /// 19 (change)
@@ -46,4 +50,10 @@ list Baz {
     member: Integer
 }
 
-/// 21 (change)
+structure Foo2 {
+    foo2: String
+
+    /// 21 (change)
+}
+
+/// 22 (change)