Add ParameterListSpacing rule

detekt · Aug 30, 2022 · 5b44fa7 · 5b44fa7
1 parent b2db163
commit 5b44fa7
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -89,6 +89,8 @@ formatting:
     active: true
   PackageName:
     active: true
+  ParameterListSpacing:
+    active: true
   SpacingAroundAngleBrackets:
     active: true
   SpacingAroundDoubleColon:

diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt
@@ -40,6 +40,7 @@ import io.gitlab.arturbosch.detekt.formatting.wrappers.NoUnusedImports
 import io.gitlab.arturbosch.detekt.formatting.wrappers.NoWildcardImports
 import io.gitlab.arturbosch.detekt.formatting.wrappers.NullableTypeSpacing
 import io.gitlab.arturbosch.detekt.formatting.wrappers.PackageName
+import io.gitlab.arturbosch.detekt.formatting.wrappers.ParameterListSpacing
 import io.gitlab.arturbosch.detekt.formatting.wrappers.ParameterListWrapping
 import io.gitlab.arturbosch.detekt.formatting.wrappers.SpacingAroundAngleBrackets
 import io.gitlab.arturbosch.detekt.formatting.wrappers.SpacingAroundColon
@@ -131,6 +132,7 @@ class KtLintMultiRule(config: Config = Config.empty) :
         KdocWrapping(config),
         ModifierListSpacing(config),
         NullableTypeSpacing(config),
+        ParameterListSpacing(config),
         TypeArgumentListSpacing(config),
         UnnecessaryParenthesesBeforeTrailingLambda(config),
     )

diff --git a/...g/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ParameterListSpacing.kt b/...g/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ParameterListSpacing.kt
@@ -0,0 +1,17 @@
+package io.gitlab.arturbosch.detekt.formatting.wrappers
+
+import com.pinterest.ktlint.ruleset.experimental.ParameterListSpacingRule
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
+import io.gitlab.arturbosch.detekt.formatting.FormattingRule
+
+/**
+ * See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#parameter-list-spacing) for
+ * documentation.
+ */
+@AutoCorrectable(since = "1.22.0")
+class ParameterListSpacing(config: Config) : FormattingRule(config) {
+
+    override val wrapping = ParameterListSpacingRule()
+    override val issue = issueFor("Ensure consistent spacing inside the parameter list.")
+}
diff --git a/detekt-formatting/src/main/resources/config/config.yml b/detekt-formatting/src/main/resources/config/config.yml
@@ -127,6 +127,9 @@ formatting:
   PackageName:
     active: true
     autoCorrect: true
+  ParameterListSpacing:
+    active: false
+    autoCorrect: true
   ParameterListWrapping:
     active: true
     autoCorrect: true