Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix formatter to correctly convert invalid doc comments #2277

Merged
merged 2 commits into from
May 8, 2024
Merged

Fix formatter to correctly convert invalid doc comments #2277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24c1ddd
Fix formatter to correctly convert invalid doc comments
haydenbaker May 6, 2024
c039f6f
Fix trailing doc comment conversion, update test case
milesziemer May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions smithy-syntax/src/main/java/software/amazon/smithy/syntax/FixBadDocComments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ public TokenTree apply(TokenTree tree) {
updateNestedChildren(cursor);
}

// Doc comments should not appear in TRAIT_STATEMENTS.
for (TreeCursor cursor : shapeSection.findChildrenByType(TreeType.TRAIT_STATEMENTS)) {
updateNestedChildren(cursor);
}

// Fix doc comments that come before apply statements.
TreeCursor shapeStatements = shapeSection.getFirstChild(TreeType.SHAPE_STATEMENTS);
if (shapeStatements != null) {
Expand All @@ -77,11 +82,15 @@ public TokenTree apply(TokenTree tree) {
updateNestedChildren(br);
}
}

// Remove trailing doc comments in member bodies.
// Fix any trailing doc comments in shape bodies
for (TreeCursor members : shapeStatements.findChildrenByType(TreeType.SHAPE_MEMBERS)) {
TreeCursor ws = members.getLastChild(TreeType.WS);
updateDirectChildren(ws);
TreeCursor closeBrace = members.getLastChild();
if (closeBrace != null) {
TreeCursor possibleTrailingWs = closeBrace.getPreviousSibling();
if (possibleTrailingWs != null && possibleTrailingWs.getTree().getType() == TreeType.WS) {
updateDirectChildren(possibleTrailingWs);
}
}
}
}

Expand Down
5 changes: 2 additions & 3 deletions smithy-syntax/src/test/java/software/amazon/smithy/syntax/ParseAndFormatTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package software.amazon.smithy.syntax;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.io.IOException;
import java.nio.file.Files;
Expand Down Expand Up @@ -54,7 +53,7 @@ public void testRunner(Path filename) {
String formatted = Formatter.format(tree, 120);
String expected = IoUtils.readUtf8File(formattedFile);

assertThat(formatted, equalTo(expected));
assertEquals(expected, formatted);
}

public static List<Path> tests() throws Exception {
Expand Down
21 changes: 16 additions & 5 deletions ...urces/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.formatted.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,24 @@ use smithy.api#String

/// 12 (keep)
@deprecated
/// 13 (change)
// 13 (change)
structure Foo {
/// 14 (keep)
@length(
// 15 (change)
min: 1
)
/// 16 (change)
// 16 (change)
@since("1.x")
/// 17 (TODO: change)
// 17 (change)
bar: String

// 18 (change)
/// 17a (keep)
@length(min: 1)
baz: String = ""

/// 18 (TODO: Fix trailing comment after VALUE_ASSIGNMENT)

}

// 19 (change)
Expand All @@ -45,4 +50,10 @@ apply Foo @tags(["a"])
list Baz {
member: Integer
}
// 21 (change)

structure Foo2 {
foo2: String

// 21 (change)
}
// 22 (change)
17 changes: 14 additions & 3 deletions .../test/resources/software/amazon/smithy/syntax/formatter/fixes-invalid-doc-comments.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,14 @@ structure Foo {
)
/// 16 (change)
@since("1.x")
/// 17 (TODO: change)
/// 17 (change)
bar: String
/// 18 (change)

/// 17a (keep)
@length(min: 1)
baz: String = ""

/// 18 (TODO: Fix trailing comment after VALUE_ASSIGNMENT)
}

/// 19 (change)
Expand All @@ -45,4 +50,10 @@ list Baz {
member: Integer
}

/// 21 (change)
structure Foo2 {
foo2: String

/// 21 (change)
}

/// 22 (change)
Loading