From 5af7b73a4390668fb8dd1cf65a82704b4135b0ea Mon Sep 17 00:00:00 2001 From: Chao Zhang Date: Sun, 6 Nov 2022 19:27:20 -0800 Subject: [PATCH 1/5] Update default config of TrailingComma to upstream --- .gitignore | 3 +++ .../formatting/wrappers/TrailingCommaOnCallSite.kt | 11 +++++++++-- .../wrappers/TrailingCommaOnDeclarationSite.kt | 11 +++++++++-- .../src/main/resources/config/config.yml | 4 ++-- 4 files changed, 23 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index bb9ded8bd48..91b90e2e8d5 100644 --- a/.gitignore +++ b/.gitignore @@ -166,3 +166,6 @@ target/ /website/docs/rules/*.md /website/static/kdoc /website/docs/gettingstarted/_cli-options.md + +# Jenv +.java-version diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt index 855055f4831..9bcffad7c30 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt @@ -3,13 +3,17 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers import com.pinterest.ktlint.core.api.UsesEditorConfigProperties import com.pinterest.ktlint.ruleset.standard.TrailingCommaOnCallSiteRule import io.gitlab.arturbosch.detekt.api.Config -import io.gitlab.arturbosch.detekt.api.config +import io.gitlab.arturbosch.detekt.api.configWithAndroidVariants import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable import io.gitlab.arturbosch.detekt.api.internal.Configuration import io.gitlab.arturbosch.detekt.formatting.FormattingRule /** * See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/) for documentation. + * + * [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends + * trailing comma encourage the use of trailing commas at the declaration site and + * leaves it at your discretion for the call site. */ @AutoCorrectable(since = "1.22.0") class TrailingCommaOnCallSite(config: Config) : FormattingRule(config) { @@ -18,7 +22,10 @@ class TrailingCommaOnCallSite(config: Config) : FormattingRule(config) { override val issue = issueFor("Rule to mandate/forbid trailing commas at call sites") @Configuration("Defines whether a trailing comma (or no trailing comma) should be enforced at call sites") - private val useTrailingCommaOnCallSite by config(false) + private val useTrailingCommaOnCallSite by configWithAndroidVariants( + defaultValue = true, + defaultAndroidValue = false, + ) override fun overrideEditorConfigProperties(): Map, String> = mapOf( diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt index 6c6bdb0c815..a1ea8e082ac 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt @@ -3,13 +3,17 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers import com.pinterest.ktlint.core.api.UsesEditorConfigProperties import com.pinterest.ktlint.ruleset.standard.TrailingCommaOnDeclarationSiteRule import io.gitlab.arturbosch.detekt.api.Config -import io.gitlab.arturbosch.detekt.api.config +import io.gitlab.arturbosch.detekt.api.configWithAndroidVariants import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable import io.gitlab.arturbosch.detekt.api.internal.Configuration import io.gitlab.arturbosch.detekt.formatting.FormattingRule /** * See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/) for documentation. + * + * [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends + * trailing comma encourage the use of trailing commas at the declaration site and + * leaves it at your discretion for the call site. */ @AutoCorrectable(since = "1.22.0") class TrailingCommaOnDeclarationSite(config: Config) : FormattingRule(config) { @@ -18,7 +22,10 @@ class TrailingCommaOnDeclarationSite(config: Config) : FormattingRule(config) { override val issue = issueFor("Rule to mandate/forbid trailing commas at declaration sites") @Configuration("Defines whether a trailing comma (or no trailing comma) should be enforced at declaration sites") - private val useTrailingCommaOnDeclarationSite by config(false) + private val useTrailingCommaOnDeclarationSite by configWithAndroidVariants( + defaultValue = true, + defaultAndroidValue = false, + ) override fun overrideEditorConfigProperties(): Map, String> = mapOf( diff --git a/detekt-formatting/src/main/resources/config/config.yml b/detekt-formatting/src/main/resources/config/config.yml index fdc9e9c2800..3b802ac4658 100644 --- a/detekt-formatting/src/main/resources/config/config.yml +++ b/detekt-formatting/src/main/resources/config/config.yml @@ -182,11 +182,11 @@ formatting: TrailingCommaOnCallSite: active: false autoCorrect: true - useTrailingCommaOnCallSite: false + useTrailingCommaOnCallSite: true TrailingCommaOnDeclarationSite: active: false autoCorrect: true - useTrailingCommaOnDeclarationSite: false + useTrailingCommaOnDeclarationSite: true TypeArgumentListSpacing: active: false autoCorrect: true From 34f356f50a9d0f1bf9aa519bca32f6fcd91b6fea Mon Sep 17 00:00:00 2001 From: Chao Zhang Date: Mon, 7 Nov 2022 19:15:27 -0800 Subject: [PATCH 2/5] Update detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt Co-authored-by: Matthew Haughton <3flex@users.noreply.github.com> --- .../formatting/wrappers/TrailingCommaOnDeclarationSite.kt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt index a1ea8e082ac..502a9bce15e 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt @@ -21,7 +21,7 @@ class TrailingCommaOnDeclarationSite(config: Config) : FormattingRule(config) { override val wrapping = TrailingCommaOnDeclarationSiteRule() override val issue = issueFor("Rule to mandate/forbid trailing commas at declaration sites") - @Configuration("Defines whether a trailing comma (or no trailing comma) should be enforced at declaration sites") + @Configuration("Defines whether trailing commas are required (true) or forbidden (false) at declaration sites") private val useTrailingCommaOnDeclarationSite by configWithAndroidVariants( defaultValue = true, defaultAndroidValue = false, From 476ed79ae9126cb1348f26d41a6ad93942075703 Mon Sep 17 00:00:00 2001 From: Chao Zhang Date: Mon, 7 Nov 2022 19:15:35 -0800 Subject: [PATCH 3/5] Update detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt Co-authored-by: Matthew Haughton <3flex@users.noreply.github.com> --- .../detekt/formatting/wrappers/TrailingCommaOnCallSite.kt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt index 9bcffad7c30..6073dc95a07 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt @@ -21,7 +21,7 @@ class TrailingCommaOnCallSite(config: Config) : FormattingRule(config) { override val wrapping = TrailingCommaOnCallSiteRule() override val issue = issueFor("Rule to mandate/forbid trailing commas at call sites") - @Configuration("Defines whether a trailing comma (or no trailing comma) should be enforced at call sites") + @Configuration("Defines whether trailing commas are required (true) or forbidden (false) at call sites") private val useTrailingCommaOnCallSite by configWithAndroidVariants( defaultValue = true, defaultAndroidValue = false, From 7513394cf4c5de17e5faf6bf4c20e581e9ad3800 Mon Sep 17 00:00:00 2001 From: Chao Zhang Date: Mon, 7 Nov 2022 22:38:43 -0800 Subject: [PATCH 4/5] Update doc to reflect ktlint to be an upstream --- .../detekt/formatting/wrappers/TrailingCommaOnCallSite.kt | 5 ++++- .../formatting/wrappers/TrailingCommaOnDeclarationSite.kt | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt index 6073dc95a07..9da9778101e 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnCallSite.kt @@ -11,9 +11,12 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule /** * See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/) for documentation. * - * [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends + * The default config comes from ktlint and follows these conventions: + * - [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends * trailing comma encourage the use of trailing commas at the declaration site and * leaves it at your discretion for the call site. + * - [Android Kotlin style guide](https://developer.android.com/kotlin/style-guide) does not include + * trailing comma usage yet. */ @AutoCorrectable(since = "1.22.0") class TrailingCommaOnCallSite(config: Config) : FormattingRule(config) { diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt index 502a9bce15e..8ace3cb4911 100644 --- a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt +++ b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/TrailingCommaOnDeclarationSite.kt @@ -11,9 +11,12 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule /** * See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/) for documentation. * - * [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends + * The default config comes from ktlint and follows these conventions: + * - [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends * trailing comma encourage the use of trailing commas at the declaration site and * leaves it at your discretion for the call site. + * - [Android Kotlin style guide](https://developer.android.com/kotlin/style-guide) does not include + * trailing comma usage yet. */ @AutoCorrectable(since = "1.22.0") class TrailingCommaOnDeclarationSite(config: Config) : FormattingRule(config) { From 37ebcecb28d49428614864f90e41c275c6ad26b0 Mon Sep 17 00:00:00 2001 From: Chao Zhang Date: Fri, 18 Nov 2022 10:39:21 -0800 Subject: [PATCH 5/5] Update .gitignore --- .gitignore | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitignore b/.gitignore index 91b90e2e8d5..bb9ded8bd48 100644 --- a/.gitignore +++ b/.gitignore @@ -166,6 +166,3 @@ target/ /website/docs/rules/*.md /website/static/kdoc /website/docs/gettingstarted/_cli-options.md - -# Jenv -.java-version