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

Break after annotations iff it is a block-level expression #302

Closed
wants to merge 1 commit into from
Closed

Break after annotations iff it is a block-level expression #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 23 additions & 12 deletions core/src/main/java/com/facebook/ktfmt/format/KotlinInputAstVisitor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1557,20 +1557,31 @@ class KotlinInputAstVisitor(
override fun visitAnnotatedExpression(expression: KtAnnotatedExpression) {
builder.sync(expression)
builder.block(ZERO) {
loop@ for (child in expression.node.children()) {
when (val psi = child.psi) {
is PsiWhiteSpace -> continue@loop
is KtAnnotationEntry -> {
visit(psi)
if (expression.annotationEntries.size != 1) {
builder.forcedBreak()
} else {
builder.breakOp(Doc.FillMode.UNIFIED, " ", ZERO)
}
}
else -> visit(psi)
builder.block(ZERO) {
visit(expression.annotationEntries[0])
expression.annotationEntries.drop(1).forEach {
builder.breakOp(Doc.FillMode.UNIFIED, " ", ZERO)
visit(it)
}
}

/**
* Break after annotations iff this is a block-level expression.
*
* For some block-level expressions (e.g. binary operators, infix functions) the line break
* changes the target of the annotation. When on the previous line, the annotation targets the
* entire expression. When on the same line, it targets only the left-most sub-expression.
*
* In order to always preserve semantics, and guarantee consistent formatting, we always break
* only for this case.
*/
if (expression.parent is KtBlockExpression) {
builder.forcedBreak()
} else {
builder.space()
}

visit(expression.baseExpression)
}
}

Expand Down
34 changes: 28 additions & 6 deletions core/src/test/java/com/facebook/ktfmt/format/FormatterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4021,7 +4021,8 @@ class FormatterTest {
|class MyClass {}
|
|fun f() {
| @Suppress("MagicNumber") add(10)
| @Suppress("MagicNumber")
| add(10)
|
| @Annotation // test a comment after annotations
| return 5
Expand All @@ -4033,16 +4034,38 @@ class FormatterTest {
fun `annotated expressions`() =
assertFormatted(
"""
|------------------------------------------------
|fun f() {
| @Suppress("MagicNumber") add(10)
| @Suppress("MagicNumber") add(10) && add(20)
|
| @Suppress("MagicNumber")
| add(10) && add(20)
|
| @Anno1 @Anno2(param = Param1::class)
| add(10) && add(20)
|
| @Anno1
| @Anno2(param = Param1::class)
| @Anno3
| @Anno4(param = Param2::class)
| add(10)
| add(10) && add(20)
|
| @Anno1
| @Anno2(param = Param1::class)
| @Anno3
| @Anno4(param = Param2::class) add(10) &&
| add(20)
|
| @Suppress("MagicNumber") add(10) &&
| add(20) &&
| add(30)
|
| add(@Suppress("MagicNumber") 10) &&
| add(20) &&
| add(30)
|}
|""".trimMargin())
|""".trimMargin(),
deduceMaxWidth = true)

@Test
fun `annotated function declarations`() =
Expand Down Expand Up @@ -4686,8 +4709,7 @@ class FormatterTest {
| }
|
|fun foo() =
| Runnable @Px
| {
| Runnable @Px {
| foo()
| //
| }
Expand Down