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

Wrapping rule should not prevent comments for interfaces on separate lines #1457

Merged
merged 5 commits into from
May 8, 2022
Merged

Wrapping rule should not prevent comments for interfaces on separate lines #1457

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f069ce
Wrapping rule should not prevent comments for interfaces on separate …
hbmartin Apr 27, 2022
5e36273
Merge branch 'pinterest:master' into master
hbmartin May 4, 2022
9880c40
address PR comments
hbmartin May 4, 2022
2b40682
Do not require wrapping when comment is not preceded by a space
May 5, 2022
dbed2e6
Update changelog
May 8, 2022
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
9 changes: 8 additions & 1 deletion ...nt-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/WrappingRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,10 @@ public class WrappingRule : Rule(
// put entries on separate lines
// TODO: group emit()s below with the one above into one (similar to ParameterListWrappingRule)
for (c in node.children()) {
if (c.elementType == COMMA && !c.treeNext.isWhiteSpaceWithNewline()) {
if (c.elementType == COMMA &&
!c.treeNext.isWhiteSpaceWithNewline() &&
!c.isFollowedByCommentOnSameLine()
) {
requireNewlineAfterLeaf(
nodeAfterWhichNewlineIsRequired = c,
autoCorrect = autoCorrect,
Expand All @@ -222,6 +225,10 @@ public class WrappingRule : Rule(
}
}

private fun ASTNode.isFollowedByCommentOnSameLine() =
nextLeaf { !it.isWhiteSpaceWithoutNewline() }
?.isPartOfComment() == true

private fun rearrangeValueList(
node: ASTNode,
autoCorrect: Boolean,
Expand Down
32 changes: 32 additions & 0 deletions ...uleset-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/WrappingRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,38 @@ internal class WrappingRuleTest {
).isEmpty()
}

@Test
fun `test wrapping rule allows line comment`() {
val code =
"""
interface Foo1 {}
interface Foo2 {}
interface Foo3 {}
class Bar :
Foo1, // this comment should be legal
Foo2,// this comment should be legal
Foo3 {
}
""".trimIndent()
wrappingRuleAssertThat(code).hasNoLintViolations()
}

paul-dingemans marked this conversation as resolved.
Show resolved Hide resolved
@Test
fun `test wrapping rule allows block comment`() {
val code =
"""
interface Foo1 {}
interface Foo2 {}
interface Foo3 {}
class Bar :
Foo1, /* this comment should be legal */
Foo2,/* this comment should be legal */
Foo3 {
}
""".trimIndent()
wrappingRuleAssertThat(code).hasNoLintViolations()
}

@Test
fun testLintNewlineAfterEqAllowed() {
assertThat(
Expand Down