Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix errors with detektGenerateConfig #5199

Merged
merged 3 commits into from Aug 8, 2022
Merged

Fix errors with detektGenerateConfig #5199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a89de22
Don't use a collection
BraisGabin Aug 7, 2022
9857fc8
Don't use objects
BraisGabin Aug 7, 2022
3454a53
Always execute DetektGenerateConfigTask in serial
BraisGabin Aug 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 14 additions & 12 deletions detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektGenerateConfigTask.kt
View file
Open in desktop
Expand Up @@ -8,8 +8,9 @@ import io.gitlab.arturbosch.detekt.invoke.DetektInvoker
import io.gitlab.arturbosch.detekt.invoke.GenerateConfigArgument
import org.gradle.api.DefaultTask
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.Provider
import org.gradle.api.services.BuildService
import org.gradle.api.services.BuildServiceParameters
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.InputFiles
Expand All @@ -19,13 +20,11 @@ import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.TaskAction
import org.gradle.language.base.plugins.LifecycleBasePlugin
import java.io.File
import java.nio.file.Files
import javax.inject.Inject

@CacheableTask
abstract class DetektGenerateConfigTask @Inject constructor(
private val objects: ObjectFactory
) : DefaultTask() {
abstract class DetektGenerateConfigTask : DefaultTask() {

init {
description = "Generate a detekt configuration file inside your project."
Expand All @@ -45,34 +44,37 @@ abstract class DetektGenerateConfigTask @Inject constructor(

private val defaultConfigPath = project.rootDir.toPath().resolve(CONFIG_DIR_NAME).resolve(CONFIG_FILE)

private val configurationToUse: ConfigurableFileCollection
private val configurationToUse: File
get() = if (config.isEmpty) {
objects.fileCollection().from(defaultConfigPath)
defaultConfigPath.toFile()
} else {
config
config.last()
}

Comment on lines +47 to 53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to confirm that these changes are mainly for refactoring.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

@get:Internal
internal val arguments: Provider<List<String>> = project.provider {
listOf(
GenerateConfigArgument,
ConfigArgument(configurationToUse.last())
ConfigArgument(configurationToUse)
).flatMap(CliArgument::toArgument)
}

@TaskAction
fun generateConfig() {
if (configurationToUse.last().exists()) {
logger.warn("Skipping config file generation; file already exists at ${configurationToUse.last()}")
if (configurationToUse.exists()) {
logger.warn("Skipping config file generation; file already exists at $configurationToUse")
return
}

Files.createDirectories(configurationToUse.last().parentFile.toPath())
Files.createDirectories(configurationToUse.parentFile.toPath())

DetektInvoker.create(task = this).invokeCli(
arguments = arguments.get(),
classpath = detektClasspath.plus(pluginClasspath),
taskName = name,
)
}

@Suppress("UnnecessaryAbstractClass")
abstract class SingleExecutionBuildService : BuildService<BuildServiceParameters.None>
Fixed Show fixed Hide fixed
}
8 changes: 8 additions & 0 deletions detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt
View file
Open in desktop
Expand Up @@ -60,8 +60,16 @@ class DetektPlugin : Plugin<Project> {
}

private fun Project.registerGenerateConfigTask(extension: DetektExtension) {
val detektGenerateConfigSingleExecution = project.gradle.sharedServices.registerIfAbsent(
"DetektGenerateConfigSingleExecution",
DetektGenerateConfigTask.SingleExecutionBuildService::class.java
) { spec ->
spec.maxParallelUsages.set(1)
}

tasks.register(GENERATE_CONFIG, DetektGenerateConfigTask::class.java) {
it.config.setFrom(project.provider { extension.config })
it.usesService(detektGenerateConfigSingleExecution)
}
}

Expand Down