Skip to content

Commit

Permalink
Fix #115 by lazy task sources evaluation (#124)
Browse files Browse the repository at this point in the history 
* Unify project setup

* Add tests covering modified sourcesets

* Lazily evaluate taks sources, use lazy task configuration api

* Add few checks for extension evaluation

* Change function name to match existing naming convention

* Remove unused dependency. Fix test assertion.

* Restore kotlin plugin version. Update comments

* Fix invalid AGP extension usages

* Add test covering new sourceset
Rename variable
  • Loading branch information
@mateuszkwiecinski @jeremymailen
mateuszkwiecinski authored and jeremymailen committed Jan 24, 2020
1 parent 1b86c1a commit 46e7431
Show file tree
Hide file tree
Showing 12 changed files with 460 additions and 121 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
View file
@@ -0,0 +1,5 @@
[*.{kt,kts}]
max_line_length = 140
indent_size = 4
continuation_indent_size = 4
insert_final_newline = true
15 changes: 9 additions & 6 deletions build.gradle
View file
Expand Up @@ -8,7 +8,6 @@ plugins {
}

repositories {
mavenLocal()
jcenter()
google()
}
Expand All @@ -25,14 +24,14 @@ dependencies {
implementation "com.pinterest.ktlint:ktlint-ruleset-standard:$ktlintVers"

compileOnly 'org.jetbrains.kotlin:kotlin-gradle-plugin'
compileOnly 'com.android.tools.build:gradle:3.4.2'
compileOnly 'com.android.tools.build:gradle:3.5.3'

testImplementation 'junit:junit:4.12'
testImplementation 'com.nhaarman.mockitokotlin2:mockito-kotlin:2.1.0'
testRuntime 'com.android.tools.build:gradle:3.4.2'
testImplementation 'junit:junit:4.13'
testImplementation 'com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0'
testImplementation 'org.jetbrains:annotations:18.0.0'
}

// Required to put the Kotlin plugin on the classpath for the functional test suite
// Required to put all `compileOnly` dependencies on the classpath for the functional test suite
tasks.withType(PluginUnderTestMetadata).configureEach {
pluginClasspath.from(configurations.compileOnly)
}
Expand Down Expand Up @@ -64,6 +63,10 @@ pluginBundle {
}
}

java {
withSourcesJar()
}

