/
TrailingCommaOnDeclarationSite.kt
38 lines (33 loc) · 1.84 KB
/
TrailingCommaOnDeclarationSite.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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.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.
*
* 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) {
override val wrapping = TrailingCommaOnDeclarationSiteRule()
override val issue = issueFor("Rule to mandate/forbid trailing commas 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,
)
override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> =
mapOf(
TrailingCommaOnDeclarationSiteRule.allowTrailingCommaProperty to
useTrailingCommaOnDeclarationSite.toString(),
)
}