Fix indent parenthesized expression (#2127)

* In code style `ktlint_official` do not indent the closing parenthesis of a PARENTHESIZED expression Closes #920
pinterest · Jul 15, 2023 · e69ac9e · e69ac9e
1 parent 76016af
commit e69ac9e
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 * Allow to disable ktlint in `.editorconfig` for a glob ([#2100](https://github.com/pinterest/ktlint/issues/2100))
 * Fix wrapping of nested function literals `wrapping` ([#2106](https://github.com/pinterest/ktlint/issues/2106))
-* Do not indent class body for classes having a long super type list in code style `ktlint_official` as it is inconsistent compared to other class bodies `indent` [#2115](https://github.com/pinterest/ktlint/issues/2115) 
+* Do not indent class body for classes having a long super type list in code style `ktlint_official` as it is inconsistent compared to other class bodies `indent` [#2115](https://github.com/pinterest/ktlint/issues/2115)
+* In code style `ktlint_official` do not indent the closing parenthesis of a PARENTHESIZED expression `indent` [#920](https://github.com/pinterest/ktlint/issues/920) 
 * Log message `Format was not able to resolve all violations which (theoretically) can be autocorrected in file ... in 3 consecutive runs of format` is now only displayed in case a new ktlint rule is actually needed. [#2129](https://github.com/pinterest/ktlint/issues/2129)
 * Fix wrapping of function signature in case the opening brace of the function body block exceeds the maximum line length. Fix upsert of whitespace into composite nodes. `function-signature` [#2130](https://github.com/pinterest/ktlint/issues/2130)
 * Fix spacing around colon in annotations `spacing-around-colon` ([#2093](https://github.com/pinterest/ktlint/issues/2093))

diff --git a/...t-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRule.kt b/...t-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRule.kt
@@ -245,9 +245,16 @@ public class IndentationRule :
             node.elementType == SECONDARY_CONSTRUCTOR ->
                 visitSecondaryConstructor(node)
 
-            node.elementType == PARENTHESIZED &&
-                node.treeParent.treeParent.elementType != IF ->
-                startIndentContext(node)
+            node.elementType == PARENTHESIZED ->
+                if (codeStyle == ktlint_official) {
+                    // Contrary to the IntelliJ IDEA default formatter, do not indent the closing RPAR
+                    startIndentContext(
+                        fromAstNode = node,
+                        lastChildIndent = "",
+                    )
+                } else if (node.treeParent.treeParent.elementType != IF) {
+                    startIndentContext(node)
+                }
 
             node.elementType == BINARY_WITH_TYPE ||
                 node.elementType == SUPER_TYPE_ENTRY ||
@@ -1366,7 +1373,7 @@ private class StringTemplateIndenter(
                                 it.isLiteralStringTemplateEntry() ||
                                     it.isVariableStringTemplateEntry() ||
                                     it.isClosingQuote()
-                                )
+                            )
                         ) {
                             val (actualIndent, actualContent) =
                                 if (it.isIndentBeforeClosingQuote()) {

diff --git a/...-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoSemicolonsRule.kt b/...-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoSemicolonsRule.kt
@@ -67,26 +67,25 @@ public class NoSemicolonsRule :
         }
     }
 
-    private fun ASTNode?.doesNotRequirePreSemi(): Boolean {
-        if (this == null) {
-            return true
-        }
-        if (this is PsiWhiteSpace) {
-            val nextLeaf =
+    private fun ASTNode?.doesNotRequirePreSemi() =
+        when {
+            this == null -> true
+
+            this is PsiWhiteSpace -> {
                 nextLeaf {
                     val psi = it.psi
                     it !is PsiWhiteSpace &&
                         it !is PsiComment &&
                         psi.getStrictParentOfType<KDoc>() == null &&
                         psi.getStrictParentOfType<KtAnnotationEntry>() == null
+                }.let { nextLeaf ->
+                    nextLeaf == null || // \s+ and then eof
+                        (textContains('\n') && nextLeaf.elementType != KtTokens.LBRACE)
                 }
-            return (
-                nextLeaf == null || // \s+ and then eof
-                    textContains('\n') && nextLeaf.elementType != KtTokens.LBRACE
-                )
+            }
+
+            else -> false
         }
-        return false
-    }
 
     private fun isNoSemicolonRequiredAfter(node: ASTNode): Boolean {
         val prevCodeLeaf =

diff --git a/...ard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/SpacingAroundCurlyRule.kt b/...ard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/SpacingAroundCurlyRule.kt
@@ -51,7 +51,7 @@ public class SpacingAroundCurlyRule : StandardRule("curly-spacing") {
                     (
                         prevLeaf?.elementType == LPAR &&
                             ((node as LeafPsiElement).parent is KtLambdaExpression || node.parent.parent is KtLambdaExpression)
-                        )
+                    )
                 spacingAfter = nextLeaf is PsiWhiteSpace || nextLeaf?.elementType == RBRACE
                 if (prevLeaf is PsiWhiteSpace &&
                     !prevLeaf.textContains('\n') &&
@@ -69,7 +69,7 @@ public class SpacingAroundCurlyRule : StandardRule("curly-spacing") {
                         prevLeaf.prevLeaf()?.let { it.elementType == RPAR || KtTokens.KEYWORDS.contains(it.elementType) } == true ||
                             node.treeParent.elementType == CLASS_BODY ||
                             (prevLeaf.treeParent.elementType == FUN && prevLeaf.treeNext.elementType != LAMBDA_EXPRESSION)
-                        ) // allow newline for lambda return type
+                    ) // allow newline for lambda return type
                 ) {
                     emit(node.startOffset, "Unexpected newline before \"${node.text}\"", true)
                     if (autoCorrect) {
@@ -141,7 +141,7 @@ public class SpacingAroundCurlyRule : StandardRule("curly-spacing") {
                 nextElementType == LBRACKET ||
                 nextElementType == LPAR ||
                 nextElementType == COLONCOLON
-            )
+        )
     }
 }
 

diff --git a/...rd/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/SpacingAroundParensRule.kt b/...rd/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/SpacingAroundParensRule.kt
@@ -42,11 +42,11 @@ public class SpacingAroundParensRule : StandardRule("paren-spacing") {
                                 // Super keyword needs special-casing
                                 prevLeaf.prevLeaf()?.elementType == SUPER_KEYWORD ||
                                 prevLeaf.prevLeaf()?.treeParent?.elementType == PRIMARY_CONSTRUCTOR
-                            ) &&
+                        ) &&
                         (
                             node.treeParent?.elementType == VALUE_PARAMETER_LIST ||
                                 node.treeParent?.elementType == VALUE_ARGUMENT_LIST
-                            )
+                        )
                 } else {
                     prevLeaf is PsiWhiteSpace && !prevLeaf.textContains('\n') &&
                         prevLeaf.prevLeaf()?.elementType != LPAR

diff --git a/...tandard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/StringTemplateRule.kt b/...tandard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/StringTemplateRule.kt
@@ -63,7 +63,7 @@ public class StringTemplateRule : StandardRule("string-template") {
                         (
                             nextSibling.elementType == LITERAL_STRING_TEMPLATE_ENTRY &&
                                 !nextSibling.text.substring(0, 1).isPartOfIdentifier()
-                            )
+                        )
                 }
             ) {
                 emit(node.treePrev.startOffset + 2, "Redundant curly braces", true)

diff --git a/...eset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/WrappingRule.kt b/...eset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/WrappingRule.kt
@@ -239,7 +239,7 @@ public class WrappingRule :
                 numberOfArgs == 1 &&
                     firstArg?.firstChildNode?.elementType
                         ?.let { it == OBJECT_LITERAL || it == LAMBDA_EXPRESSION } == true
-                )
+            )
         ) {
             return
         }
@@ -308,7 +308,7 @@ public class WrappingRule :
             !(
                 entries.dropLast(1).all { it.elementType == SUPER_TYPE_ENTRY } &&
                     entries.last().elementType == SUPER_TYPE_CALL_ENTRY
-                )
+            )
         ) {
             // put space after :
             if (!node.prevLeaf().isWhiteSpaceWithNewline()) {

diff --git a/...andard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRuleTest.kt b/...andard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRuleTest.kt
@@ -5322,6 +5322,24 @@ internal class IndentationRuleTest {
             .isFormattedAs(formattedCode)
     }
 
+    @Test
+    fun `Issue 920 - Given ktlint_official codestyle and a PARENTHESIZED expression`() {
+        val code =
+            """
+            val foobar =
+                if (true) {
+                    (
+                        foo()
+                    )
+                } else {
+                    bar()
+                }
+            """.trimIndent()
+        indentationRuleAssertThat(code)
+            .withEditorConfigOverride(CODE_STYLE_PROPERTY to ktlint_official)
+            .hasNoLintViolations()
+    }
+
     private companion object {
         val INDENT_STYLE_TAB =
             INDENT_STYLE_PROPERTY to PropertyType.IndentStyleValue.tab