forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Detekt.kt
294 lines (252 loc) · 11.4 KB
/
Detekt.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
package io.gitlab.arturbosch.detekt
import io.gitlab.arturbosch.detekt.extensions.DetektExtension
import io.gitlab.arturbosch.detekt.extensions.DetektReport
import io.gitlab.arturbosch.detekt.extensions.DetektReportType
import io.gitlab.arturbosch.detekt.extensions.DetektReports
import io.gitlab.arturbosch.detekt.invoke.AllRulesArgument
import io.gitlab.arturbosch.detekt.invoke.AutoCorrectArgument
import io.gitlab.arturbosch.detekt.invoke.BasePathArgument
import io.gitlab.arturbosch.detekt.invoke.BaselineArgument
import io.gitlab.arturbosch.detekt.invoke.BuildUponDefaultConfigArgument
import io.gitlab.arturbosch.detekt.invoke.ClasspathArgument
import io.gitlab.arturbosch.detekt.invoke.CliArgument
import io.gitlab.arturbosch.detekt.invoke.ConfigArgument
import io.gitlab.arturbosch.detekt.invoke.CustomReportArgument
import io.gitlab.arturbosch.detekt.invoke.DebugArgument
import io.gitlab.arturbosch.detekt.invoke.DefaultReportArgument
import io.gitlab.arturbosch.detekt.invoke.DetektInvoker
import io.gitlab.arturbosch.detekt.invoke.DisableDefaultRuleSetArgument
import io.gitlab.arturbosch.detekt.invoke.FailFastArgument
import io.gitlab.arturbosch.detekt.invoke.InputArgument
import io.gitlab.arturbosch.detekt.invoke.JvmTargetArgument
import io.gitlab.arturbosch.detekt.invoke.LanguageVersionArgument
import io.gitlab.arturbosch.detekt.invoke.ParallelArgument
import io.gitlab.arturbosch.detekt.invoke.isDryRunEnabled
import org.gradle.api.Action
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.file.Directory
import org.gradle.api.file.FileTree
import org.gradle.api.file.RegularFile
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.Property
import org.gradle.api.provider.Provider
import org.gradle.api.reporting.ReportingExtension
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.Console
import org.gradle.api.tasks.IgnoreEmptyDirectories
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.Internal
import org.gradle.api.tasks.Optional
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.OutputFiles
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.SkipWhenEmpty
import org.gradle.api.tasks.SourceTask
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.VerificationTask
import org.gradle.api.tasks.options.Option
import org.gradle.language.base.plugins.LifecycleBasePlugin
import java.io.File
import javax.inject.Inject
@CacheableTask
open class Detekt @Inject constructor(
private val objects: ObjectFactory
) : SourceTask(), VerificationTask {
@get:Classpath
val detektClasspath: ConfigurableFileCollection = objects.fileCollection()
@get:Classpath
val pluginClasspath: ConfigurableFileCollection = objects.fileCollection()
@get:InputFile
@get:Optional
@get:PathSensitive(PathSensitivity.RELATIVE)
val baseline: RegularFileProperty = project.objects.fileProperty()
@get:InputFiles
@get:Optional
@get:PathSensitive(PathSensitivity.RELATIVE)
val config: ConfigurableFileCollection = objects.fileCollection()
@get:Classpath
@get:Optional
val classpath: ConfigurableFileCollection = objects.fileCollection()
@get:Input
@get:Optional
internal val languageVersionProp: Property<String> = project.objects.property(String::class.javaObjectType)
var languageVersion: String
@Internal
get() = languageVersionProp.get()
set(value) = languageVersionProp.set(value)
@get:Input
@get:Optional
internal val jvmTargetProp: Property<String> = project.objects.property(String::class.javaObjectType)
var jvmTarget: String
@Internal
get() = jvmTargetProp.get()
set(value) = jvmTargetProp.set(value)
@get:Internal
internal val debugProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
var debug: Boolean
@Console
get() = debugProp.getOrElse(false)
set(value) = debugProp.set(value)
@get:Internal
internal val parallelProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
var parallel: Boolean
@Internal
get() = parallelProp.getOrElse(false)
set(value) = parallelProp.set(value)
@get:Internal
internal val disableDefaultRuleSetsProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
var disableDefaultRuleSets: Boolean
@Input
get() = disableDefaultRuleSetsProp.getOrElse(false)
set(value) = disableDefaultRuleSetsProp.set(value)
@get:Internal
internal val buildUponDefaultConfigProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
var buildUponDefaultConfig: Boolean
@Input
get() = buildUponDefaultConfigProp.getOrElse(false)
set(value) = buildUponDefaultConfigProp.set(value)
@get:Internal
internal val failFastProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
@Deprecated("Please use the buildUponDefaultConfig and allRules flags instead.", ReplaceWith("allRules"))
var failFast: Boolean
@Input
get() = failFastProp.getOrElse(false)
set(value) = failFastProp.set(value)
@get:Internal
internal val allRulesProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
var allRules: Boolean
@Input
get() = allRulesProp.getOrElse(false)
set(value) = allRulesProp.set(value)
@get:Internal
internal val ignoreFailuresProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
@get:Internal
internal val autoCorrectProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)
@set:Option(option = "auto-correct", description = "Allow rules to auto correct code if they support it")
var autoCorrect: Boolean
@Input
get() = autoCorrectProp.getOrElse(false)
set(value) = autoCorrectProp.set(value)
/**
* Respect only the file path for incremental build. Using @InputFile respects both file path and content.
*/
@get:Input
@get:Optional
internal val basePathProp: Property<String> = project.objects.property(String::class.java)
var basePath: String
@Internal
get() = basePathProp.getOrElse("")
set(value) = basePathProp.set(value)
@get:Internal
var reports: DetektReports = objects.newInstance(DetektReports::class.java)
@get:Internal
val reportsDir: Property<File> = project.objects.property(File::class.java)
val xmlReportFile: Provider<RegularFile>
@OutputFile
@Optional
get() = getTargetFileProvider(reports.xml)
val htmlReportFile: Provider<RegularFile>
@OutputFile
@Optional
get() = getTargetFileProvider(reports.html)
val txtReportFile: Provider<RegularFile>
@OutputFile
@Optional
get() = getTargetFileProvider(reports.txt)
val sarifReportFile: Provider<RegularFile>
@OutputFile
@Optional
get() = getTargetFileProvider(reports.sarif)
val mdReportFile: Provider<RegularFile>
@OutputFile
@Optional
get() = getTargetFileProvider(reports.md)
internal val customReportFiles: ConfigurableFileCollection
@OutputFiles
@Optional
get() = objects.fileCollection().from(reports.custom.mapNotNull { it.outputLocation.asFile.orNull })
private val defaultReportsDir: Directory = project.layout.buildDirectory.get()
.dir(ReportingExtension.DEFAULT_REPORTS_DIR_NAME)
.dir("detekt")
private val isDryRun: Boolean = project.isDryRunEnabled()
init {
group = LifecycleBasePlugin.VERIFICATION_GROUP
}
@get:Internal
internal val arguments: Provider<List<String>> = project.provider {
listOf(
InputArgument(source),
ClasspathArgument(classpath),
LanguageVersionArgument(languageVersionProp.orNull),
JvmTargetArgument(jvmTargetProp.orNull),
ConfigArgument(config),
BaselineArgument(baseline.orNull),
DefaultReportArgument(DetektReportType.XML, xmlReportFile.orNull),
DefaultReportArgument(DetektReportType.HTML, htmlReportFile.orNull),
DefaultReportArgument(DetektReportType.TXT, txtReportFile.orNull),
DefaultReportArgument(DetektReportType.SARIF, sarifReportFile.orNull),
DefaultReportArgument(DetektReportType.MD, mdReportFile.orNull),
DebugArgument(debugProp.getOrElse(false)),
ParallelArgument(parallelProp.getOrElse(false)),
BuildUponDefaultConfigArgument(buildUponDefaultConfigProp.getOrElse(false)),
FailFastArgument(failFastProp.getOrElse(false)),
AllRulesArgument(allRulesProp.getOrElse(false)),
AutoCorrectArgument(autoCorrectProp.getOrElse(false)),
BasePathArgument(basePathProp.orNull),
DisableDefaultRuleSetArgument(disableDefaultRuleSetsProp.getOrElse(false))
).plus(convertCustomReportsToArguments()).flatMap(CliArgument::toArgument)
}
@InputFiles
@SkipWhenEmpty
@IgnoreEmptyDirectories
@PathSensitive(PathSensitivity.RELATIVE)
override fun getSource(): FileTree = super.getSource()
@Input
override fun getIgnoreFailures(): Boolean = ignoreFailuresProp.getOrElse(false)
override fun setIgnoreFailures(value: Boolean) {
ignoreFailuresProp.set(value)
}
fun reports(configure: Action<DetektReports>) {
configure.execute(reports)
}
@TaskAction
fun check() {
if (failFastProp.getOrElse(false)) {
logger.warn("'failFast' is deprecated. Please use 'buildUponDefaultConfig' together with 'allRules'.")
}
DetektInvoker.create(task = this, isDryRun = isDryRun).invokeCli(
arguments = arguments.get(),
ignoreFailures = ignoreFailures,
classpath = detektClasspath.plus(pluginClasspath),
taskName = name
)
}
private fun convertCustomReportsToArguments(): List<CustomReportArgument> = reports.custom.map {
val reportId = it.reportId
val destination = it.outputLocation.asFile.orNull
checkNotNull(reportId) { "If a custom report is specified, the reportId must be present" }
check(!DetektReportType.isWellKnownReportId(reportId)) {
"The custom report reportId may not be same as one of the default reports"
}
checkNotNull(destination) { "If a custom report is specified, the destination must be present" }
check(!destination.isDirectory) { "If a custom report is specified, the destination must be not a directory" }
CustomReportArgument(reportId, objects.fileProperty().getOrElse { destination })
}
private fun getTargetFileProvider(
report: DetektReport
): RegularFileProperty {
val isEnabled = report.required.getOrElse(DetektExtension.DEFAULT_REPORT_ENABLED_VALUE)
val provider = objects.fileProperty()
if (isEnabled) {
val destination = report.outputLocation.asFile.orNull ?: reportsDir.getOrElse(defaultReportsDir.asFile)
.resolve("${DetektReport.DEFAULT_FILENAME}.${report.type.extension}")
provider.set(destination)
}
return provider
}
}