Add new experimental rule `chain-method-continuation` #2088

atulgpt · 2023-06-24T16:22:52Z

Description

Add ChainMethodContinuation(chain-method-continuation) rule

This rule ensures chain operators(. or ?.) aligns with next call
When there is } in the new line this also ensures that the chain operators align with } along with the next call method

This partially fixes #1953

Checklist

PR description added
tests are added
KtLint has been applied on source code itself and violations are fixed
documentation is updated
CHANGELOG.md is updated

In case of adding a new rule:

Rule is added to rules documentation

CHANGELOG.md

documentation/release-latest/docs/rules/experimental.md

documentation/snapshot/docs/rules/experimental.md

...d/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationTest.kt

paul-dingemans · 2023-06-25T08:56:29Z

Formatting code below:

val bar =
    listOf(1, 2, 3). // xxx
        map {
            it * it
        }

results in code which can not be compiled:

val bar =
    listOf(1, 2, 3)
        .// xxxmap {
            it * it
        }

...ndard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuation.kt

...d/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationTest.kt

This rule ensures chain operators(`.` or `?.`) aligns with next call When there is `}` in the new line this also ensures that the chain operators align with `}` along with next call method

Handle minor comments Update docs and remove release docs

Simplify the error message

Remove the usage of `noNewLineInOpenRange`

- Fix offsets - Messages only chain operator - if chain operator is at end of line then two messages needs to be emitted. One message because as a whitespace was expected before the chain operator. The other message because no whitespace was expected after the chain operator. - Break chained methods when max line is exceeded - A chained method should not continue on the previous line if that ends with "!!" Add discourage locations for comments between chain operator and the expression. Comments before the chain operator have to be allowed.

…rces the chain method to be wrapped even when the maximum line length is not exceeded

- Rename ChainMethodContinuation to ChainMethodContinuationRule - Add new function replaceStringTemplatePlaceholder in TestLiterals

# Conflicts: # CHANGELOG.md # documentation/release-latest/docs/rules/experimental.md

atulgpt · 2023-08-14T17:56:23Z

...c/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationRuleTest.kt

