Upgrade ktlint to 0.47.1 by chao2zhang · Pull Request #5312 · detekt/detekt

chao2zhang · 2022-09-18T17:55:50Z

Fixes #5281

Release note:

Majority of the changes are:

Rule lifecycle hooks / deprecate RunOnRootOnly visitor modifier
Split rule trailing-comma into trailing-comma-on-call-site and trailing-comma-on-declaration-site (Split TrailingCommaRule pinterest/ktlint#1555)
Fix multiline if-statements multiline-if-else (multiline-if-else: False negatives for android code style pinterest/ktlint#828)

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt

...src/test/kotlin/io/gitlab/arturbosch/detekt/formatting/TrailingCommaOnDeclarationSiteSpec.kt

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt

chao2zhang · 2022-09-18T23:56:41Z

detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/internal/Signatures.kt

+    if (contains(File.separatorChar)) {
+        substringAfterLast(File.separatorChar)
+    } else {
+        this
+    }


This violation is detected once pinterest/ktlint#828 is addressed.

chao2zhang · 2022-09-18T23:57:21Z

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt

+        wrapping.beforeFirstNode(computeEditorConfigProperties())
+        root.node.visitASTNodes()
+        wrapping.afterLastNode()


See Rule lifecycle hooks / deprecate RunOnRootOnly visitor modifier in https://github.com/pinterest/ktlint/releases/tag/0.47.0

chao2zhang · 2022-09-19T00:00:11Z

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt

-    open fun getTextLocationForViolation(node: ASTNode, offset: Int) =
-        TextLocation(node.startOffset, node.psi.endOffset)


This is removed because no rules in Ktlint is RunOnRootNodeOnly. RunOnRootNodeOnly itself is also deprecated and to be removed in 0.48.0

chao2zhang · 2022-09-19T00:00:33Z

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt


-    private fun ruleShouldOnlyRunOnFileNode(node: ASTNode) =
-        runOnRootNodeOnly && node !is FileASTNode
+    private fun ASTNode.isNotDummyElement(): Boolean {


Function is renamed to improve readability and consistency

chao2zhang · 2022-09-19T00:01:51Z

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt

+        TrailingCommaOnCallSite(config), // in standard ruleset but not enabled by default
+        TrailingCommaOnDeclarationSite(config), // in standard ruleset but not enabled by default


TrailingCommaRule is split into two separate rules - pinterest/ktlint#1555

I would propose to keep them disabled because it may sparkle endless conversation within a medium-large sized team

Shouldn't they be enforced by default on declaration site in line with the Kotlin coding conventions?

https://kotlinlang.org/docs/coding-conventions.html#trailing-commas

The Kotlin style guide encourages the use of trailing commas at the declaration site

I also think they should be enabled by default for the call site for the reasons outlined in the coding conventions:

It makes version-control diffs cleaner – as all the focus is on the changed value.

It makes it easy to add and reorder elements – there is no need to add or delete the comma if you manipulate elements.

It's easy to disable for teams that don't want this. I don't think there's a strong reason to deviate from ktlint's default behaviour - and anyone using ktlint directly would have to have the same conversation if they don't like them. It's also easy to disable.

I don't think there's a strong reason to deviate from ktlint's default behaviour

Agree on being consistent with KtLint's behavior

Let me keep this disabled for now in a separate PR because it will cause at least 200+ violations across the codebase - I will create a separate PR to demonstrate what it looks like.

#5386 is the PR to be consistent with ktlint

Shouldn't they be enforced by default on declaration site in line with the Kotlin coding conventions?
Yes, and ktlint's default configuration still diverges from kotlin coding convention. We could configure these rules in a way that conforms to the kotlin coding convention, namely:

TrailingCommaOnDeclarationSite: active = true, useTrailingCommaOnDeclarationSite = true

TrailingCommaOnDeclarationSite: active = false

chao2zhang · 2022-09-19T00:02:22Z

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt

+        getSortedRules().forEach { rule ->
+            rule.visit(root)


I am trying to move more logic into FormattingRule itself to prepare for #5192 (comment)

codecov · 2022-09-30T15:40:10Z

Codecov Report

Merging #5312 (68d4159) into main (7027c27) will decrease coverage by 0.01%.
The diff coverage is 87.50%.

@@             Coverage Diff              @@
##               main    #5312      +/-   ##
============================================
- Coverage     86.11%   86.09%   -0.02%     
+ Complexity     3643     3637       -6     
============================================
  Files           515      516       +1     
  Lines         12085    12098      +13     
  Branches       2161     2156       -5     
============================================
+ Hits          10407    10416       +9     
- Misses          609      613       +4     
  Partials       1069     1069

Impacted Files	Coverage Δ
...turbosch/detekt/formatting/wrappers/Indentation.kt	`100.00% <ø> (ø)`
.../arturbosch/detekt/formatting/wrappers/Wrapping.kt	`100.00% <ø> (ø)`
...etekt/rules/coroutines/RedundantSuspendModifier.kt	`63.63% <40.00%> (-0.65%)`	⬇️
...les/style/ExplicitCollectionElementAccessMethod.kt	`75.55% <50.00%> (-1.72%)`	⬇️
...b/arturbosch/detekt/rules/complexity/LongMethod.kt	`92.15% <66.66%> (+0.15%)`	⬆️
...urbosch/detekt/rules/style/NullableBooleanCheck.kt	`81.81% <66.66%> (+0.86%)`	⬆️
...lab/arturbosch/detekt/formatting/FormattingRule.kt	`92.30% <91.48%> (-5.70%)`	⬇️
...itlab/arturbosch/detekt/api/internal/Signatures.kt	`88.88% <100.00%> (+0.51%)`	⬆️
...ab/arturbosch/detekt/formatting/KtLintMultiRule.kt	`98.73% <100.00%> (+1.99%)`	⬆️
...ekt/formatting/wrappers/TrailingCommaOnCallSite.kt	`100.00% <100.00%> (ø)`
... and 9 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

BraisGabin · 2022-10-04T14:36:42Z

detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/AnnotationExcluderSpec.kt

            val (file, ktAnnotation) = createKtFile("@SinceKotlin")
-            val excluder = @Suppress("DEPRECATION") AnnotationExcluder(file, SplitPattern("SinceKotlin"))
+
+            @Suppress("DEPRECATION")


These seems like a false positive from ktlint, isn't it? They are forcing you to increase the annotation scope.

BraisGabin · 2022-10-04T14:43:23Z

detekt-formatting/src/main/resources/config/config.yml

  StringTemplate:
    active: true
    autoCorrect: true
-  TrailingComma:


This is kind of a breaking change. We should note it. Or adding it to the deprecation list. We don't have a way to deprecated plugin properties... we could use the "standard" one as a workaround for now.

We do - I made this breaking change in ktlint 🙈 Let me add it to the deprecation list

Added to deprecation.properties

Actually it won't work. deprecation.properties only takes care of deprecated rule properties, not the legacy properties that don't work.

cortinico

Change looks good to me, modulo the open comments

3flex

Looks good to me, just need to match the default config with ktlint.

chao2zhang · 2022-10-10T04:26:13Z

With regards to #5312 (comment), it looks like ktlint added a test specifically to ensure that annotation with parameters on expressions are put at a separate line pinterest/ktlint@069583e

I don't hold a strong opinion on this, as it does not conflict with Kotlin official coding convention.

github-actions bot added the dependencies Pull requests that update a dependency file label Sep 18, 2022

vercel bot had a problem deploying to Preview September 18, 2022 18:00 Failure

chao2zhang force-pushed the chao/kt47 branch from 748a3af to b0192a1 Compare September 18, 2022 18:31

github-actions bot added the formatting label Sep 18, 2022

github-advanced-security bot found potential problems Sep 18, 2022

View reviewed changes

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt Fixed Show fixed Hide fixed

vercel bot deployed to Preview September 18, 2022 18:36 View deployment

chao2zhang marked this pull request as draft September 18, 2022 18:41

chao2zhang force-pushed the chao/kt47 branch from b0192a1 to 40702ba Compare September 18, 2022 18:41

github-advanced-security bot found potential problems Sep 18, 2022

View reviewed changes

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt Fixed Show fixed Hide fixed

vercel bot deployed to Preview September 18, 2022 18:47 View deployment

chao2zhang force-pushed the chao/kt47 branch from 40702ba to 9c603d8 Compare September 18, 2022 19:12

vercel bot deployed to Preview September 18, 2022 19:17 View deployment

chao2zhang force-pushed the chao/kt47 branch from 9c603d8 to 80f147a Compare September 18, 2022 19:18

vercel bot deployed to Preview September 18, 2022 19:24 View deployment

chao2zhang force-pushed the chao/kt47 branch from 80f147a to e564057 Compare September 18, 2022 19:36

vercel bot deployed to Preview September 18, 2022 19:41 View deployment

chao2zhang mentioned this pull request Sep 18, 2022

Remove all usages of MutliRule in detekt code base #5192

Closed

7 tasks

chao2zhang force-pushed the chao/kt47 branch from e564057 to 9efcbe7 Compare September 18, 2022 23:35

github-advanced-security bot found potential problems Sep 18, 2022

View reviewed changes

vercel bot deployed to Preview September 18, 2022 23:40 View deployment

chao2zhang force-pushed the chao/kt47 branch 2 times, most recently from 96c7185 to a16d9c7 Compare September 18, 2022 23:45

github-advanced-security bot found potential problems Sep 18, 2022

View reviewed changes

chao2zhang force-pushed the chao/kt47 branch from a16d9c7 to 8ac3be1 Compare September 18, 2022 23:50

github-actions bot added the api label Sep 18, 2022

chao2zhang commented Sep 18, 2022

View reviewed changes

chao2zhang force-pushed the chao/kt47 branch from 8ac3be1 to 0dc4247 Compare September 18, 2022 23:59

chao2zhang commented Sep 19, 2022

View reviewed changes

vercel bot deployed to Preview September 19, 2022 00:05 View deployment

chao2zhang force-pushed the chao/kt47 branch from 0dc4247 to e52a66b Compare September 19, 2022 00:07

Merge remote-tracking branch 'detekt/main' into chao/kt47

044b86b

vercel bot deployed to Preview September 24, 2022 22:30 View deployment

Update detekt rule property names

c141cfa

vercel bot deployed to Preview September 24, 2022 22:41 View deployment

Fix tests

a6d3a1f

vercel bot deployed to Preview September 25, 2022 01:03 View deployment

3flex mentioned this pull request Sep 30, 2022

Upgrade ktlint and switch to the non-experimental TrailingCommaOnCallSiteRule & TrailingCommaOnDeclarationSiteRule #5365

Closed

Merge branch 'main' into chao/kt47

14d3f2b

vercel bot deployed to Preview September 30, 2022 15:34 View deployment

BraisGabin approved these changes Oct 4, 2022

View reviewed changes

cortinico approved these changes Oct 4, 2022

View reviewed changes

3flex approved these changes Oct 6, 2022

View reviewed changes

github-actions bot added the gradle label Oct 7, 2022

vercel bot deployed to Preview October 7, 2022 03:51 View deployment

Add deprecated properties and active rules by default

4c40352

chao2zhang force-pushed the chao/kt47 branch from fe9604c to 4c40352 Compare October 7, 2022 03:54

vercel bot deployed to Preview October 7, 2022 03:59 View deployment

Fix more annotation on separate line

60791ad

vercel bot deployed to Preview October 7, 2022 04:08 View deployment

vercel bot deployed to Preview October 7, 2022 04:14 View deployment

Merge remote-tracking branch 'detekt/main' into chao/kt47

68d4159

chao2zhang force-pushed the chao/kt47 branch from 43a014b to 68d4159 Compare October 7, 2022 04:32

vercel bot deployed to Preview October 7, 2022 04:37 View deployment

chao2zhang merged commit e259980 into detekt:main Oct 7, 2022

chao2zhang deleted the chao/kt47 branch October 7, 2022 05:01

chao2zhang mentioned this pull request Oct 7, 2022

Enable Ktlint two TrailingComma rules to default setting in Ktlint #5386

Closed

sanggggg mentioned this pull request Oct 15, 2022

Continuation indent is doubled when indentation and function signature are enabled #5366

Closed

chao2zhang mentioned this pull request Oct 16, 2022

Deprecate TrailingComma as it's now split in two rules #5423

Merged

		open fun getTextLocationForViolation(node: ASTNode, offset: Int) =
		TextLocation(node.startOffset, node.psi.endOffset)

		TrailingCommaOnCallSite(config), // in standard ruleset but not enabled by default
		TrailingCommaOnDeclarationSite(config), // in standard ruleset but not enabled by default

Uh oh!

Conversation

chao2zhang commented Sep 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chao2zhang Oct 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Sep 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cortinico left a comment

Choose a reason for hiding this comment

Uh oh!

3flex left a comment

Choose a reason for hiding this comment

Uh oh!

chao2zhang commented Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chao2zhang commented Sep 18, 2022 •

edited

Loading

chao2zhang Oct 7, 2022 •

edited

Loading

codecov bot commented Sep 30, 2022 •

edited

Loading

chao2zhang commented Oct 10, 2022 •

edited

Loading