/
FinalNewline.kt
31 lines (26 loc) · 1.48 KB
/
FinalNewline.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
package io.gitlab.arturbosch.detekt.formatting.wrappers
import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties
import com.pinterest.ktlint.core.api.UsesEditorConfigProperties
import com.pinterest.ktlint.ruleset.standard.FinalNewlineRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
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/#final-newline) for documentation.
*
* This rules overlaps with [style>NewLineAtEndOfFile](https://detekt.dev/style.html#newlineatendoffile)
* from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
class FinalNewline(config: Config) : FormattingRule(config) {
override val wrapping = FinalNewlineRule()
override val issue = issueFor("Detects missing final newlines")
@Configuration("report absence or presence of a newline")
private val insertFinalNewLine by config(true)
override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> =
mapOf(DefaultEditorConfigProperties.insertNewLineProperty to insertFinalNewLine.toString())
}