publishing {
publications {
mavenJava(MavenPublication) {
Expand Down
1 change: 1 addition & 0 deletions gradle.properties
View file
@@ -0,0 +1 @@
kotlin.code.style=official
157 changes: 66 additions & 91 deletions src/main/kotlin/org/jmailen/gradle/kotlinter/KotlinterPlugin.kt
View file
Expand Up @@ -2,13 +2,13 @@ package org.jmailen.gradle.kotlinter

import com.android.build.gradle.BaseExtension
import com.android.build.gradle.api.AndroidSourceSet
import java.io.File
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.file.FileTree
import org.gradle.api.file.SourceDirectorySet
import org.gradle.api.internal.HasConvention
import org.gradle.api.plugins.JavaPluginConvention
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.SourceSet
import org.gradle.api.tasks.SourceSetContainer
import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
Expand All @@ -20,146 +20,121 @@ import org.jmailen.gradle.kotlinter.tasks.LintTask
class KotlinterPlugin : Plugin<Project> {

val extendablePlugins = mapOf(
"org.jetbrains.kotlin.jvm" to KotlinJvmSourceSetResolver,
"kotlin-android" to AndroidSourceSetResolver)

override fun apply(project: Project) {
val kotlinterExtension = project.extensions.create("kotlinter", KotlinterExtension::class.java)

// for known kotlin plugins, create tasks by convention.
val taskCreator = TaskCreator(project)
extendablePlugins.forEach { pluginId, sourceResolver ->
project.plugins.withId(pluginId) {

sourceResolver.applyToAll(project) { id, files ->
taskCreator.createSourceSetTasks(id, files)
}

taskCreator.createParentTasks()
}
}

project.afterEvaluate {
val ktLintParams = KtLintParams(
kotlinterExtension.indentSize,
kotlinterExtension.continuationIndentSize,
kotlinterExtension.experimentalRules,
kotlinterExtension.disabledRules,
project.editorConfigPath()
)

taskCreator.lintTasks.forEach { lintTask ->
lintTask.ignoreFailures = kotlinterExtension.ignoreFailures
lintTask.reports = kotlinterExtension.reporters.associate { reporter ->
reporter to project.reportFile("${lintTask.sourceSetId}-lint.${reporterFileExtension(reporter)}")
"org.jetbrains.kotlin.jvm" to KotlinJvmSourceSetResolver,
"kotlin-android" to AndroidSourceSetResolver
)

override fun apply(project: Project) = with(project) {
val kotlinterExtension = extensions.create("kotlinter", KotlinterExtension::class.java)

// for known kotlin plugins, register tasks by convention.
extendablePlugins.forEach { (pluginId, sourceResolver) ->
pluginManager.withPlugin(pluginId) {

val lintKotlin = registerParentLintTask()
val formatKotlin = registerParentFormatTask()

sourceResolver.applyToAll(project) { id, resolveSources ->
val lintTaskPerSourceSet = tasks.register("lintKotlin${id.capitalize()}", LintTask::class.java) { lintTask ->
lintTask.source(resolveSources)
lintTask.ignoreFailures = kotlinterExtension.ignoreFailures
lintTask.reports = kotlinterExtension.reporters.associate { reporter ->
reporter to reportFile("$id-lint.${reporterFileExtension(reporter)}")
}
lintTask.ktLintParams = kotlinterExtension.toKtLintParams(editorConfigPath())
lintTask.fileBatchSize = kotlinterExtension.fileBatchSize
}
lintKotlin.configure { lintTask ->
lintTask.dependsOn(lintTaskPerSourceSet)
}

val formatKotlinPerVariant = tasks.register("formatKotlin${id.capitalize()}", FormatTask::class.java) { formatTask ->
formatTask.source(resolveSources)
formatTask.report = reportFile("$id-format.txt")
formatTask.ktLintParams = kotlinterExtension.toKtLintParams(editorConfigPath())
formatTask.fileBatchSize = kotlinterExtension.fileBatchSize
}
formatKotlin.configure { formatTask ->
formatTask.dependsOn(formatKotlinPerVariant)
}
}
lintTask.ktLintParams = ktLintParams
lintTask.fileBatchSize = kotlinterExtension.fileBatchSize
}
taskCreator.formatTasks.forEach { formatTask ->
formatTask.ktLintParams = ktLintParams
formatTask.fileBatchSize = kotlinterExtension.fileBatchSize
}
}
}
}

class TaskCreator(private val project: Project) {

val formatTasks = mutableListOf<FormatTask>()
val lintTasks = mutableListOf<LintTask>()

fun createSourceSetTasks(id: String, files: Set<File>) {

formatTasks += project.tasks.create("formatKotlin${id.capitalize()}", FormatTask::class.java) {
it.source(files)
it.report = project.reportFile("$id-format.txt")
}

lintTasks += project.tasks.create("lintKotlin${id.capitalize()}", LintTask::class.java) {
it.source(files)
it.sourceSetId = id
}
}

fun createParentTasks() {
project.tasks.create("formatKotlin") {
it.group = "formatting"
it.description = "Formats the Kotlin source files."
it.dependsOn(formatTasks)
}

val lintKotlin = project.tasks.create("lintKotlin") {
private fun Project.registerParentLintTask() =
tasks.register("lintKotlin") {
it.group = "formatting"
it.description = "Runs lint on the Kotlin source files."
it.dependsOn(lintTasks)
}.also { lintKotlin ->
tasks.named("check").configure { check -> check.dependsOn(lintKotlin) }
}

project.tasks.getByName("check") {
it.dependsOn(lintKotlin)
private fun Project.registerParentFormatTask() =
tasks.register("formatKotlin") {
it.group = "formatting"
it.description = "Formats the Kotlin source files."
}
}
}

typealias SourceSetAction = (String, Set<File>) -> Unit
internal typealias SourceSetAction = (String, Provider<FileTree>) -> Unit

interface SourceSetResolver {
fun applyToAll(project: Project, action: SourceSetAction)
}

object KotlinJvmSourceSetResolver : SourceSetResolver {
internal object KotlinJvmSourceSetResolver : SourceSetResolver {

override fun applyToAll(project: Project, action: SourceSetAction) {
getSourceSets(project).all { sourceSet ->
getKotlinFiles(sourceSet)?.let { files ->
action(getSourceSetName(sourceSet)!!.id, files)
sourceSet.kotlin?.let { directorySet ->
action(directorySet.name.id, project.provider { directorySet })
}
}
}

private fun getSourceSets(project: Project): SourceSetContainer =
project.convention.getPlugin(JavaPluginConvention::class.java).sourceSets

private fun getSourceSetName(sourceSet: SourceSet) = sourceSet.kotlin?.name

private fun getKotlinFiles(sourceSet: SourceSet) = sourceSet.kotlin?.files

private val SourceSet.kotlin: SourceDirectorySet?
get() = ((getConvention("kotlin") ?: getConvention("kotlin2js")) as? KotlinSourceSet)?.kotlin

private fun SourceSet.getConvention(name: String): Any? =
(this as HasConvention).convention.plugins[name]
}

object AndroidSourceSetResolver : SourceSetResolver {
internal object AndroidSourceSetResolver : SourceSetResolver {

override fun applyToAll(project: Project, action: SourceSetAction) {
val android = project.extensions.findByName("android")
(android as? BaseExtension)?.let {
it.sourceSets.all { sourceSet ->
val id = sourceSet.name.id
val files = getKotlinFiles(project, sourceSet)
if (files.isNotEmpty()) {
action(id, files)
}
action(id, project.provider { getKotlinFiles(project, sourceSet) })
}
}
}

private fun getKotlinFiles(project: Project, sourceSet: AndroidSourceSet) = sourceSet.java.srcDirs.map { dir ->
project.fileTree(dir) {
it.include("**/*.kt")
}
project.fileTree(dir) { it.include("**/*.kt") }
}.reduce { merged: FileTree, tree ->
merged.plus(tree)
}.files
merged + tree
}
}

val String.id
private fun KotlinterExtension.toKtLintParams(editorConfigPath: String?) = KtLintParams(
indentSize,
continuationIndentSize,
experimentalRules,
disabledRules,
editorConfigPath
)

internal val String.id
get() = split(" ").first()

fun Project.reportFile(name: String) = file("${project.buildDir}/reports/ktlint/$name")
internal fun Project.reportFile(name: String) = file("$buildDir/reports/ktlint/$name")

fun Project.editorConfigPath() = with(rootProject.file(".editorconfig")) {
internal fun Project.editorConfigPath() = with(rootProject.file(".editorconfig")) {
if (this.exists()) this.path else null
}
7 changes: 2 additions & 5 deletions src/main/kotlin/org/jmailen/gradle/kotlinter/tasks/LintTask.kt
View file
Expand Up @@ -6,7 +6,6 @@ import org.gradle.api.GradleException
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.Internal
import org.gradle.api.tasks.OutputFiles
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
Expand Down Expand Up @@ -65,17 +64,15 @@ open class LintTask @Inject constructor(
ktLintParams.editorConfigPath = editorConfigPath
}

@Internal
var sourceSetId = ""

@TaskAction
fun run() {
val hasErrorReporter = HasErrorReporter()
val reporters = reports.map { (reporter, report) ->
reporterFor(reporter, report)
} + hasErrorReporter
val executionContextRepository = ExecutionContextRepository.lintInstance
val executionContextRepositoryId = executionContextRepository.register(LintExecutionContext(defaultRuleSetProviders, reporters, logger))
val executionContextRepositoryId =
executionContextRepository.register(LintExecutionContext(defaultRuleSetProviders, reporters, logger))

reporters.onEach { it.beforeAll() }

Expand Down

0 comments on commit 46e7431

Please sign in to comment.