+                .filter {
+                    listOf(1, 2, 3).map { it * it }.size > 1
+                }!!
+                .map {


shouldn't this be as below

}!!.map {

No, it disaligns filter and map too much. At least, I found it very distracting.

atulgpt · 2023-08-14T18:00:59Z

...c/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationRuleTest.kt

+            """.trimIndent()
+        val formattedCode =
+            """
+            val foo = listOf(1, 2, 3)


should we also test nested chains? for example

val foo = listOf(1, 2, 3).foo1(listOf(1, 2, 3).foo1().foo2().foo3().foo4().foo5().foo6()).foo2().foo3().foo4().foo5().foo6()

This is already catered for. Above is formatted as:

val foo = listOf(1, 2, 3) .foo1( listOf(1, 2, 3) .foo1() .foo2() .foo3() .foo4() .foo5() .foo6(), ).foo2() .foo3() .foo4() .foo5() .foo6()

atulgpt · 2023-08-14T18:06:54Z

...c/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationRuleTest.kt

+    }
+
+    @Test
+    fun `Given nested chains which are correctly wrapped`() {


should we also add TC with index operator like below

list(1)[ 0 ] .inc() list(1)[ 0 ]. inc() list(1)[ 0 ]!! .inc()

Hmm, this is not handled well (yet). It is formatted as:

list(1)[ 0, ] .inc() list(1)[ 0, ] ?.inc() // Assumption is that here the `?.` chain operator was intended list(1)[ 0, ]!! .inc()

So a TC and fix is needed. I would say that expected outcome should be:

list(1)[ 0, ].inc() list(1)[ 0, ]?.inc() // Assumption is that here the `?.` chain operator was intended list(1)[ 0, ]!! .inc()

Array access expressions are now added.

...c/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationRuleTest.kt

paul-dingemans requested changes Jun 25, 2023

View reviewed changes

atulgpt force-pushed the fixes/1953/chained-method-continuation branch from 2cb679e to 4842266 Compare July 25, 2023 20:27

atulgpt closed this Jul 25, 2023

atulgpt reopened this Jul 25, 2023

atulgpt force-pushed the fixes/1953/chained-method-continuation branch 2 times, most recently from 038746c to dec3753 Compare July 25, 2023 20:37

atulgpt commented Jul 25, 2023

View reviewed changes

...ndard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuation.kt Outdated Show resolved Hide resolved

...ndard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuation.kt Outdated Show resolved Hide resolved

atulgpt commented Jul 26, 2023

View reviewed changes

...d/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/ChainMethodContinuationTest.kt Outdated Show resolved Hide resolved

atulgpt added 6 commits August 1, 2023 21:52

Add ChainMethodContinuation(chain-method-continuation) rule

64fd90b

This rule ensures chain operators(`.` or `?.`) aligns with next call When there is `}` in the new line this also ensures that the chain operators align with `}` along with next call method

Run the rule in Ktlint repo and update the code

bb12ba6

Update CHANGELOG.md and experimental.md

9c0c55c

Handle comments in between chains

e287079

Handle minor comments Update docs and remove release docs

Simplify the code to remove the need to structure changes

78e4abf

Simplify the error message

Apply ktlint

baef5ba

atulgpt force-pushed the fixes/1953/chained-method-continuation branch from dec3753 to baef5ba Compare August 1, 2023 16:28

Wrap map to separate line

41c1721

Remove the usage of `noNewLineInOpenRange`

atulgpt force-pushed the fixes/1953/chained-method-continuation branch from 7b2f9af to 41c1721 Compare August 2, 2023 09:48

atulgpt and others added 12 commits August 4, 2023 17:35

Run the rule in Ktlint repo and update the code

4e0a47b

Revert changes on documentation of currently released version

90fa4e6

Mitigate unwanted side effects found during format of ktlint code

8329e84

Fix lint violations

2448209

Move section to alphabetical position of rule

c92dc9e

Rename rule

95d4cb5

Add configuration property for the number of chain operators which fo…

db3f969

…rces the chain method to be wrapped even when the maximum line length is not exceeded

Fix lint violations

e8efc6c

Update public API

1d4d3a0

- Rename ChainMethodContinuation to ChainMethodContinuationRule - Add new function replaceStringTemplatePlaceholder in TestLiterals

Merge remote-tracking branch 'origin/master' into pr/2088_with_master

78b0c7e

# Conflicts: # CHANGELOG.md # documentation/release-latest/docs/rules/experimental.md

Fix problems after merge

74660d8

atulgpt commented Aug 14, 2023

View reviewed changes

paul-dingemans added 2 commits August 15, 2023 16:58

Fix array access expression

87eb55f

Fix lint violations

f15c0d8

paul-dingemans approved these changes Aug 15, 2023

View reviewed changes

paul-dingemans merged commit 26e2837 into pinterest:master Aug 15, 2023
21 checks passed

paul-dingemans added the feature changelog label Aug 26, 2023

paul-dingemans changed the title ~~Fixes/1953/chained method continuation~~ Add new experimental rule chain-method-continuation Aug 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new experimental rule `chain-method-continuation` #2088

Add new experimental rule `chain-method-continuation` #2088

atulgpt commented Jun 24, 2023 •

edited

Loading

paul-dingemans commented Jun 25, 2023

atulgpt Aug 14, 2023

paul-dingemans Aug 14, 2023

atulgpt Aug 14, 2023

paul-dingemans Aug 14, 2023

atulgpt Aug 14, 2023

paul-dingemans Aug 14, 2023

paul-dingemans Aug 15, 2023

Add new experimental rule chain-method-continuation #2088

Add new experimental rule chain-method-continuation #2088

Conversation

atulgpt commented Jun 24, 2023 • edited Loading

Description

Checklist

paul-dingemans commented Jun 25, 2023

atulgpt Aug 14, 2023

Choose a reason for hiding this comment

paul-dingemans Aug 14, 2023

Choose a reason for hiding this comment

atulgpt Aug 14, 2023

Choose a reason for hiding this comment

paul-dingemans Aug 14, 2023

Choose a reason for hiding this comment

atulgpt Aug 14, 2023

Choose a reason for hiding this comment

paul-dingemans Aug 14, 2023

Choose a reason for hiding this comment

paul-dingemans Aug 15, 2023

Choose a reason for hiding this comment

Add new experimental rule `chain-method-continuation` #2088

Add new experimental rule `chain-method-continuation` #2088

atulgpt commented Jun 24, 2023 •

edited

Loading