/
AbstractCheckSupport.kt
242 lines (215 loc) · 9.38 KB
/
AbstractCheckSupport.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*-
* #%L
* ktlint-maven-plugin
* %%
* Copyright (C) 2018 GantSign Ltd.
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
package com.github.gantsign.maven.plugin.ktlint.internal
import com.github.gantsign.maven.plugin.ktlint.MavenLogReporterProvider
import com.github.gantsign.maven.plugin.ktlint.ReporterConfig
import com.pinterest.ktlint.core.KtLint
import com.pinterest.ktlint.core.LintError
import com.pinterest.ktlint.core.Reporter
import com.pinterest.ktlint.core.ReporterProvider
import com.pinterest.ktlint.core.RuleProvider
import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties
import com.pinterest.ktlint.core.api.EditorConfigOverride
import com.pinterest.ktlint.core.api.EditorConfigOverride.Companion.plus
import java.io.File
import java.io.PrintStream
import java.nio.charset.Charset
import java.nio.file.Files
import java.nio.file.Paths
import java.util.ServiceLoader
import org.apache.maven.plugin.MojoFailureException
import org.apache.maven.plugin.logging.Log
import org.apache.maven.shared.utils.io.DirectoryScanner
internal abstract class AbstractCheckSupport(
log: Log,
basedir: File,
private val modulePackaging: String,
private val sources: List<Sources>,
private val charset: Charset,
android: Boolean,
private val reporterConfig: Set<ReporterConfig>,
protected val verbose: Boolean,
private var reporterColor: Boolean,
private var reporterColorName: String,
enableExperimentalRules: Boolean
) : AbstractLintSupport(log, basedir, android, enableExperimentalRules) {
protected open val reporter: Reporter
get() {
data class ReporterTemplate(
val id: String,
val config: Map<String, String>,
var output: String?
)
val templates: List<ReporterTemplate> =
reporterConfig
.map { reporter: ReporterConfig ->
val (reporterId, output) = reporter
if (reporterId == null) {
throw MojoFailureException("Unable to find reporter without id")
}
val properties: Map<String, String> =
reporter.properties?.asSequence()?.associate { (key, value) ->
(key?.toString() ?: "") to (value?.toString() ?: "")
} ?: emptyMap()
ReporterTemplate(
id = reporterId,
config = mapOf(
"verbose" to verbose.toString(),
"color" to reporterColor.toString(),
"color_name" to reporterColorName
) + properties,
output = output?.toString()
)
}
.distinct()
val reporterLoader = ServiceLoader.load(ReporterProvider::class.java)
val reporterProviderById = reporterLoader.associateBy { it.id }
for ((id) in reporterProviderById) {
log.debug("Discovered reporter '$id'")
}
fun ReporterTemplate.toReporter(): Reporter {
val reporterProvider = reporterProviderById[id]
if (reporterProvider == null) {
val availableReporters = reporterProviderById.keys.sorted()
throw MojoFailureException(
"Error: reporter '$id' wasn't found (available: " +
"${availableReporters.joinToString(",")})"
)
}
if (log.isDebugEnabled) {
log.debug(
"Initializing '$id' reporter with $config" +
(output?.let { ", output=$it" } ?: "")
)
}
val stream =
output?.let {
Files.createDirectories(Paths.get(it).parent)
return@let PrintStream(it, "UTF-8")
} ?: System.out
val reporter =
if (reporterProvider is MavenLogReporterProvider) {
reporterProvider.get(log, config)
} else reporterProvider.get(stream, config)
if (output == null) {
return reporter
}
return object : Reporter by reporter {
override fun afterAll() {
reporter.afterAll()
stream.close()
}
}
}
return Reporter.from(*templates.map(ReporterTemplate::toReporter).toTypedArray())
}
protected fun hasErrors(reporter: Reporter): Boolean {
var hasErrors = false
val checkedFiles = mutableSetOf<File>()
for ((isIncluded, sourceRoots, includes, excludes) in sources) {
if (!isIncluded) {
log.debug("Source roots not included: $sourceRoots")
continue
}
for (sourceRoot in sourceRoots) {
if (!sourceRoot.exists()) {
val msg = "Source root doesn't exist: ${sourceRoot.toRelativeString(basedir)}"
if (modulePackaging == "pom") {
log.debug(msg)
} else {
log.warn(msg)
}
continue
}
if (!sourceRoot.isDirectory) {
throw MojoFailureException(
"Source root is not a directory: ${sourceRoot.toRelativeString(basedir)}"
)
}
val includesArray =
includes.takeUnless(Set<String>::isEmpty)?.toTypedArray() ?: arrayOf(
"**/*.kt",
"**/*.kts"
)
val excludesArray = excludes.toTypedArray()
val ds = DirectoryScanner().apply {
setIncludes(*includesArray)
setExcludes(*excludesArray)
basedir = sourceRoot
setCaseSensitive(true)
}
ds.scan()
val sourceFiles = ds.includedFiles.map { File(sourceRoot, it) }
sourceFiles.forEach { file ->
if (!checkedFiles.add(file.canonicalFile)) {
return@forEach
}
val absolutePath = file.absolutePath
val baseRelativePath = file.toRelativeString(basedir)
reporter.before(baseRelativePath)
log.debug("checking: $baseRelativePath")
val editorConfigOverride = EditorConfigOverride.emptyEditorConfigOverride
if (android) {
editorConfigOverride.plus(DefaultEditorConfigProperties.codeStyleSetProperty to android)
}
val sourceText = file.readText(charset)
lintFile(
absolutePath,
sourceText,
ruleProviders,
{ error ->
reporter.onLintError(baseRelativePath, error, false)
val lintError =
"$baseRelativePath:${error.line}:${error.col}: ${error.detail}"
log.debug("Style error > $lintError")
hasErrors = true
},
editorConfigOverride
)
reporter.after(baseRelativePath)
}
}
}
reporter.afterAll()
return hasErrors
}
private fun lintFile(
fileName: String,
sourceText: String,
ruleProviders: Set<RuleProvider>,
onError: (error: LintError) -> Unit,
editorConfigOverride: EditorConfigOverride
) = KtLint.lint(
KtLint.ExperimentalParams(
fileName = fileName,
text = sourceText,
ruleProviders = ruleProviders,
script = !fileName.endsWith(".kt", ignoreCase = true),
cb = { e, _ -> onError(e) },
editorConfigOverride = editorConfigOverride
)
)
}